GoFrame 开发工具-数据规范

​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 ','
    -e, --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 ','
    -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
    -s, --stdTime           use time.Time from stdlib instead of gtime.Time for generated time/date fields of tables
    -n, --gJsonSupport      use gJsonSupport to use *gjson.Json instead of string for generated json fields of tables
    -o, --overwriteDao      overwrite all dao files both inside/outside internal folder
    -d, --descriptionTag    add comment to description tag for each field
    -k, --noJsonTag         commandGenDaoBriefNoJsonTag
    -m, --noModelComment    no model comment will be added for each field
    -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 -c config.yaml -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"

二、配置示例

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"

三、参数说明

四、使用示例

仓库地址：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​方法创建对象来链式操作数据表。

4、同时，​dao​采用了工程化规范设计。可以看到，​dao/do​是​service​层内部模块，也就是说，只有​service​层才能访问​dao​数据操作对象并与底层数据库交互。这样通过工具落地规范的方式避免了项目中随处调用​dao​操作数据库的情况，规范了请求调用链。