Go go-cmp 怎么给浮点数比较设置容差

Go 的浮点计算结果经常会出现最后几位的微小差异。使用 go-cmp 时，不要把这种差异简单改成字符串比较或手写全局断言；对浮点字段传入 cmpopts.EquateApprox(fraction, margin)，让比较规则明确写在测试选项里即可。fraction 表示相对容差，margin 表示绝对容差，二者都可以使用，也都必须是非负数。

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

运行手册式结论：数值跨度较大时优先给出一个小的相对容差；数值接近零时配合绝对容差；如果测试数据中可能出现 NaN 或无穷大，必须单独决定它们是否应该相等。容差不是“越大越稳定”，而是测试对业务误差的明确承诺。

一、触发信号：默认比较只差最后几位

先把问题缩小到断言层。cmp.Equal 和 cmp.Diff 默认会递归比较值；如果两个 float64 的差值来自计算顺序、舍入或外部输入，直接比较就可能失败。此时观察信号通常是：日志中的两个数看起来相同，但 cmp.Diff 仍然给出一处浮点差异。

package main

import (
	"fmt"

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

func main() {
	// 让差异输出保留在测试日志中，便于判断是否只是浮点尾差。
	got := 0.1 + 0.2
	want := 0.3
	if diff := cmp.Diff(want, got); diff != "" {
		fmt.Println(diff)
	}
}

这一步只负责确认信号，不要马上把容差调得很大。先知道误差的数量级，再决定是相对容差、绝对容差，还是二者组合。

二、快速判断：容差应该落在哪个尺度

cmpopts.EquateApprox 的判定可以概括为：

|x-y| ≤ max(fraction × min(|x|, |y|), margin)

fraction 和 margin 都传 0 时，不会得到一个有意义的近似窗口；工程上要根据输入数据的尺度填写。一个常用判断表如下：

三、处理步骤：用 EquateApprox 设置 float32 和 float64 容差

最直接的接入方式是把 cmpopts.EquateApprox 作为选项传给 cmp.Equal 或 cmp.Diff。它会比较 float32 和 float64 值；不要在测试中混入一个接收 interface{} 的“万能比较器”，否则很难看出规则覆盖了哪些类型。

package pricing_test

import (
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
)

func TestPrice(t *testing.T) {
	// 0.000001 是相对容差，0.0000001 是接近零时的绝对兜底。
	approx := cmpopts.EquateApprox(1e-6, 1e-7)
	got := []float64{19.9999998, 0.00000004}
	want := []float64{20, 0}

	// 选项会递归作用到切片元素中的 float64。
	if diff := cmp.Diff(want, got, approx); diff != "" {
		t.Fatalf("价格结果不在允许误差内 (-want +got):\n%s", diff)
	}
}

上例把“相对误差”和“接近零时的固定误差”放在同一处声明。生产代码里应根据领域单位选择数值，例如金额、角度、传感器读数不能共用没有依据的常量。

四、处理步骤：在 Diff、结构体和测试辅助函数中复用选项

排查失败测试时，优先用同一组选项调用 cmp.Diff，这样日志与断言采用相同规则。对于结构体，EquateApprox 会递归匹配其中的浮点字段；对混合结构体则仍会保留字符串、整数和布尔值的精确比较。

type Reading struct {
	Name  string
	Value float64
	Count int
}

func TestReading(t *testing.T) {
	// 统一封装测试选项，防止不同测试使用不同容差。
	approx := cmpopts.EquateApprox(1e-5, 1e-8)
	got := Reading{Name: "temperature", Value: 21.5000001, Count: 3}
	want := Reading{Name: "temperature", Value: 21.5, Count: 3}

	if diff := cmp.Diff(want, got, approx); diff != "" {
		t.Fatalf("读数不一致 (-want +got):\n%s", diff)
	}
}

如果项目里同时出现 float32 和 float64，先确认它们在业务上是否应该直接比较。需要把 float32 转成 float64 时，应该在被测代码或专门的转换层完成，而不是在比较器中悄悄改变数据含义。

五、告警确认：NaN、无穷大和过宽容差

官方文档明确说明，EquateApprox 在任一值为 NaN 或无穷大时不使用近似比较。不要把它理解成“所有特殊值都自动相等”。如果业务需要让两个 NaN 视为相等，可以和 cmpopts.EquateNaNs() 组合；正负无穷仍应按业务规则单独处理。

package metrics_test

import (
	"math"
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
)

func TestMetricWithNaN(t *testing.T) {
	// 近似比较不覆盖 NaN；只有明确加入 EquateNaNs 才接受两个 NaN。
	approx := cmpopts.EquateApprox(1e-5, 1e-8)
	opt := cmp.Options{approx, cmpopts.EquateNaNs()}

	got := []float64{math.NaN(), 10.000001}
	want := []float64{math.NaN(), 10}
	if !cmp.Equal(want, got, opt) {
		t.Fatal("指标结果不满足约定")
	}
}

若测试突然大量通过，先检查容差是否覆盖了真实错误。常见回滚动作是恢复上一版 fraction/margin，或把一个过宽的全局选项拆成按字段、按路径使用的选项；不要为了让 CI 变绿而继续放宽数值。

六、复盘项：把容差当作测试契约维护

每次新增或修改容差，都记录四件事：数据单位、误差来源、选择相对还是绝对边界、允许影响的字段范围。测试名称也应体现规则，例如“汇率结果允许百万分之一相对误差”，而不是笼统命名为“比较结果”。

如果容差只对一个字段有效，可以把比较范围收窄；如果多个测试都需要同一个规则，再集中定义测试辅助函数。保持规则小而明确，后续出现真实回归时，cmp.Diff 才能继续提供有价值的差异。

常见问题

只想设置固定小数误差，fraction 怎么写？

把 fraction 设为 0，把固定误差写入 margin，例如 cmpopts.EquateApprox(0, 1e-8)。

为什么设置了 EquateApprox 仍然比较失败？

检查两值差异是否超过计算出的窗口，是否包含 NaN 或无穷大，以及实际类型是不是被转换成了其他类型。还要确认选项真的传给了本次 Equal 或 Diff 调用。

能不能把 margin 设置得很大？

不建议。过大的绝对容差可能让数量级完全不同的结果通过，应先说明业务允许的误差，再用最小能覆盖计算噪声的边界。