Go testing.T.TempDir管理测试临时文件的清理方法

Go 测试需要落盘临时文件时，优先在测试入口调用 t.TempDir()，再用 filepath.Join 拼出文件路径。这样每个测试拥有独立目录，测试及其子测试结束后由 testing 框架自动删除，不再手写 defer os.RemoveAll。它适合替换测试里的临时目录，不等于可以把业务数据写进任意系统目录。

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

把手工清理迁移到 t.TempDir

旧代码常见的写法是调用 os.MkdirTemp，然后在多个返回路径上补清理逻辑。测试失败、t.Fatal 或新增子测试后，这段清理很容易被遗漏。迁移时只保留“准备目录”和“拼接文件名”两件事，目录的销毁交给 testing.T。

func TestConfigFile(t *testing.T) {
    // TempDir 由测试框架管理，测试及其子测试结束后自动清理。
    dir := t.TempDir()
    path := filepath.Join(dir, "config.json")

    // 只在临时目录内写入测试文件，避免污染项目目录。
    if err := os.WriteFile(path, []byte(`{"mode":"test"}`), 0o600); err != nil {
        t.Fatalf("写入测试配置失败: %v", err)
    }

    // 读取断言只验证业务结果，不再手动 RemoveAll。
    data, err := os.ReadFile(path)
    if err != nil {
        t.Fatalf("读取测试配置失败: %v", err)
    }
    if string(data) != `{"mode":"test"}` {
        t.Fatalf("配置内容不匹配: %s", data)
    }
}

这段代码需要导入 os、path/filepath 和 testing。TempDir 创建失败会调用 Fatal，所以不应再接收一个可为空的错误值，也不要在失败分支重复清理同一目录。

升级前后的写法和边界

可以先用下面的对照表排查测试代码中不必要的资源管理。迁移的重点不是把所有目录都改名，而是让“谁创建、谁拥有、何时销毁”保持一致。

需要注意，自动删除发生在测试和它的全部子测试完成之后。如果代码把临时目录路径交给后台 goroutine，测试返回后该 goroutine 仍可能访问已被清理的路径。正确做法是等待 goroutine 结束，或让 goroutine 的生命周期完全落在测试范围内。

并行子测试要不要共用目录

并行本身不是问题，共享写入才是问题。父测试可以创建只读输入，子测试分别调用自己的 TempDir 保存输出；如果必须复用父目录，也要让每个子测试使用不重复的文件名，并确认没有一个子测试负责删除父目录。

func TestRenderVariants(t *testing.T) {
    // 父目录只放不会被修改的输入，子测试不共享输出文件。
    fixtureDir := t.TempDir()
    input := filepath.Join(fixtureDir, "input.txt")
    if err := os.WriteFile(input, []byte("sample"), 0o600); err != nil {
        t.Fatalf("准备只读输入失败: %v", err)
    }

    for _, name := range []string{"plain", "compact"} {
        name := name
        t.Run(name, func(t *testing.T) {
            // 并行子测试各自拥有输出目录，避免文件名碰撞。
            t.Parallel()
            outputDir := t.TempDir()
            output := filepath.Join(outputDir, name+".out")
            if err := os.WriteFile(output, []byte(name), 0o600); err != nil {
                t.Fatalf("写入 %s 输出失败: %v", name, err)
            }
        })
    }
}

父目录适合放共享且只读的输入，子目录适合放每个变体的结果。这样既保留准备成本较低的夹具，也避免并行测试覆盖彼此的输出。若子测试需要读取父目录中的文件，确保父测试不会在 t.Run 返回前主动删除它。

迁移后的回归检查清单

• 全局搜索 os.MkdirTemp、ioutil.TempDir 和 os.RemoveAll，确认它们是否只服务于测试临时目录。
• 确认每个测试文件路径都由 filepath.Join(t.TempDir(), ...) 或等价的测试目录派生而来。
• 检查并行子测试是否写入同一个文件名，是否把可变状态放在父目录中。
• CI 若设置了 GOTMPDIR，确认该位置可写、空间足够，并把失败产物另行复制到持久化目录。
• 项目若仍支持 Go 1.14 及更早版本，需要保留兼容封装；否则可把 TempDir 作为 Go 1.15 迁移基线。

常见问题

t.TempDir 会在每次调用后立刻删除目录吗？

不会。目录会保留到当前测试及其全部子测试完成后；同一测试中再次调用会得到新的独立目录。

可以在测试结束后继续读取 TempDir 里的失败文件吗？

不应依赖它。需要保留日志或快照时，在测试结束前复制到 CI 的 artifact 目录，并让流水线负责保存。

GOTMPDIR 改变了 TempDir 的清理规则吗？

没有，它只影响临时目录创建位置。目录仍由测试框架负责清理，变量指向的位置需要具备写权限。

临时目录创建失败应该自己重试吗？

通常不需要。TempDir 创建失败会终止测试，先检查磁盘空间、权限和 GOTMPDIR 配置，再修复测试环境。