Gorm 逻辑删除字段类型修改

本文记录了在 grom 使用中自定义逻辑删除字段，和gorm.DB对象的set函数常见使用方法。

1.Gorm介绍

Gorm 是处理 Mysql 的一个工具。默认使用 struct Name 对应的 Names 作为表名，同时 struct 参数名，作为列名。

1.1可以通过修改 TableName() 更改 struct 默认的表名

func (i *Instance) TableName() string {

    return "instance" # 默认 Instance 结构对应 instances 数据库表

}

2.软删除

gorm 在使用时提供了，硬删除和软删除两种方式。

硬删除：即将数据物理删除。

软删除：在表中加入 delete_at 字段，默认类型为 time 类型，在进行删除操作时会将Delete 语句 变更为 update 语句，修改 delete_at 字段的值为当前时间。在进行查询时，gorm 会自动忽略 delete_at 字段不为空的数据，实现软删除（逻辑删除）的效果。

有时候我们在实际开发过程中，逻辑删除字段并不固定，在 gorm 中默认是 time 类型的 delete_at 字段，所以就需要进行修改。

3.实现自定义软删除字段

3.1 自定义软删除字段

// GvaModel 基础模型
type GvaModel struct {
    Id         string     `json:"id" gorm:"id"` // 主键ID
    CreateBy   string     `json:"createBy" gorm:"create_by"`
    UpdateBy   string     `json:"updateBy" gorm:"update_by"`
    CreateTime *time.Time `json:"createTime" gorm:"create_time"` // 创建时间
    UpdateTime *time.Time `json:"updateTime" gorm:"update_time"` // 更新时间
    IsDel      int        `gorm:"index" json:"-"`                // 逻辑删除字段
}

这里创建了一个公用的基础模型，包含了一些公用属性，当然也包含我们的软删除字段。

这里 我将字段名定义为 is_del 类型是 tinyint(1)

3.2 设置软删除字段

在初始化数据库链接对象时，我们可以设置软删除字段。

// InitDataSource 初始化数据库
func InitDataSource() {
    dsn := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?parseTime=True&loc=Local",
        Viper.GetString("datasource.username"),
        Viper.GetString("datasource.password"),
        Viper.GetString("datasource.host"),
        Viper.GetString("datasource.port"),
        Viper.GetString("datasource.db_name"))
    gcf := &gorm.Config{
        NamingStrategy: schema.NamingStrategy{
            TablePrefix:   Viper.GetString("datasource.table_prefix"), // 控制表前缀
            SingularTable: true,
        },
        Logger: logger.Default, // 控制是否sql输出，默认是不输出
    }
    if Viper.GetBool("datasource.log_mode") {
        gcf.Logger = NewGormLogger() // 使用zap进行日志输出
    }

    if tmp, err := gorm.Open(mysql.Open(dsn), gcf); err != nil {
        Logger.Error("MySQL启动异常", zap.Error(err))
        panic(err)
    } else {
        // 设置delete_at字段类型
        tmp.Set("gorm:softDelete", "is_del")
        GormDao = tmp
    }
}

3.3 gorm.DB.set() 函数常用参数

    在自定义软删除字段时使用到了 gorm.DB.set()函数，set函数有两个参数，key,value，一般用于设置数据库连接，以下是一些常用的参数：

1. "gorm:table_options": 用于设置表的选项，例如设置表引擎、字符集等。

db.Set("gorm:table_options", "ENGINE=InnoDB CHARSET=utf8mb4")

2. "gorm:association_autoupdate": 设置关联关系的自动更新选项，当更新主表时自动更新关联的从表。

db.Set("gorm:association_autoupdate", false)

3. "gorm:association_autocreate": 设置关联关系的自动创建选项，当创建主表时自动创建关联的从表。

db.Set("gorm:association_autocreate", false)

4. "gorm:save_associations": 设置保存关联关系的选项，当保存主表时，同时保存关联的从表。

db.Set("gorm:save_associations", false)

5. "gorm:association_save_reference": 设置保存关联关系引用的选项，当保存主表时，同时保存关联的从表的引用。

db.Set("gorm:association_save_reference", false

6. "gorm:query_option": 设置查询选项，用于自定义查询的选项。

db.Set("gorm:query_option", "FOR UPDATE")