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

提示

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

使用方式

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

$ gf gen dao -h
USAGE
    gf gen dao [OPTION]
OPTION
    -p, --path                  directory path for generated files
    -l, --link                  database configuration, the same as the ORM configuration of GoFrame
    -t, --tables                generate models only for given tables, multiple table names separated with ','
    -x, --tablesEx              generate models excluding given tables, multiple table names separated with ','
    -g, --group                 specifying the configuration group name of database for generated ORM instance,
                                it's not necessary and the default value is "default"
    -f, --prefix                add prefix for all table of specified link/database tables
    -r, --removePrefix          remove specified prefix of the table, multiple prefix separated with ','
    -rf, --removeFieldPrefix    remove specified prefix of the field, multiple prefix separated with ','
    -j, --jsonCase              generated json tag case for model struct, cases are as follows:
                                | Case            | Example            |
                                |---------------- |--------------------|
                                | Camel           | AnyKindOfString    |
                                | CamelLower      | anyKindOfString    | default
                                | Snake           | any_kind_of_string |
                                | SnakeScreaming  | ANY_KIND_OF_STRING |
                                | SnakeFirstUpper | rgb_code_md5       |
                                | Kebab           | any-kind-of-string |
                                | KebabScreaming  | ANY-KIND-OF-STRING |
    -i, --importPrefix          custom import prefix for generated go files
    -d, --daoPath               directory path for storing generated dao files under path
    -o, --doPath                directory path for storing generated do files under path
    -e, --entityPath            directory path for storing generated entity files under path
    -t1, --tplDaoIndexPath      template file path for dao index file
    -t2, --tplDaoInternalPath   template file path for dao internal file
    -t3, --tplDaoDoPath         template file path for dao do file
    -t4, --tplDaoEntityPath     template file path for dao entity file
    -s, --stdTime               use time.Time from stdlib instead of gtime.Time for generated time/date fields of tables
    -w, --withTime              add created time for auto produced go files
    -n, --gJsonSupport          use gJsonSupport to use *gjson.Json instead of string for generated json fields of
                                tables
    -v, --overwriteDao          overwrite all dao files both inside/outside internal folder
    -c, --descriptionTag        add comment to description tag for each field
    -k, --noJsonTag             no json tag will be added for each field
    -m, --noModelComment        no model comment will be added for each field
    -a, --clear                 delete all generated go files that do not exist in database
    -y, --typeMapping           custom local type mapping for generated struct attributes relevant to fields of table
    -fm, --fieldMapping         custom local type mapping for generated struct attributes relevant to specific fields of
                                table
    -/--genItems                
    -h, --help                  more information about this command
EXAMPLE
    gf gen dao
    gf gen dao -l "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
    gf gen dao -p ./model -g user-center -t user,user_detail,user_login
    gf gen dao -r user_
CONFIGURATION SUPPORT
    Options are also supported by configuration file.
    It's suggested using configuration file instead of command line arguments making producing.
    The configuration node name is "gfcli.gen.dao", which also supports multiple databases, for example(config.yaml):
    gfcli:
      gen:
        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"
          typeMapping:
            decimal:
              type:   decimal.Decimal
              import: github.com/shopspring/decimal
            numeric:
              type: string
          fieldMapping:
            table_name.field_name:
              type:   decimal.Decimal
              import: github.com/shopspring/decimal

提示

如果使用框架推荐的项目工程脚手架，并且系统安装了 make 工具，也可以使用 make dao 快捷指令。

配置示例

文件配置示例：

hack/config.yaml

gfcli:
  gen:
    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"
    # sqlite需要自行编译带sqlite驱动的gf，下载库代码后修改路径文件（gf\cmd\gf\internal\cmd\cmd_gen_dao.go）的import包，取消注释即可。sqlite驱动依赖了gcc
    - link: "sqlite:./file.db"

参数说明

参数：typeMapping

参数typeMapping支持配置数据库字段类型对应的Go数据类型，默认值为：

decimal:
  type: float64
money:
  type: float64
numeric:
  type: float64
smallmoney:
  type: float64

该配置支持通过import配置项引入第三方包，例如：

decimal:
  type:   decimal.Decimal
  import: github.com/shopspring/decimal

参数：fieldMapping

参数fieldMapping提供细粒度的字段类型映射配置，支持配置指定数据库字段生成的Go数据类型。除了配置名称不一样外，配置内容与typeMapping一致。配置示例：

paid_orders.amount:
  type:   decimal.Decimal
  import: github.com/shopspring/decimal

示例中，paid_orders为表名称，amount为字段名称，type表示生成的Go代码中对应的数据类型名称，import表示生成的代码中需要引入第三方包。

使用示例

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

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

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

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

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

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

注意事项

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

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

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

由于大部分数据库类型都没有 bool 类型的数据表字段类型， 我们推荐使用bit(1)来表示字段的bool类型，而非tinyint(1)或者int(1)。因为tinyint(1)/int(1)字段类型表示的范围是-127~127，通常可能会被用作状态字段类型。而bit(1)的类型范围为0/1，可以很好的表示bool类型的两个值false/true。

例如，表字段：

生成的属性：