使用Gorm动态更新数据表中的字段

• 问题描述

当使用API 更新数据表中的记录时，会存在只需要更新部分字段的需求。

这里我使用了Gin 构建API, 通过Gorm进行数据表的操作

假设我们有如下的API 以及对应model的struct：

//API 
PUT /users

//Body
{
    "id": 16,
    "realName": "Tester1"
}

type SysUser struct {
    ID         int64     `gorm:"column:id;primaryKey;autoIncrement:true" json:"id"` // id
    Username   string    `gorm:"column:username;not null" json:"username"`          // 用户名
    Password   string    `gorm:"column:password" json:"password"`                   // 密码      RealName   string     `gorm:"column:real_name" json:"real_name"`                 // 真名
    Email      string    `gorm:"column:email" json:"email"`                         // 邮箱
    Mobile     string    `gorm:"column:mobile" json:"mobile"`                       // 手机号
}

• 实现方式

这里我用map[string]interface{} 来接收request body 中的数据, 在接受数据之后再进行json key 和 gorm column key 的转换。

• map[string]interface{} 接收request body

这里使用io.ReadAll 读取context 中的body数据， 之后使用json.Unmarshal 把context body中读取到的数据转换成map[string]interface{}

• json key 转换 gorm column key

这里使用reflect 获取struct 中的fields, 使用filed 中的Tag 获取json key， 然后使用Gorm中的schema.ParseTagSetting 获取column key

主要的技术细节如上， 详细的可以参考code部分

• Code

func main(){
    router := gin.New()
    router.PUT("/users", func(ctx *gin.Context) {
            m, err := common.GetReqBodyAsMap(ctx)
            if err != nil {
                logger.Err(err.Error(), ctx, err)
                ctx.JSON(http.StatusBadrequest, "Fail")
                return
            }
            err = UpdateUser(ctx, m)
            if err != nil {
                logger.Err(err.Error(), ctx, err)
                ctx.JSON(http.StatusBadrequest, "Fail")
                return
            }
            ctx.JSON(http.StatusOK, "Success")
        })
    }
    router.Run(":8080")
}

func GetReqBodyAsMap(ctx *gin.Context) (map[string]interface{}, error) {
    bodyData, _ := io.ReadAll(ctx.Request.Body)
    data := make(map[string]interface{})
    err := json.Unmarshal(bodyData, &data)
    if err != nil {
        return nil, err
    }
    return data, nil
}

func ConvertToGormKey(m map[string]interface{}, obj any) {
    t := reflect.TypeOf(obj)
    for i := 0; i < t.NumField(); i++ {
        sf := t.Field(i)
        jsonKey := sf.Tag.Get("json")
        tagSetting := schema.ParseTagSetting(sf.Tag.Get("gorm"), ";")
        val, ok := m[jsonKey]
        if ok {
            delete(m, jsonKey)
            m[tagSetting["COLUMN"]] = reflect.ValueOf(val).Convert(sf.Type).Interface()
        }
    }
}

func UpdateUser(ctx *gin.Context, m map[string]interface{}) err {
    ConvertToGormKey(m, SysUser{})
    su := dao.Use(dao.Db()).SysUser
    rstInfo, err := su.WithContext(ctx).Where(su.ID.Eq(m["id"].(int64))).Updates(&amp;m)
    if rstInfo.RowsAffected == 0 {
        err = errors.New("no rows were updated")
        logger.Err("Update failed", ctx, err)
        return err
    }
    return err
}