gorm gen 是 GORM 的一个代码生成工具,可以根据数据库的表结构自动生成 Go 语言的模型代码。使用 gorm gen 可以大大减少手写模型代码的工作量。
下面是使用 gorm gen 的步骤:
- 安装 gorm gen
go install github.com/go-gorm/gorm/cmd/gormgen@latest
- 创建一个数据库,并创建一些表
在这里假设我们已经有了一个名为 test
的数据库,并创建了以下两个表:
CREATE TABLE users (
id INT(11) NOT NULL AUTO_INCREMENT,
name VARCHAR(100) NOT NULL,
email VARCHAR(100) NOT NULL,
PRIMARY KEY (id)
);
CREATE TABLE orders (
id INT(11) NOT NULL AUTO_INCREMENT,
user_id INT(11) NOT NULL,
amount DECIMAL(10,2) NOT NULL,
created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TIMESTAMP NOT NULL DEFAULT '0000-00-00 00:00:00' ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (id),
FOREIGN KEY (user_id) REFERENCES users(id)
);
- 使用 gorm gen 自动生成模型代码
gormgen --dsn "root:password@tcp(localhost:3306)/test?charset=utf8mb4&parseTime=True" --dir models --pkg models --table users,orders
上述命令将会把生成的代码放到 models
目录下,并且使用 models
作为包名。同时,它只会针对 users
和 orders
两个表生成代码。
生成的代码如下:
package models
import (
"time"
"gorm.io/gorm"
)
type User struct {
ID int `gorm:"column:id;primaryKey"`
Name string `gorm:"column:name"`
Email string `gorm:"column:email"`
}
type Order struct {
ID int `gorm:"column:id;primaryKey"`
UserID int `gorm:"column:user_id"`
Amount float64 `gorm:"column:amount"`
CreatedAt time.Time `gorm:"column:created_at"`
UpdatedAt time.Time `gorm:"column:updated_at"`
User *User `gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE;foreignKey:UserID"`
}
- 在代码中使用自动生成的模型
现在我们可以在 Go 代码中使用 User
和 Order
结构体了,例如:
package main
import (
"fmt"
"log"
"gorm.io/driver/mysql"
"gorm.io/gorm"
"github.com/yourname/project/models"
)
func main() {
dsn := "root:password@tcp(localhost:3306)/test?charset=utf8mb4&parseTime=True"
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
if err != nil {
log.Fatalf("failed to connect database: %v", err)
}
var user models.User
result := db.First(&user)
if result.Error != nil {
log.Fatalf("failed to fetch user: %v", result.Error)
}
fmt.Printf("User ID: %d, Name: %s, Email: %s\n", user.ID, user.Name, user.Email)
}
注意:上述代码演示了如何从数据库中获取一个用户,并输出其 ID、Name 和 Email;但是由于 orders 表中也包含了 user_id 字段,因此我们可以通过 User 结构体的 UserID 来获取该用户的所有订单,具体方法可以参考 GORM 的文档。