Gorm 改造指针对象

gorm object support pointer

foreversmart write on 2021-02-02
最近项目中正好用到 Gorm 在使用 Gorm 的过程中发现在进行对象查询的时候不支持指针。具体的文档如下:
如果我们强行使用指针进行查询代码如下:
Go
会得到 "invalid value" 的错误
我们继续探究下其实 gorm 并不是在查询的时候不支持指针对象,只是目前不支持没有初始化的空指针对象的绑定赋值。比如下面这段代码就可以正常的工作:
Go
在使用 Gorm 进行数据库查询操作的过程中,会有大量的使用指针但是指针没有初始化的场景,如果不使用指针则对于大对象会有大量的拷贝工作,而如果使用指针我们需要进行大量的初始化操作,写起来很繁琐而且很容易漏洞,并且只能在运行时发现容易导致线上问题。所以这个需求还是非常有意义的,然后就想 Gorm 提了 issue。但作者认为设计就是这样的,其实我也不是为了报 Bug,所以想这个需求也不复杂就干脆先改源码实现,然后 直接向 Gorm 提 PR。
第一步就是 Gorm 的源码阅读
接口层代码都在 finisher_api.go 中
可以看到这里面关于读操作的 api 大概有下面个:
Go
上面的函数 API 大概分为三类:
调用 tx.callbacks.Query().Execute(tx) 进行回调查询操作然后将返回的结果扔到 Scan 扫描方法将行结果反序列化到目标 Struct中;比如 Find(), First(), Last(), Pluck()。
调用基础方法实现查询操作的方法如:FindInBatches(), FirstOrCreate(),FirstOrInit()。它们基本都是调用,上面的方法实现功能上的封装。
Scan 方法调用 Rows() 获取行让后通过 ScanRows 进行处理,ScanRows 最终调用了 Scan 函数这里的 Scan 方法和 Scan 函数是不同的,而 Rows 也会调用 Execute 方法执行回调。
所以总的来说我们只需要关心的函数只有两个一个是 Excuete() 方法,另一个是 Scan 函数
首先我们来看 func (p *processor) Execute(db *DB) {} 这个方法 :
首先我们来看下 Execute 做了什么事情
Go
对于查询执行器 tx.callbacks.Query() 我们来看下它是怎么创建和初始化的
获取的代码:
Go
初始化代码:
Go
注册 Callback 函数
Go
最终执行查询的函数:
Go
我们可以发现上述 GORM 执行一个查询的过程中关于目标对象处理的逻辑是下面这段代码:
Go
我们只需要对于零指针的情况做初始化处理就可以解决我们的需求
Go
其中 stmt.ReflectValue.Type().Elem() 当前的类型,因为当前的类型是指针所以通过 Elem() 获取其指向的类型。
接下来我们在看下 func Scan(rows *sql.Rows, db *DB, initialized bool) {} 这个函数是怎么将行结果反序列化到具体的目标 Struct 变量中的:
Go
源码稍微有点长,不过大致的逻辑就是根据不同类型的 Dest 怎么样通过的放射的方式将行结果的值赋值给 Dest struct 的变量。这些类型里面唯独不支持指针类型,而我们在 Execute 方法中改造的逻辑会将 Dest 的 Value 设置为一个目标类型零值的指针。所以在 Scan 函数中我们需要增加一个 case
case reflect.Struct, reflect.Ptr: 而 Ptr struct 和 struct 的反射处理字段逻辑是一样的。现在我们要实现的需求就已经完成了, 在单测中增加相关的单测测试通过就可以提 PR 了。
PS:在阅读和调试第三方代码的时候可以将第三方代码的源码拉到本地,然后在 go mod 文件中修改依赖为我们本地的代码。这样就可以方便的调试和阅读第三方代码了。
Go
相关的 issue 和 PR

「真诚赞赏,手留余香」

Foreversmart

真诚赞赏,手留余香

使用微信扫描二维码完成支付