文档：https://pkg.go.dev/github.com/google/go-cmp/cmp
与reflect.DeepEqual 相比，它提供了自定义比较方式，另外如果是在测试中，它可以返回可读性较高的两个值之间的差异。

Func

  1. // Diff返回一个人类可读的关于两个值之间差异的报告:y - x。
  2. // 当且仅当Equal对相同的输入值和选项返回true时，它返回一个空字符串。
  3. func Diff(x, y interface{}, opts ...Option) string
  5. // 它的行为与reflect.DeepEqual比较类似
  6. // 基本数据类型，如bool,int,float,complex numbers,string, channel 相当于 '=='
  7. // Func 只有两者都是 nil 时相等
  8. // Struct 递归判断每个字段Equal，如果包含未导出字段且没有忽略它，或导致恐慌
  9. // Slice 相同索引处的元素“深度”相等, non-nil 和 nil slice不相等
  10. // Map key 指向的value 相等, non-nil 和 nil map不相等
  11. // Pointer 两者存储的具体值“深度”相等
  12. func Equal(x, y interface{}, opts ...Option) bool
  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/google/go-cmp/cmp"
  6. )
  8. type Persion struct {
  9.     Name string
  10.     Age uint
  11. }
  13. func main() {
  14.     p1 := Persion{"zhangsan",10}
  15.     p2 := Persion{"zhangsan",20}
  16.     diff := cmp.Diff(p1,p2)
  17.     fmt.Println(diff)
  18. }
  19. --------------------------------output-----------------------------------
  20.   main.Persion{
  21.         Name: "zhangsan",
  22. -       Age:  10,
  23. +       Age:  20,
  24.   }

type Option

  1. func AllowUnexported(types ...interface{}) Option // 允许比较指定的未导出类型
  2. func Exporter(f func(reflect.Type) bool) Option // 允许对哪些未导出字段进行比较
  3. /*
  4. // 允许对所有未导出字段进行比较
  5. diff := cmp.Diff(p1,p2,cmp.Exporter(func(r reflect.Type) bool {
  6.         return true
  7.     }))
  8. */
  10. func Comparer(f interface{}) Option // 自定义比较器，f必须是 func(T, T) bool 类型
  11. func Ignore() Option // 不进行比较
  13. // FilterPath返回一个新的Option，只有f返回true时，opt才会生效
  14. // 传入的选项可以是Ignore、Transformer、Comparer、Options或先前过滤过的option
  15. func FilterPath(f func(Path) bool, opt Option) Option

type Path

  1. type Path []PathStep
  3. func (pa Path) GoString() string // 使用Go语法返回特定节点的路径
  4. func (pa Path) Index(i int) PathStep
  5. func (pa Path) Last() PathStep
  6. func (pa Path) String() string

type PathStep

  1. type PathStep interface {
  2.     String() string
  3.     Type() reflect.Type
  4.     Values() (vx, vy reflect.Value)
  5. }

一个复杂的例子

  1. func main() {
  2.     p1 := NewPersion("zhangsan",10)
  3.     p2 := NewPersion("zhangsan",20)
  5.     // 当匹配到指定的path，我们将其转交给cmp.Comparer 做比较
  6.     diff := cmp.Diff(p1,p2,cmp.FilterPath(func(path cmp.Path) bool {
  7.         fmt.Println(path.String())
  8.         fmt.Println(path.Last().String())
  9.         fmt.Println(path.GoString())
  10.         if path.String() == "Age" {
  11.             return true
  12.         }
  13.         return false
  14.     },cmp.Comparer(func(x,y uint) bool {
  15.         return true
  16.     })))
  17.     fmt.Println(diff)
  18. }
  20. --------------------------------output-----------------------------------
  21. Name
  22. .Name
  23. {main.Persion}.Name
  24. Age
  25. .Age
  26. {main.Persion}.Age