Files
gin-vue-admin/aiDoc/examples/backend/model-example.md
T
15e6e7685c update:发布2.9.2版本 (#2211)
* feat: 调整AI工作模式,更符合harness基准

* feat: 添加BusinessDB字段到PluginInitializeGorm结构体,并增加相关测试用例

* [middleware/jwt.go]: fix #2192 issues bug

* docs: add auto plugin design spec

* chore: ignore worktrees directory

* feat: 调整代码辅助能力至插件

* feat: 添加警告条组件,提示授权用户访问限制

* fix: 修正商业用途版权声明链接

* feat: 调整agent.md 更加节省token

* fix: 修改casbin版本为v3

* feat: 更新JSONMap和JSONSlice类型,优化GORM数据类型处理

* feat: 添加数据库就绪通知机制,优化插件注册流程

* feat: 重构API路径和描述,优化代码生成器和模板配置分组

* feat: 优化 person 页面的 css 作用域限制

* feat: 更新 vite 至 vite8

* 新增:MCP工具为指定URL的角色ID授权

* fix: 增加文件名合法性检查,拒绝包含非法字符的文件写入

* chore: 更新CI配置,升级Node.js和Go版本,调整checkout和setup动作版本

* feat: 为数据库连接增加最大复用时间配置

* feat: 为各数据库连接配置增加最大连接生命周期设置

* feat: 更新插件注册逻辑并优化API和菜单组件的标签显示

* feat: 更新版本号至v2.9.2并添加新插件路径信息

---------

Co-authored-by: taincheng <zhangtc@gmail.com>
Co-authored-by: Azir-11 <2075125282@qq.com>
Co-authored-by: lanxi <1220lanxi@gmail.com>
2026-05-11 13:48:18 +08:00

1.2 KiB

Model 示例

这个文件负责什么

Model 负责定义数据库实体与持久化字段,是 Service 和数据库交互的基础。

什么时候应该这样写

  • 新增一张业务表
  • 为现有表补字段
  • 需要定义 GORM 结构与关联关系

推荐写法示例

package system

import "github.com/flipped-aurora/gin-vue-admin/server/global"

type Order struct {
	global.GVA_MODEL
	Name     string `json:"name" gorm:"comment:订单名称"`
	Status   int    `json:"status" gorm:"default:1;comment:订单状态"`
	Remark   string `json:"remark" gorm:"comment:备注"`
	CreatorID uint  `json:"creatorId" gorm:"comment:创建人ID"`
}

为什么这样写

  • 继承 global.GVA_MODEL,保持主键和时间字段风格一致
  • json 标签用于接口输出
  • gorm 标签用于约束字段类型、默认值和注释
  • 字段命名尽量清晰、稳定,便于前后端保持一致

常见错误

  • 缺少 json 或 gorm 标签
  • 把仅用于请求或展示的字段直接写入数据库 model
  • 同一个字段在前后端使用不同类型
  • 忽略 Status、ID、时间字段这类高风险类型一致性问题

真实参考文件

  • server/model/system/sys_api_token.go
  • server/model/system/sys_user.go