库地址
github.com/bytedance/mockey
原理
`PatchValue` 函数是用于替换目标函数并将原始函数存储在代理函数中以便将来恢复。它接受三个参数:目标函数(target)、替换函数(hook)和代理函数指针(proxy)。所有参数都是 `reflect.Value` 类型。它还接受一个可选的布尔参数(unsafe),用于指示是否允许不安全的替换操作。
以下是 `PatchValue` 函数的步骤:
1. 使用 `reflect` 包检查函数参数的准确性(确保参数是函数和函数指针,以及它们具有相同的类型)。
2. 获取目标函数的指针地址(`targetAddr`)和前 64 个字节的代码缓冲区(`targetCodeBuf`)。
3. 构造一个跳转指令(`hookCode`),使其跳转到 `hook` 函数。
4. 在目标代码缓冲区中查找切割点(`cuttingIdx`),即比 `hookCode` 更长的完整指令的最小长度。这样做是为了确保我们不会破坏目标代码中的任何指令。
5. 构造一个新的代理代码缓冲区(`proxyCode`)。将目标函数的原始代码复制到代理代码中,然后添加一个跳转指令到目标代码的切割点。
6. 使用 `fn.InjectInto` 函数将新构造的代理代码注入到代理函数中。
7. 使用 `mem.WriteWithSTW` 函数将 `hookCode` 写入目标函数的地址,实际替换目标函数的代码。
注意:这个函数使用一种称为二进制代码替换的技术,它直接操作底层的机器代码。在替换机器代码时,它会注入跳转指令,使目标函数跳转到模拟函数。这是一种高级技术,可能需要更深入地了解计算机体系结构和汇编语言。
总之,`PatchValue` 函数在 `github.com/bytedance/mockey` 库中用于替换目标函数并将原始函数存储在代理函数中以便将来恢复。这是通过直接修改底层机器代码来完成的。
好处
`github.com/bytedance/mockey` 选择这种基于底层二进制代码替换的技术来实现动态模拟的原因是它能更高效地实现模拟,并支持更复杂的用例。当然,还有其他方式可以实现模拟函数,但它们可能在某些方面受到限制。
以下是一些常见的模拟方法及其优缺点:
1. **接口和依赖注入**:通过在代码中使用接口并在测试时注入模拟实现,可以很容易地实现模拟。这种方法适用于大多数情况,并且易于理解。但是,要使用这种方法,您需要在编写代码时就考虑到模拟,可能需要更改已有的代码。
2. **使用 `reflect` 包**:对于全局变量或方法,可以使用 Go 语言的 `reflect` 包来实现模拟。这种方法依赖于动态类型和运行时系统,可能会导致性能开销。此外,`reflect` 包对某些特殊用例(如未导出的函数)可能存在限制。
3. **底层二进制代码替换**:正如 `github.com/bytedance/mockey` 所使用的方法,这种方法可以轻松实现许多复杂用例,如私有函数或特定调用者的模拟。这种方法的性能开销较小,但难度和风险较高,因为它直接操作底层机器代码。
选择哪种方法取决于具体的需求和场景。通常,对于大多数项目,接口和依赖注入是一个比较好的选择,因为它易于理解且能满足大多数需求。然而,对于一些特殊或复杂的用例,底层二进制代码替换可能是一个更合适的选择。
`github.com/bytedance/mockey` 选择底层二进制代码替换作为其实现方式,是因为它可以解决更多复杂的模拟场景,如模拟私有函数或特定调用者。当然,这种方法需要对底层计算机体系结构和汇编语言有更深入的了解。
例子
可以直接mock某个结构的私有方法
func TestPushManager_BatchPushNotify(t *testing.T) {
mockey.PatchConvey("TestPushManager_BatchPushNotify", t, func() {
pushMgr := &PushManager{}
ctx := context.Background()
mockey.Mock((*PushManager).batchPushNotify).Return(nil).Build()
err := pushMgr.BatchPushAllNotify(ctx, buildTestUsers())
assert.NoError(t, err)
})
}