go-zero 为什么要在 model 目录下放一个 vars.go

它是 model 包的「公共错误契约文件」

全文件就干一件事：定义一个包级变量 ErrNotFound，供该目录下所有 model（含子包）共用。

先看它到底长什么样

以你项目里的 internal/model/vars.go 为例，完整内容就是这 3 行有效代码。

package model

import "github.com/zeromicro/go-zero/core/stores/sqlx"

var ErrNotFound = sqlx.ErrNotFound

它是 goctl 生成的，不是手写的

来自 go-zero 源码里的模板 tools/goctl/model/sql/template/tpl/err.tpl。

goctl 一次会生成哪些文件

没有它，"查不到"和"数据库炸了"就分不清

看一段你项目里真实生成的 tasks_gen.go 代码。

// internal/model/zuowenpigai/tasks_gen.go（goctl 生成，DO NOT EDIT）
import (
    "context"
    "mvp-service/internal/model"   // ← 注意：import 了父包
    "github.com/zeromicro/go-zero/core/stores/sqlc"
    "github.com/zeromicro/go-zero/core/stores/sqlx"
)

func (m *defaultTasksModel) FindOne(ctx context.Context, id int64) (*Tasks, error) {
    query := fmt.Sprintf("select %s from %s where `id` = ? limit 1", tasksRows, m.table)
    var resp Tasks
    err := m.conn.QueryRowCtx(ctx, &resp, query, id)
    switch err {
    case nil:
        return &resp, nil
    case sqlc.ErrNotFound:
        return nil, model.ErrNotFound   // ← 统一返回父包定义的错误
    default:
        return nil, err   // 连接超时、语法错误等真错误
    }
}

如果不做这个区分会怎样

// ❌ 不区分：把"查不到"当成系统错误
task, err := l.svcCtx.TasksModel.FindOne(l.ctx, req.Id)
if err != nil {
    return nil, err   // 用户查了不存在的 id → 直接 500，还触发告警
}

// ✅ 区分后：语义正确
task, err := l.svcCtx.TasksModel.FindOne(l.ctx, req.Id)
switch {
case err == nil:
    // 正常流程
case errors.Is(err, model.ErrNotFound):
    return nil, errorx.New(CodeTaskNotFound, "任务不存在")   // 友好提示
default:
    return nil, err   // 才需要告警
}

为什么非要单独一个文件，不能写在 model 里

答案很硬：Go 的包级作用域不允许重复声明。

你的 zuowenpigai 子包里有 7 张表、7 个 model 文件，每一个的 FindOne 都要返回 ErrNotFound。

那塞进某一个 model 文件（比如 tasks.go）行不行？

为什么必须放在 internal/model/ 这个位置

这才是真正的硬约束：goctl 生成的代码把这个路径写死了。

你的 7 个 model 文件里，每一个都有一模一样的这一行：

// internal/model/zuowenpigai/tasks_gen.go
import (
    "mvp-service/internal/model"   // ← 硬编码：指向 internal/model 这个包
)

// 以及 FindOne / FindOneByXxx 里的这一句：
case sqlc.ErrNotFound:
    return nil, model.ErrNotFound   // ← 用的是 model 包（父包）的 ErrNotFound

为什么是 model 目录，而不是 internal 根下

king-club-mvp-service 里的实际情况

顺便说一个你这个项目里值得注意的细节。

既然值都一样，为什么还要包这一层

先说一个反直觉的事实：model.ErrNotFound、sqlx.ErrNotFound、sqlc.ErrNotFound 是同一个东西。

// go-zero 源码 core/stores/sqlc/cachedsql.go
const (
    // ErrNotFound is an alias of sqlx.ErrNotFound.
    ErrNotFound = sqlx.ErrNotFound
)

// 所以链条是：
//   sqlx.ErrNotFound  ──别名──>  sqlc.ErrNotFound  ──赋值──>  model.ErrNotFound
//   三者 == 比较为 true，errors.Is 也为 true

既然如此，直接在代码里用 sqlx.ErrNotFound 不就行了？为什么要绕一圈？

// ❌ 不推荐：logic 直接依赖底层库
import "github.com/zeromicro/go-zero/core/stores/sqlx"
if err == sqlx.ErrNotFound { ... }   // 业务代码和框架绑死

// ✅ 推荐：只依赖自己的 model 包
import "mvp-service/internal/model"
if errors.Is(err, model.ErrNotFound) { ... }   // 换框架也不用动

正确的使用姿势

在 logic 里判断查不到

import (
    "errors"
    "mvp-service/internal/model"
)

func (l *GetTaskLogic) GetTask(req *types.GetTaskReq) (*types.GetTaskResp, error) {
    task, err := l.svcCtx.TasksModel.FindOne(l.ctx, req.Id)
    switch {
    case err == nil:
        // 命中，走正常流程
        return &types.GetTaskResp{Task: convert(task)}, nil

    case errors.Is(err, model.ErrNotFound):
        // 没查到：这是业务的正常分支，不是故障
        return nil, errorx.New(code.TaskNotFound, "任务不存在")

    default:
        // 真错误：记录日志 + 返回 500
        l.Errorf("查询任务失败 id=%d err=%v", req.Id, err)
        return nil, errorx.New(code.InternalError, "服务异常")
    }
}

常见错误用法

model 目录下几个文件各自是干嘛的

关于 vars.go 的几条实践建议