Go t.TempDir 怎样管理测试临时文件

我在给 Go 包补测试时，最容易留下的不是断言，而是测试产生的临时目录：测试跑完目录还在，下一次运行又叠出一批新文件。现在更稳妥的写法是直接使用 t.TempDir()。它返回当前测试可用的临时目录，并在该测试及其子测试全部结束后自动清理。

官方文档：https://pkg.go.dev/testing#T.TempDir

只要临时文件属于某个测试，就优先让 t.TempDir() 管理它的生命周期；测试代码只保存返回路径，不再自己拼系统临时目录或安排重复的删除逻辑。

先把临时文件放进 t.TempDir

最小用法是把目录路径传给业务函数，再用 os.WriteFile 创建输入文件。目录创建失败时，TempDir 会直接终止当前测试，因此测试代码不需要接收一个目录创建错误。

func TestLoadConfig(t *testing.T) {
    // 每个测试拿到独立目录，避免使用项目目录中的固定文件名。
    dir := t.TempDir()
    input := filepath.Join(dir, "config.json")

    // 写入测试输入；权限 0o600 只让当前用户读写临时文件。
    data := []byte(`{"port":8080}`)
    if err := os.WriteFile(input, data, 0o600); err != nil {
        t.Fatalf("写入测试配置失败: %v", err)
    }

    got, err := LoadConfig(input)
    if err != nil {
        t.Fatalf("读取测试配置失败: %v", err)
    }
    if got.Port != 8080 {
        t.Fatalf("端口 = %d，想要 8080", got.Port)
    }
}

这里的关键不是文件名，而是文件名被限制在本次测试的目录下。多个测试即使都使用 config.json，也不会互相覆盖。测试文件需要导入 os 和 path/filepath；业务函数只接收路径，因此仍然可以单独复用。

清理时机跟着测试树走

TempDir 的清理时机是当前测试和全部子测试都完成之后。也就是说，父测试创建的目录可以在子测试完成前继续使用，但不要把目录路径理解成永久工作区；父测试返回后，依赖这个目录的异步 goroutine 也不应继续读写。

func TestExport(t *testing.T) {
    // 父测试拥有目录；子测试在父测试结束前仍可读取其中的输入。
    dir := t.TempDir()
    input := filepath.Join(dir, "source.txt")
    if err := os.WriteFile(input, []byte("demo"), 0o600); err != nil {
        t.Fatal(err)
    }

    t.Run("json", func(t *testing.T) {
        // 子测试完成后，父测试仍然可以检查共享输入。
        if _, err := os.Stat(input); err != nil {
            t.Fatalf("输入文件不可见: %v", err)
        }
    })

    // 不要在这里启动脱离测试生命周期的后台写入任务。
}

如果子测试拥有自己的输入，更清楚的方式是在子测试内部再次调用 t.TempDir()。这样目录归属和清理责任都落在同一个测试上，尤其适合表驱动测试。

多次调用会得到不同目录

一次测试中多次调用 t.TempDir()，每次都会返回唯一目录。可以把第一处目录当输入夹具、第二处目录当导出目标，避免同一目录中混合不同阶段的文件。

func TestConvert(t *testing.T) {
    // 输入和输出分开，失败时更容易判断是哪一侧产生了残留文件。
    inputDir := t.TempDir()
    outputDir := t.TempDir()
    if inputDir == outputDir {
        t.Fatal("TempDir 不应重复返回同一目录")
    }

    input := filepath.Join(inputDir, "in.txt")
    output := filepath.Join(outputDir, "out.json")
    if err := os.WriteFile(input, []byte("hello"), 0o600); err != nil {
        t.Fatal(err)
    }
    if err := Convert(input, output); err != nil {
        t.Fatal(err)
    }
}

不需要为了“保险”再写一个 defer os.RemoveAll(inputDir)。重复删除通常没有收益，反而可能掩盖测试真正的资源归属问题。

并行测试和 GOTMPDIR 的边界

在调用 t.Parallel() 的测试里，临时目录仍然适合做隔离边界，但不要把父测试的可变文件路径共享给多个并行子测试。如果每个用例都能独立准备输入，就在子测试内部创建目录；如果确实需要共享，只读共享文件更安全。

还可以通过环境变量 GOTMPDIR 指定临时目录的上层位置。它改变的是目录落点，不改变 TempDir 自动清理、每次调用唯一和测试生命周期归属的规则。CI 中应确保该位置存在、可写，并且不会被其他任务当作共享业务目录。

一张表记住 TempDir 的用法

常见问题

测试结束后还能读取 TempDir 里的文件吗？

不能把它当成测试结束后的持久化目录。需要保留的调试产物应显式复制到 CI 工件目录或其他持久化位置。

TempDir 和手动 os.MkdirTemp 有什么区别？

os.MkdirTemp 适合普通程序或需要自行控制清理时机的代码；t.TempDir 把目录与测试生命周期绑定，更适合测试夹具。

能否把 TempDir 当作并行测试的共享目录？

可以共享只读输入，但不建议让并行子测试写同一个文件。更简单的办法是让每个子测试创建自己的目录。

我的经验是：测试需要临时文件时先调用 t.TempDir()，把返回路径向下传递；只有在确实需要跨测试保存产物时，才另行设计持久化目录。这样测试结束、失败重跑和并行执行都更容易推理。