Go go-cmp 类型实现 Equal 后为什么不再逐字段比较

这是 go-cmp 的设计结果，不是字段丢失：当一个类型拥有符合签名的 Equal 方法时，cmp.Equal 会把它当成该类型的语义比较入口，因此当前节点不会继续逐字段递归。只有当前节点没有被 Ignore、Transformer 或 Comparer 等选项接管，也没有可用的 Equal 方法时，才会回到结构体字段比较。

如果测试需要检查底层字段，而不是检查类型作者定义的业务相等语义，可以把值转换为一个没有这些方法的定义类型；如果测试确实要保留业务语义，就直接保留 Equal。先决定比较契约，再决定写法。

官方地址：https://github.com/google/go-cmp

Equal 方法为什么会截断字段递归

cmp.Equal 不是简单调用反射逐层展开。它在每个比较节点上先看经过过滤后的选项：有 Ignore 就忽略，有唯一的 Transformer 或 Comparer 就使用它；这些选项都没有决定结果时，才检查当前值是否有形如 (T) Equal(T) bool 或 (T) Equal(I) bool 的方法。

因此，下面的类型虽然包含两个字段，但 cmp.Equal 看到的是 Payload.Equal 给出的结论。Checksum 不同并不会自动产生字段差异，因为方法已经把当前节点的比较结果返回了。

package cmpdemo

import "strings"

type Payload struct {
	Name     string
	Checksum string
}

// Equal 定义业务层的相等语义：名称不区分大小写，校验字段不参与判断。
func (p Payload) Equal(other Payload) bool {
	return strings.EqualFold(p.Name, other.Name)
}

选项优先级与逐字段比较不是同一层

最容易误解的是“定义了 Equal 就永远无法覆盖”。实际上，比较选项位于方法调用之前。比如某个测试想把两个 Payload 的完整值按自定义规则比较，可以用 cmp.Comparer 明确指定函数；但这个函数必须满足对称、确定且不修改输入的条件。

package cmpdemo_test

import (
	"testing"

	"github.com/google/go-cmp/cmp"
	"example.com/cmpdemo"
)

func TestPayloadWithComparer(t *testing.T) {
	got := cmpdemo.Payload{Name: "Cache", Checksum: "a1"}
	want := cmpdemo.Payload{Name: "cache", Checksum: "b2"}

	// Comparer 明确声明本测试的字段级契约，会在 Equal 方法之前决定当前节点。
	byFields := cmp.Comparer(func(x, y cmpdemo.Payload) bool {
		return x.Name == y.Name && x.Checksum == y.Checksum
	})

	if cmp.Equal(got, want, byFields) {
		t.Fatal("字段不同的 Payload 不应被判定为相等")
	}
}

这种写法适合少量测试覆盖某个特殊契约，但不要在多个包里复制不同版本的比较函数。比较规则一旦成为共享测试基础设施，就应集中命名，避免读者不知道当前断言究竟代表业务相等还是字段相等。

需要字段递归时，用定义类型去掉 Equal 方法

官方的 AvoidEqualMethod 示例采用类型转换：声明一个新的定义类型，它保留底层数据表示，却不继承原类型的方法。再用 cmp.Transformer 把原值转换为这个新类型，后续比较就会继续走普通结构体规则。

package cmpdemo_test

import (
	"testing"

	"github.com/google/go-cmp/cmp"
	"example.com/cmpdemo"
)

// payloadForCompare 是无 Equal 方法的测试视图，用来触发字段递归。
type payloadForCompare cmpdemo.Payload

func TestPayloadByFields(t *testing.T) {
	got := cmpdemo.Payload{Name: "Cache", Checksum: "a1"}
	want := cmpdemo.Payload{Name: "cache", Checksum: "b2"}

	// Transformer 只改变比较视图，不修改业务对象本身。
	stripEqual := cmp.Transformer("stripPayloadEqual", func(in cmpdemo.Payload) payloadForCompare {
		return payloadForCompare(in)
	})

	if cmp.Equal(got, want, stripEqual) {
		t.Fatal("转换为无方法类型后，字段差异应保留下来")
	}
}

这里的重点不是“Transformer 能绕过所有限制”，而是明确建立一个测试视图：原类型继续承担生产代码的语义相等方法，定义类型承担结构断言。若结构包含未导出字段，仍需按 go-cmp 的规则决定是忽略它，还是通过合适的导出策略显式允许比较。

这个取舍会带来什么后果

保留 Equal 的断言，测试的是类型作者承诺的语义；去掉 Equal 做结构比较，测试的是当前字段布局和字段值。前者更稳定地表达业务规则，后者更容易发现序列化、映射或构造逻辑漏写字段，但也会随着结构体增加字段而改变断言结果。

一句话判断：看到 Equal 方法后没有字段差异，先检查它的签名和返回语义；需要字段级测试时建立无方法的定义类型，而不是误以为 cmp.Diff 会自动忽略该方法。

相关问题

Equal 方法的名字相同但签名不匹配，还会被调用吗？

不会。go-cmp 只识别文档规定的 Equal(T) bool 或可赋值到接口的对应形式；签名不匹配时才会继续后续规则。

Transformer 会修改原始结构体吗？

不会。它生成的是比较过程中的转换值，原始业务对象不会因为比较而被改写。

为什么结构比较时又遇到未导出字段错误？

去掉 Equal 只是回到结构规则，不等于自动获得所有字段的访问权限。未导出字段仍要通过忽略或明确的导出策略处理。