GORM-GEN快速上手

╰半夏微凉° 2024-03-26 14:12 51阅读 0赞

**目录**

1.什么是 GEN

2.GEN特性

3.快速使用GEN

3.1. 下载

3.2. 生成

4. 基础查询

5. 自定义 SQL 查询

6.demo源码

--------------------

### 1.什么是 GEN ###

**官方文档：**[Gen Guides | GORM - The fantastic ORM library for Golang, aims to be developer friendly.][Gen Guides _ GORM - The fantastic ORM library for Golang_ aims to be developer friendly.]

**GEN 项目地址**：https://github.com/go-gorm/gen

GEN 是一个基于 GORM 的安全 ORM 框架，其主要通过代码生成方式实现 GORM 代码封装。旨在安全上避免业务代码出现 SQL 注入，同时给研发带来最佳用户体验。由字节跳动无恒实验室与 GORM 作者（https://github.com/jinzhu)联合研发的开源。

### 2.GEN特性 ###

GEN 来告诉你，什么叫最佳用户体验：

*  自动同步库表，省去繁琐复制
 *  代码一键生成，专注业务逻辑
 *  字段类型安全，执行 SQL 也安
 *  查询优雅返回，完美兼容 GORM

GEN 提供了自动同步数据表结构体到 GORM 模型，使用非常简单，即使数据库字段信息改变，可以一键同步，数据库查询相关代码可以一键生成，CRUD 只需要调用对应的方法，开发体验飞起。GEN 采用了类型安全限制，所有参数都做了安全限制，完全不用担心存在注入；最重要的是自定义 SQL 只需要通过模板注释到 interface 的方法上，自动帮助你生成安全的代码，是的，**自定义 SQL 也不会出现 SQL 注入问题**，而且工具完美兼容 GORM！

下面是 GORM 与 GEN 工具的对比

![7567a405411c4c68ad2e7473d0be702a.png][]

GORM 和 GEN 查询对比案例

> //GORM 需要先定义类型  
> var user model.User  
> err:=db.Where("id=?",5).Take(&user).Error  
>   
> //GEN 可以直接查询，返回对应类型  
> user,err:= u.Where(u.ID.Eq(5)).Take()

### 3.快速使用GEN ###

#### 3.1. 下载 ####

> go get gorm.io/gen

#### 3.2. 生成 ####

执行以下方法后即可在指定目录生成对应代码：

package main
    
    import (
    	"fmt"
    	"strings"
    
    	"gorm.io/driver/mysql"
    	"gorm.io/gen"
    	"gorm.io/gen/field"
    	"gorm.io/gorm"
    )
    
    const MySQLDSN = "root:root@(localhost:3306)/test?charset=utf8mb4&parseTime=True&loc=Local"
    
    func main() {
    
    	// 连接数据库
    	db, err := gorm.Open(mysql.Open(MySQLDSN))
    	if err != nil {
    		panic(fmt.Errorf("cannot establish db connection: %w", err))
    	}
    
    	// 生成实例
    	g := gen.NewGenerator(gen.Config{
    		// 相对执行`go run`时的路径, 会自动创建目录
    		OutPath: "./dal",
    
    		// WithDefaultQuery 生成默认查询结构体(作为全局变量使用), 即`Q`结构体和其字段(各表模型)
    		// WithoutContext 生成没有context调用限制的代码供查询
    		// WithQueryInterface 生成interface形式的查询代码(可导出), 如`Where()`方法返回的就是一个可导出的接口类型
    		Mode: gen.WithDefaultQuery | gen.WithQueryInterface | gen.WithoutContext,
    
    		// 表字段可为 null 值时, 对应结体字段使用指针类型
    		FieldNullable: true, // generate pointer when field is nullable
    
    		// 表字段默认值与模型结构体字段零值不一致的字段, 在插入数据时需要赋值该字段值为零值的, 结构体字段须是指针类型才能成功, 即`FieldCoverable:true`配置下生成的结构体字段.
    		// 因为在插入时遇到字段为零值的会被GORM赋予默认值. 如字段`age`表默认值为10, 即使你显式设置为0最后也会被GORM设为10提交.
    		// 如果该字段没有上面提到的插入时赋零值的特殊需要, 则字段为非指针类型使用起来会比较方便.
    		FieldCoverable: false, // generate pointer when field has default value, to fix problem zero value cannot be assign: https://gorm.io/docs/create.html#Default-Values
    
    		// 模型结构体字段的数字类型的符号表示是否与表字段的一致, `false`指示都用有符号类型
    		FieldSignable: false, // detect integer field's unsigned type, adjust generated data type
    		// 生成 gorm 标签的字段索引属性
    		FieldWithIndexTag: false, // generate with gorm index tag
    		// 生成 gorm 标签的字段类型属性
    		FieldWithTypeTag: true, // generate with gorm column type tag
    	})
    	// 设置目标 db
    	g.UseDB(db)
    
    	// 自定义字段的数据类型
    	// 统一数字类型为int64,兼容protobuf
    	dataMap := map[string]func(detailType string) (dataType string){
    		"tinyint":   func(detailType string) (dataType string) { return "int64" },
    		"smallint":  func(detailType string) (dataType string) { return "int64" },
    		"mediumint": func(detailType string) (dataType string) { return "int64" },
    		"bigint":    func(detailType string) (dataType string) { return "int64" },
    		"int":       func(detailType string) (dataType string) { return "int64" },
    	}
    	// 要先于`ApplyBasic`执行
    	g.WithDataTypeMap(dataMap)
    
    	// 自定义模型结体字段的标签
    	// 将特定字段名的 json 标签加上`string`属性,即 MarshalJSON 时该字段由数字类型转成字符串类型
    	jsonField := gen.FieldJSONTagWithNS(func(columnName string) (tagContent string) {
    		toStringField := `balance, `
    		if strings.Contains(toStringField, columnName) {
    			return columnName + ",string"
    		}
    		return columnName
    	})
    	// 将非默认字段名的字段定义为自动时间戳和软删除字段;
    	// 自动时间戳默认字段名为:`updated_at`、`created_at, 表字段数据类型为: INT 或 DATETIME
    	// 软删除默认字段名为:`deleted_at`, 表字段数据类型为: DATETIME
    	autoUpdateTimeField := gen.FieldGORMTag("update_time", "column:update_time;type:int unsigned;autoUpdateTime")
    	autoCreateTimeField := gen.FieldGORMTag("create_time", "column:create_time;type:int unsigned;autoCreateTime")
    	softDeleteField := gen.FieldType("delete_time", "gorm.DeletedAt")
    	// 模型自定义选项组
    	fieldOpts := []gen.ModelOpt{jsonField, autoCreateTimeField, autoUpdateTimeField, softDeleteField}
    
    	// 创建模型的结构体,生成文件在 model 目录; 先创建的结果会被后面创建的覆盖
    	// 这里创建个别模型仅仅是为了拿到`*generate.QueryStructMeta`类型对象用于后面的模型关联操作中
    	Address := g.GenerateModel("address")
    	// 创建全部模型文件, 并覆盖前面创建的同名模型
    	allModel := g.GenerateAllTable(fieldOpts...)
    
    	// 创建有关联关系的模型文件
    	User := g.GenerateModel("user",
    		append(
    			fieldOpts,
    			// user 一对多 address 关联, 外键`uid`在 address 表中
    			gen.FieldRelate(field.HasMany, "Address", Address, &field.RelateConfig{GORMTag: "foreignKey:UID"}),
    		)...,
    	)
    	Address = g.GenerateModel("address",
    		append(
    			fieldOpts,
    			gen.FieldRelate(field.BelongsTo, "User", User, &field.RelateConfig{GORMTag: "foreignKey:UID"}),
    		)...,
    	)
    
    	// 创建模型的方法,生成文件在 query 目录; 先创建结果不会被后创建的覆盖
    	g.ApplyBasic(User, Address)
    	g.ApplyBasic(allModel...)
    
    	g.Execute()
    }

![f6498e04344b4b76ac6c6a2527bd4bb0.png][]

更详细的配置示例可以参照：最佳实践 DEMO:https://github.com/idersec/gendemo

### 4. 基础查询 ###

执行生成代码后，GEN 会帮助生成基础的查询方法，并且绑定到结构体上，可以直接调用函数查询获取查询结果，不需要提前定义变量，参数和结构体字段类型绑定，防止研发过程中误用。

package main
    
    import (
    	"fmt"
    	"gorm-gen-demo/dal"
    
    	"gorm.io/driver/mysql"
    	"gorm.io/gorm"
    )
    
    const MySQLDSN = "root:root@(localhost:3306)/test?charset=utf8mb4&parseTime=True&loc=Local"
    
    func main() {
    	// 连接数据库
    	db, err := gorm.Open(mysql.Open(MySQLDSN))
    	if err != nil {
    		panic(fmt.Errorf("cannot establish db connection: %w", err))
    	}
    	dal.SetDefault(db)
        //查询User年龄为18的
    	userDo := dal.User.Where(dal.User.Age.Eq(18))
    	fmt.Print(userDo)
    }

GEN 满足了基本上所有的日常使用的查询方法，包括事务、关联关系等高级用法，更多案例请参考：https://github.com/go-gorm/gen\#readme

### 5. 自定义 SQL 查询 ###

自定 SQL 的安全性是所有 ORM 最难解决的问题，GEN 使用模板注释的方法完美解决了这个问题，只需要将 SQL 注释到 interface 的方法上。SQL 支持简单的 where 查询和完整 SQL 查询，条件用`Where()`语法包住。Raw SQL 用`sql()`包住，也可省略直接写。

**5.1占位符**

*  **`gen.T`**  
    用于返回数据的结构体，会根据生成结构体或者数据库表结构自动生成
 *  **`gen.M`**  
    表示`map[string]interface{}`用于返回数据
 *  **`gen.RowsAffected`**  
    用于执行 SQL 进行更新或删除时候,用于返回影响行数
 *  **`@@table`**  
    查询的表名，如果没有传参，会根据结构体或者表名自动生成
 *  **`@@<name>`**  
    当表名或者字段名可控时候，用@@占位，name 为可变参数名，需要函数传入。
 *  **`@<name>`**  
    当数据可控时候，用@占位，name 为可变参数名，需要函数传入

**5.2子句**

目前支持 if 、where 、set 子句，子句需要用\{ \{\}\}括起来，并且需要用`{ {end}}`  
结束子句。where 和 set 子句会帮助做连接词补全和开头连接词删除。各个子句支持嵌套使用。

示例：

type Method interface {
        // Where("name=@name and age=@age")
        SimpleFindByNameAndAge(name string, age int) (gen.T, error)
    
        // select * from users where id=@id
        FindUserToMap(id int) (gen.M, error)
    
        // sql(insert into @@table (name,age) values (@name,@age) )
        InsertValue(age int, name string) error
    
        // select name from @@table where id=@id
        FindNameById(id int) string
    
        // select * from @@table
        //  {
       {where}}
        //      id>0
        //      {
       {if cond}}id=@id {
       {end}}
        //      {
       {if key!="" && value != ""}} or @@key=@value{
       {end}}
        //  {
       {end}}
        FindByIDOrCustom(cond bool, id int, key, value string) ([]gen.T, error)
    
        // update @@table
        //  {
       {set}}
        //      update_time=now()
        //      {
       {if name != ""}}
        //          name=@name
        //      {
       {end}}
        //  {
       {end}}
        //  {
       {where}}
        //      id=@id
        //  {
       {end}}
        UpdateName(name string, id int) (gen.RowsAffected,error)
    }

GEN 会自动生成安全的实现代码，并且和结构体绑定。使用时候直接调用对应的函数即可。

user,err := u.SimpleFindByNameAndAge("zhangqiang",18)
    
    resultMap,err:= u.FindUserToMap(2)
    
    name := u.FindNameById(5)
    
    users,err := u.FindByIDOrCustom(true, 10, "name", "modi")
    
    rows,err := UpdateName("jinzhu", 12)

### 6.demo源码 ###

项目地址：[gorm-gen-demo: gorm-gen-demo小示例][gorm-gen-demo_ gorm-gen-demo]

[Gen Guides _ GORM - The fantastic ORM library for Golang_ aims to be developer friendly.]: https://gorm.io/zh_CN/gen/
[7567a405411c4c68ad2e7473d0be702a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/7962f78c159b4f80995d50c73499ab71.png
[f6498e04344b4b76ac6c6a2527bd4bb0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/1e3df869e49b4e108a2ee89a18ce8aa0.png
[gorm-gen-demo_ gorm-gen-demo]: https://gitee.com/here-comes-brother-fei/gorm-gen-demo.git