Go errors.Join 怎么合并清理阶段的多个错误

Go 1.20 起，清理阶段出现多个错误时可以直接用 errors.Join 合并。它会忽略所有 nil，如果参数全是 nil 就返回 nil；只要存在非空错误，返回值就同时包装这些错误，后续仍能用 errors.Is 和 errors.As 查找每个根因。

典型场景是：写文件已经失败，随后 Close 又失败。如果简单写成 return file.Close()，主错误会丢失；反过来只返回写入错误，又会漏掉数据落盘或连接释放异常。

先保住主流程错误

单个资源最紧凑的写法是使用具名返回值，在 defer 中把已有错误和关闭错误合并。这样成功路径不会被制造出假错误，失败路径也不会发生覆盖。

func writeReport(path string, data []byte) (err error) {
    f, err := os.Create(path)
    if err != nil {
        return fmt.Errorf("创建报告: %w", err)
    }

    defer func() {
        // Join 会忽略 nil，同时保留写入错误和关闭错误
        err = errors.Join(err, f.Close())
    }()

    if _, err = f.Write(data); err != nil {
        // 包装业务上下文，底层错误仍可被 errors.Is/As 找到
        return fmt.Errorf("写入报告: %w", err)
    }
    return nil
}

这里有一个容易忽略的细节：f.Close() 必须写在延迟执行的函数体里。若写成提前求值的表达式，就会在注册 defer 时关闭文件，而不是在函数退出时关闭。

多个资源集中清理

数据库事务、压缩流和输出文件可能在同一任务中同时需要收尾。可以先完成业务操作，再按既定顺序执行清理，把结果集中交给 errors.Join。标准库会自动丢弃其中的 nil。

func exportData(dst io.WriteCloser, encoder io.Closer) (err error) {
    defer func() {
        // 先关闭编码器以刷新缓冲内容，再关闭最终输出目标
        encoderErr := encoder.Close()
        dstErr := dst.Close()

        // 主流程、编码器和输出目标的错误都进入同一错误树
        err = errors.Join(err, encoderErr, dstErr)
    }()

    if err := generateReport(dst); err != nil {
        return fmt.Errorf("生成报表: %w", err)
    }
    return nil
}

清理顺序仍由业务语义决定，errors.Join 只负责汇总，不会替你安排资源依赖。如果编码器必须先刷新到底层文件，就应先关闭编码器，再关闭目标文件。错误文本会按传入顺序以换行拼接，因此顺序也会影响日志可读性。

判断根因不要比较字符串

errors.Join 返回的非空错误实现的是 Unwrap() []error。因此应使用 errors.Is(joined, target) 判断哨兵错误，或使用 errors.As 提取具体类型。不要依赖拼接后的文本，也不要用普通 errors.Unwrap 逐层循环：后者只识别 Unwrap() error，对 Join 返回值会得到 nil。

版本要求：errors.Join 从 Go 1.20 开始提供。官方文档：https://pkg.go.dev/errors#Join

相关问题

errors.Join 会去重相同错误吗？

不会。它按传入值包装非空错误，不负责去重。若同一个错误可能被多次收集，应在调用 Join 前修正收集逻辑，而不是依赖字符串去重。

只有一个非空错误时还需要 Join 吗？

可以使用，语义仍然正确；但返回值是一个包装该错误的 Join 结果。判断根因时继续使用 errors.Is 或 errors.As，不要依赖直接相等。