go-zero 怎么建表、怎么创建 Model

表是「你先建」的，Model 是「goctl 生成的」

go-zero 不负责帮你建库建表——它只负责「读了表结构之后，自动生成一套数据访问代码（Model）」。所以流程是：你先准备表（手写 DDL 或连已有库）→ 跑 goctl model → 得到 model 包 → 注入 svc → 在 logic 里调。

go-zero 不建表，它「读表生成代码」

这一点最容易被误会成「goctl 会自动建表」。其实 goctl 只做代码生成，表本身得先存在（或先写好 DDL 文件）。

从「一张表」到「logic 里调一行代码」

四步主线：准备表 → 生成 Model → 注入 svc → 在 logic 使用。

先写 DDL，再 goctl model mysql ddl

适合：你手头有一份建表 SQL，或想「表结构即文档」，从 SQL 文件生成。

Step 1 · 写建表 SQL（user.sql）

CREATE TABLE user (
  id          BIGINT NOT NULL AUTO_INCREMENT,
  name        VARCHAR(64) NOT NULL DEFAULT '',
  age         INT    NOT NULL DEFAULT 0,
  create_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
  update_time DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (id),
  KEY idx_name (name)   -- 二级索引会被识别，生成 FindOneByName
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Step 2 · 真正把表建进库（你执行，不是 goctl）

mysql -uroot -p test < user.sql   # 用客户端 / 迁移工具执行

Step 3 · 生成 Model

goctl model mysql ddl \
  --src user.sql \      # 一个或多个 .sql 文件
  --dir ./model \       # 输出目录
  --cache \             # 开启 Redis 缓存（可选）
  --style gozero        # 代码风格（默认 gozero）

连上「已经建好的库」goctl model mysql datasource

适合：表已经在数据库里了（别人建的 / 老项目），直接反查结构生成代码，连 SQL 文件都不用写。

goctl model mysql datasource \
  --url "root:password@tcp(127.0.0.1:3306)/test" \
  --table user \          # 指定表，可多次 --table 或 --tables "a,b"
  --dir ./model \
  --cache                # 开启 Redis 缓存

model 目录里都有啥

执行完命令，./model 下会冒出这样一批文件。理解它们角色，才不会手改错文件。

types.go 长这样（列 → 字段映射）

type User struct {
    Id         int64     `db:"id"`
    Name       string    `db:"name"`
    Age        int64     `db:"age"`
    CreateTime time.Time `db:"create_time"`
    UpdateTime time.Time `db:"update_time"`
}

在 ServiceContext 里把 Model 建出来

和 DB 连接、Redis 一样，Model 也是「进程级共享依赖」，在 svc.NewServiceContext 里建一次、注入 svc。

① config.go 加两行

type Config struct {
    rest.RestConf
    Mysql     sqlx.MysqlConf   // 数据源
    CacheRedis redis.RedisConf // 开 --cache 才需要
}

② svc/servicecontext.go 建 Model

type ServiceContext struct {
    Config   config.Config
    UserModel model.UserModel // 注入 Model
}

func NewServiceContext(c config.Config) *ServiceContext {
    conn := sqlx.NewMysql(c.Mysql.DataSource) // 一个连接池
    return &ServiceContext{
        Config:    c,
        UserModel: model.NewUserModel(conn, c.CacheRedis), // 传连接 + 缓存
    }
}

logic 里直接调，像本地方法

Model 注入 svc 后，任意 logic 通过 l.svcCtx.UserModel 使用，自带 context 透传与（若开 cache）缓存。

// 查
user, err := l.svcCtx.UserModel.FindOne(l.ctx, userId)
if errors.Is(err, model.ErrNotFound) {
    return nil, err
}

// 按索引查（建表时写了 KEY idx_name 才有）
u, err := l.svcCtx.UserModel.FindOneByName(l.ctx, name)

// 增
_, err = l.svcCtx.UserModel.Insert(l.ctx, &model.User{Name: "张三", Age: 12})

// 改
user.Age = 13
l.svcCtx.UserModel.Update(l.ctx, user)

// 删
l.svcCtx.UserModel.Delete(l.ctx, user.Id)

自带 CRUD 不够？在接口里加方法

聚合查询、连表、复杂 WHERE —— goctl 生成不了，但你可以在 非 _gen 文件里扩展，重生成不会被覆盖。

// 1) 在 usermodel.go 的 UserModel 接口加签名
UserModel interface {
    model.UserModel      // 内嵌生成的基础接口
    FindAdults(ctx context.Context) ([]*User, error) // 自定义
}

// 2) 在同一文件的 customUserModel 上实现（手写，不会被覆盖）
func (m *customUserModel) FindAdults(ctx context.Context) ([]*User, error) {
    query := `SELECT `+userRows+` FROM `+m.table+` WHERE age >= ?`
    var resp []*User
    err := m.conn.QueryRowsCtx(ctx, &resp, query, 18)
    return resp, err
}

--cache 开了什么

加 --cache 后，goctl 把主键 / 唯一索引查询的 Redis 缓存逻辑直接写进 _gen.go：查先打缓存、命中即返；写操作自动删对应缓存。

六个最容易翻车的地方

其他框架怎么「建表 + 建 Model」

目标都是「表 ↔ 代码」对齐，机制差异很大。

记住这条主线就够