GORM使用笔记 | 青训营

30 阅读4分钟

在现代软件开发中,数据库操作是不可避免的一部分。为了简化数据库操作,许多编程语言和框架都提供了 ORM(对象关系映射)工具。而在 Go 语言领域,GORM 是一个备受欢迎的 ORM 库,它可以极大地简化数据库的增删改查操作。本文将深入探讨使用 GORM 进行 CRUD(增删改查)操作的方法和示例。

1. 引入 GORM

首先,确保你已经将 GORM 库导入到你的项目中。你可以使用以下命令获取 GORM:

go get -u gorm.io/gorm

然后,在你的代码中导入 GORM:

import (
    "gorm.io/gorm"
    "gorm.io/driver/sqlite"  // 替换为你所使用的数据库驱动
)

2. 连接数据库

在开始操作之前,需要建立数据库连接。以下是一个连接Mysql 数据库的示例代码:

dsn := "username:psw@tcp(127.0.0.1:3306)/gotik?charset=utf8mb4&parseTime=True&loc=Local"
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{TranslateError: true})
if err != nil {
        panic(err)
    }

3. 创建数据模型

在 GORM 中,数据模型是对数据库表结构的映射。你需要定义一个结构体来表示数据表,并使用 GORM 的标签来指定字段和约束。

type User struct {
    ID   uint   `gorm:"primaryKey"`
    Name string `gorm:"not null"`
    Age  int
}

4. 执行 CRUD 操作

4.1 创建(Create)

func CreateUser(db *gorm.DB, user User) error {
    result := db.Create(&user)
    return result.Error
}

4.2 读取(Read)

func GetUserByID(db *gorm.DB, id uint) (User, error) {
    var user User
    result := db.First(&user, id)
    return user, result.Error
}

4.3 更新(Update)

func UpdateUserName(db *gorm.DB, id uint, newName string) error {
    result := db.Model(&User{}).Where("id = ?", id).Update("name", newName)
    return result.Error
}

4.4 删除(Delete)

func DeleteUser(db *gorm.DB, id uint) error {
    result := db.Delete(&User{}, id)
    return result.Error
}

5. 示例

现在让我们看一个完整的示例,展示如何使用 GORM 执行完整的 CRUD 操作:

func main() {
    db, err := ConnectDB()
    if err != nil {
        panic("Failed to connect to database")
    }
    defer db.Close()
​
    newUser := User{Name: "Alice", Age: 28}
​
    // Create
    err = CreateUser(db, newUser)
    if err != nil {
        panic("Failed to create user")
    }
​
    // Read
    retrievedUser, err := GetUserByID(db, newUser.ID)
    if err != nil {
        panic("Failed to retrieve user")
    }
    fmt.Println("Retrieved User:", retrievedUser)
​
    // Update
    err = UpdateUserName(db, newUser.ID, "Alicia")
    if err != nil {
        panic("Failed to update user")
    }
​
    // Delete
    err = DeleteUser(db, newUser.ID)
    if err != nil {
        panic("Failed to delete user")
    }
}

通过上述示例,我们可以看到 GORM 提供了简洁的方法来执行数据库的增删改查操作。这使得我们能够更专注于业务逻辑,而无需过多关注底层数据库细节。

6. 项目实践中的DB的使用

6.1 init函数的作用

在 Go 语言中,init 函数是一种特殊的函数,用于在程序运行时进行初始化操作。每个源文件都可以包含一个或多个 init 函数,这些函数会在程序开始执行之前按照它们在源文件中的顺序被自动调用。init 函数没有参数和返回值。

init 函数的主要作用有两个:

  1. 初始化包(Package Initialization): init 函数通常用于执行包级别的初始化操作。当一个包被导入时,其中的 init 函数会被自动调用。这使得你可以在程序启动之前执行一些必要的设置,比如初始化变量、注册驱动、建立数据库连接、设置环境变量等。需要注意的是,init 函数不能被显式调用,而是由 Go 运行时自动调用。

  2. 初始化顺序: 如果一个包导入了多个其他包,那么这些包中的 init 函数会按照它们被导入的顺序执行。这有助于确保依赖关系正确地被初始化。同时,在同一个包内,不同源文件中的 init 函数也会按照它们在文件中的顺序执行。

以下是一个示例,演示了 init 函数的使用:

package main

import (
    "fmt"
)

func init() {
    fmt.Println("Initializing package...")
}

func main() {
    fmt.Println("Main function")
}

在上述示例中,init 函数会在 main 函数之前被调用,因此输出会首先显示 "Initializing package...",然后才是 "Main function"。

总之,init 函数在 Go 中用于执行包级别的初始化操作,它们会在程序启动前被自动调用,而且执行顺序与导入的顺序有关。

6.2 DB的初始化

我们可以使用 init函数,在导入包的过程中进行数据库的连接并建立数据表

以下是一个示例

package api  
  
import (  
"project/model"  
"gorm.io/driver/mysql"  
"gorm.io/gorm"  
)  
  
var DB *gorm.DB  
  
func init() {  
    dsn := "username:pwd@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"  
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{TranslateError: true})  
    if err != nil {  
    panic(err)  
    }  
      
    DB = db  
      
    // 建立表  
    err = DB.AutoMigrate(&model.Comment{})  
    if err != nil {  
    panic(err)  
    }  
    err = DB.AutoMigrate(&model.Message{})  
    if err != nil {  
    panic(err)  
    }  
    err = DB.AutoMigrate(&model.User{})  
    if err != nil {  
    panic(err)  
    }  
    err = DB.AutoMigrate(&model.UserFavorite{})  
    if err != nil {  
    panic(err)  
    }  
    err = DB.AutoMigrate(&model.UserFollow{})  
    if err != nil {  
    panic(err)  
    }  
    err = DB.AutoMigrate(&model.UserFriends{})  
    if err != nil {  
    panic(err)  
    }  
    err = DB.AutoMigrate(&model.UserVideo{})  
    if err != nil {  
    panic(err)  
    }  
    err = DB.AutoMigrate(&model.Video{})  
    if err != nil {  
    panic(err)  
    }  
}

以上定义了一个全局的DB变量,之后要进行数据库操作时,只需要调用api.DB,即可使用。

总结而言,GORM 是一个功能强大且易于使用的 Go ORM 库,它可以显著简化数据库操作,让开发人员能够更高效地进行增删改查操作,从而加速应用程序的开发过程。无论是小型项目还是大型应用,GORM 都是一个值得考虑的选择。