gen dao命令是CLI中最频繁使用、也是框架设计的工程规范能否准确落地的关键命令。该命令用于生成dao数据访问对象、do数据转化模型及entity实例数据模型Go代码文件。由于该命令的参数、选项较多，我们推荐使用配置文件来管理生成规则。

关于框架项目工程规范介绍请查看 代码分层设计 章节。

使用方式

大部分场景下，进入项目根目录执行 gf gen dao 即可。以下为命令行帮助信息。

  1. $ gf gen dao -h
  2. USAGE
  3.     gf gen dao [OPTION]
  5. OPTION
  6.     -p, --path                  directory path for generated files
  7.     -l, --link                  database configuration, the same as the ORM configuration of GoFrame
  8.     -t, --tables                generate models only for given tables, multiple table names separated with ','
  9.     -x, --tablesEx              generate models excluding given tables, multiple table names separated with ','
  10.     -g, --group                 specifying the configuration group name of database for generated ORM instance,
  11.                                 it's not necessary and the default value is "default"
  12.     -f, --prefix                add prefix for all table of specified link/database tables
  13.     -r, --removePrefix          remove specified prefix of the table, multiple prefix separated with ','
  14.     -j, --jsonCase              generated json tag case for model struct, cases are as follows:
  15.                                 | Case            | Example            |
  16.                                 |---------------- |--------------------|
  17.                                 | Camel           | AnyKindOfString    |
  18.                                 | CamelLower      | anyKindOfString    | default
  19.                                 | Snake           | any_kind_of_string |
  20.                                 | SnakeScreaming  | ANY_KIND_OF_STRING |
  21.                                 | SnakeFirstUpper | rgb_code_md5       |
  22.                                 | Kebab           | any-kind-of-string |
  23.                                 | KebabScreaming  | ANY-KIND-OF-STRING |
  24.     -i, --importPrefix          custom import prefix for generated go files
  25.     -d, --daoPath               directory path for storing generated dao files under path
  26.     -o, --doPath                directory path for storing generated do files under path
  27.     -e, --entityPath            directory path for storing generated entity files under path
  28.     -t1, --tplDaoIndexPath      template file path for dao index file
  29.     -t2, --tplDaoInternalPath   template file path for dao internal file
  30.     -t3, --tplDaoDoPath         template file path for dao do file
  31.     -t4, --tplDaoEntityPath     template file path for dao entity file
  32.     -s, --stdTime               use time.Time from stdlib instead of gtime.Time for generated time/date fields of tables
  33.     -w, --withTime              add created time for auto produced go files
  34.     -n, --gJsonSupport          use gJsonSupport to use *gjson.Json instead of string for generated json fields of
  35.                                 tables
  36.     -v, --overwriteDao          overwrite all dao files both inside/outside internal folder
  37.     -c, --descriptionTag        add comment to description tag for each field
  38.     -k, --noJsonTag             no json tag will be added for each field
  39.     -m, --noModelComment        no model comment will be added for each field
  40.     -a, --clear                 delete all generated go files that do not exist in database
  41.     -h, --help                  more information about this command
  43. EXAMPLE
  44.     gf gen dao
  45.     gf gen dao -l "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  46.     gf gen dao -p ./model -g user-center -t user,user_detail,user_login
  47.     gf gen dao -r user_
  49. CONFIGURATION SUPPORT
  50.     Options are also supported by configuration file.
  51.     It's suggested using configuration file instead of command line arguments making producing.
  52.     The configuration node name is "gfcli.gen.dao", which also supports multiple databases, for example(config.yaml):
  53.     gfcli:
  54.       gen:
  55.         dao:
  56.         - link:     "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  57.           tables:   "order,products"
  58.           jsonCase: "CamelLower"
  59.         - link:   "mysql:root:12345678@tcp(127.0.0.1:3306)/primary"
  60.           path:   "./my-app"
  61.           prefix: "primary_"
  62.           tables: "user, userDetail"

配置示例

/hack/config.yaml

  1. gfcli:
  2.   gen:
  3.     dao:
  4.     - link:     "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  5.       tables:   "order,products"
  6.       jsonCase: "CamelLower"
  8.     - link:   "mysql:root:12345678@tcp(127.0.0.1:3306)/primary"
  9.       path:   "./my-app"
  10.       prefix: "primary_"
  11.       tables: "user, userDetail"
  13.     # sqlite需要自行编译带sqlite驱动的gf，下载库代码后修改路径文件（gf\cmd\gf\internal\cmd\cmd_gen_dao.go）的import包，取消注释即可。sqlite驱动依赖了gcc
  14.     - link: "sqlite:./file.db"

参数说明

名称必须默认值含义示例
gfcli.gen.dao是
dao代码生成配置项，可以有多个配置项构成数组，支持多个数据库生成。不同的数据库可以设置不同的生成规则，例如可以生成到不同的位置或者文件。-
link是
分为两部分，第一部分表示你连接的数据库类型mysql, postgresql等, 第二部分就是连接数据库的dsn信息。具体请参考 ORM使用配置 章节。

-

path
internal

生成dao和model文件的存储目录地址。

./app
group
default

在数据库配置中的数据库分组名称。只能配置一个名称。数据库在配置文件中的分组名称往往确定之后便不再修改。

default

order

user

prefix

生成数据库对象及文件的前缀，以便区分不同数据库或者不同数据库中的相同表名，防止数据表同名覆盖。

order

user

removePrefix

删除数据表的指定前缀名称。多个前缀以,号分隔。gf_
tables

指定当前数据库中需要执行代码生成的数据表。如果为空，表示数据库的所有表都会生成。user, user_detail
tablesEx

Tables Excluding，指定当前数据库中需要排除代码生成的数据表。product, order
jsonCase
CamelLower

指定model中生成的数据实体对象中json标签名称规则，参数不区分大小写。参数可选为：Camel、CamelLower、Snake、SnakeScreaming、SnakeFirstUpper、Kebab、KebabScreaming。具体介绍请参考命名行帮助示例。

Snake
stdTime
false

当数据表字段类型为时间类型时，代码生成的属性类型使用标准库的time.Time而不是框架的gtime.Time类型。

true
withTime
false为每个自动生成的代码文件增加生成时间注释
gJsonSupport
false

当数据表字段类型为JSON类型时，代码生成的属性类型使用gjson.Json类型。

true
overwriteDao
false每次生成dao代码时是否重新生成覆盖dao/internal目录外层的文件。注意dao/internal目录外层的文件可能由开发者自定义扩展了功能，覆盖可能会产生风险。true
importPrefix
通过go.mod自动检测

用于指定生成Go文件的import路径前缀。特别是针对于不是在项目根目录下使用gen dao命令，或者想要将代码文件生成到自定义的其他目录，这个时候配置该参数十分必要。


github.com/gogf/gf
descriptionTag
false

用于指定是否为数据模型结构体属性增加desription的标签，内容为对应的数据表字段注释。

true
noJsonTag
false生成的数据模型中，字段不带有json标签
noModelComment
false

用于指定是否关闭数据模型结构体属性的注释自动生成，内容为数据表对应字段的注释。

true
clear
false自动删除数据库中不存在对应数据表的本地dao/do/entity代码文件
daoPath
dao代码生成的DAO文件存放目录
doPath
model/do代码生成DO文件存放目录
entityPath
model/entity代码生成的Entity文件存放目录
tplDaoIndexPath

自定义DAO Index代码生成模板文件路径，使用该参数请参考源码
tplDaoInternalPath

自定义DAO Internal代码生成模板文件路径，使用该参数请参考源码
tplDaoDoPath

自定义DO代码生成模板文件路径，使用该参数请参考源码
tplDaoEntityPath

自定义Entity代码生成模板文件路径，使用该参数请参考源码

使用示例

仓库地址：https://github.com/gogf/focus-single

数据规范-gen dao - 图1

1、以下3个目录的文件由dao命令生成：

路径说明详细介绍
/internal/dao数据操作对象通过对象方式访问底层数据源，底层基于ORM组件实现。往往需要结合entity和do通用使用。该目录下的文件开发者可扩展修改，但是往往没这种必要。
/internal/model/do数据转换模型

数据转换模型用于业务模型到数据模型的转换，由工具维护，用户不能修改。

工具每次生成代码文件将会覆盖该目录。

/internal/model/entity数据模型

数据模型由工具维护，用户不能修改。工具每次生成代码文件将会覆盖该目录。

2、model中的模型分为两类：数据模型和业务模型。

数据模型：通过CLI工具自动生成 model/entity 目录文件，数据库的数据表都会生成到该目录下，这个目录下的文件对应的模型为数据模型。数据模型即与数据表一一对应的数据结构，开发者往往不需要去修改并且也不应该去修改，数据模型只有在数据表结构变更时通过CLI工具自动更新。数据模型由CLI工具生成及统一维护。

业务模型：业务模型即是与业务相关的数据结构，按需定义，例如service的输入输出数据结构定义、内部的一些数据结构定义等。业务模型由开发者根据业务需要自行定义维护，定义到model目录下。

3、dao中的文件按照数据表名称进行命名，一个数据表一个文件及其一个对应的DAO对象。操作数据表即是通过DAO对象以及相关操作方法实现。dao操作采用规范化设计，必须传递ctx参数，并在生成的代码中必须通过Ctx或者Transaction方法创建对象来链式操作数据表。

数据规范-gen dao - 图2

注意事项

需要手动编译的数据库类型

gen dao命令涉及到数据访问相关代码生成时，默认支持常用的若干类型数据库。如果需要Oracle数据库类型支持，需要开发者自己修改源码文件后自行本地手动编译生成CLI工具随后安装，因为这两个数据库的驱动需要CGO支持，无法预编译生成给大家直接使用。

数据规范-gen dao - 图3

关于bool类型对应的数据表字段

由于大部分数据库类型都没有bool类型的数据表字段类型，我们推荐使用bit(1)来代替bool类型。gen dao命令会自动识别bit(1)数据表字段并生成bool类型的属性。此外，我们不推荐使用tinyint(1)作为bool类型。

例如，表字段：

数据规范-gen dao - 图4

生成的属性：

数据规范-gen dao - 图5