goframe框架CLI dao命令

goframe2.0+文档
安装gf
wget -O gf https://github.com/gogf/gf/releases/latest/download/gf_KaTeX parse error: Expected group after '_' at position 14: (go env GOOS)_̲(go env GOARCH) && chmod +x gf && ./gf install -y && rm ./gf
初始化goframe项目

gf  init firstproject（项目名称） 

数据库

mysql_secure_installation -utest   ##初次设置mysql密码
创建mysql用户（% 可远程登录）
CREATE USER 'test'@'%' IDENTIFIED BY 'test';
给用户加权限
grant all privileges on *.* to test@'%' identified by 'test';
flush privileges;
修改密码
SET PASSWORD FOR 'test'@'localhost' = PASSWORD('test');
创建数据库
create database `goframe` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
创建表
CREATE TABLE User(
id BIGINT PRIMARY KEY AUTO_INCREMENT COMMENT 'UID',
name VARCHAR(25) UNIQUE COMMENT '账号',
password VARCHAR(32) COMMENT 'MD5密码',
nickename VARCHAR(25) COMMENT '昵称',
status INT COMMENT '状态0:启用 1:禁用'
);

goframe

创建gf cli配置文件

# GoFrame CLI tool configuration.
gfcli:
  gen:
    dao:
    - link:            "mysql:test:test@tcp(127.0.0.1:3306)/goframe" # 数据库驱动 :链接地址(用户：密码@)/数据库
      tables:          "user" # 表名
      removePrefix:    "gf_"
      descriptionTag:  true
      noModelComment:  true




运行 gf gen dao
appledeMac-mini:firstproject apple$ gf gen dao
generated: internal/service/internal/dao/user.go
generated: internal/service/internal/dao/internal/user.go
generated: internal/service/internal/do/user.go
generated: internal/model/entity/user.go
done!

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

/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方法创建对象来链式操作数据表。



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