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

• 问题描述

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

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

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

1.  
   //API
2.  
   PUT /users
3.  
    
4.  
   //Body
5.  
   {
6.  
   "id": 16,
7.  
   "realName": "Tester1"
8.  
   }

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

• 实现方式

这里我用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

1.  
    
2.  
    
3.  
    
4.  
   func main(){
5.  
       router := gin.New()
6.  
       router.PUT("/users", func(ctx *gin.Context) {
7.  
       m, err := common.GetReqBodyAsMap(ctx)
8.  
       if err != nil {
9.  
       logger.Err(err.Error(), ctx, err)
10.  
        ctx.JSON(http.StatusBadrequest, "Fail")
11.  
        return
12.  
        }
13.  
        err = UpdateUser(ctx, m)
14.  
        if err != nil {
15.  
        logger.Err(err.Error(), ctx, err)
16.  
                    ctx.JSON(http.StatusBadrequest, "Fail")
17.  
        return
18.  
        }
19.  
        ctx.JSON(http.StatusOK, "Success")
20.  
        })
21.  
        }
22.  
        router.Run(":8080")
23.  
    }
24.  
     
25.  
    func GetReqBodyAsMap(ctx *gin.Context) (map[string]interface{}, error) {
26.  
    bodyData, _ := io.ReadAll(ctx.Request.Body)
27.  
    data := make(map[string]interface{})
28.  
    err := json.Unmarshal(bodyData, &data)
29.  
    if err != nil {
30.  
    return nil, err
31.  
    }
32.  
    return data, nil
33.  
    }
34.  
     
35.  
    func ConvertToGormKey(m map[string]interface{}, obj any) {
36.  
    t := reflect.TypeOf(obj)
37.  
    for i := 0; i < t.NumField(); i {
38.  
    sf := t.Field(i)
39.  
    jsonKey := sf.Tag.Get("json")
40.  
    tagSetting := schema.ParseTagSetting(sf.Tag.Get("gorm"), ";")
41.  
    val, ok := m[jsonKey]
42.  
    if ok {
43.  
    delete(m, jsonKey)
44.  
    m[tagSetting["COLUMN"]] = reflect.ValueOf(val).Convert(sf.Type).Interface()
45.  
    }
46.  
    }
47.  
    }
48.  
     
49.  
    func UpdateUser(ctx *gin.Context, m map[string]interface{}) err {
50.  
        ConvertToGormKey(m, SysUser{})
51.  
        su := dao.Use(dao.Db()).SysUser
52.  
        rstInfo, err := su.WithContext(ctx).Where(su.ID.Eq(m["id"].(int64))).Updates(&m)
53.  
    if rstInfo.RowsAffected == 0 {
54.  
    err = errors.New("no rows were updated")
55.  
    logger.Err("Update failed", ctx, err)
56.  
    return err
57.  
    }
58.  
    return err
59.  
    }