关于框架项目工程规范介绍请查看 代码分层设计 章节。
一、使用方式
大部分场景下,进入项目根目录执行 gf gen dao
即可。以下为命令行帮助信息。
二、配置示例
gfcli:
dao:
- link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
tables: "order,products"
jsonCase: "CamelLower"
- link: "mysql:root:12345678@tcp(127.0.0.1:3306)/primary"
path: "./my-app"
prefix: "primary_"
tables: "user, userDetail"
三、参数说明
四、使用示例
仓库地址:
路径 | 说明 | 详细介绍 |
---|---|---|
/internal/model/entity | 数据模型 | 数据模型由工具维护,用户不能修改。 工具每次生成代码文件将会覆盖该目录。 |
/internal/service/internal/do | 数据转换模型 | 数据转换模型用于业务模型到数据模型的转换,由工具维护,用户不能修改。 工具每次生成代码文件将会覆盖该目录。 |
/internal/service/internal/dao | 数据操作对象 | 通过对象方式访问底层数据源,底层基于ORM组件实现。往往需要结合entity 和do 通用使用。该目录下的文件开发者可扩展修改,但是往往没这种必要。 |
2、model
中的模型分为两类:数据模型和业务模型。
数据模型:通过CLI
工具自动生成 model/entity
目录文件,数据库的数据表都会生成到该目录下,这个目录下的文件对应的模型为数据模型。数据模型即与数据表一一对应的数据结构,开发者往往不需要去修改并且也不应该去修改,数据模型只有在数据表结构变更时通过CLI
工具自动更新。数据模型由CLI
工具生成及统一维护。
业务模型:业务模型即是与业务相关的数据结构,按需定义,例如service
的输入输出数据结构定义、内部的一些数据结构定义等。业务模型由开发者根据业务需要自行定义维护,定义到model
目录下。
3、dao
中的文件按照数据表名称进行命名,一个数据表一个文件及其一个对应的DAO
对象。操作数据表即是通过DAO
对象以及相关操作方法实现。dao
操作采用规范化设计,必须传递ctx
参数,并在生成的代码中必须通过Ctx
或者Transaction
方法创建对象来链式操作数据表。