Junit5使用教程(5) --扩展模型2-临时目录扩展

JUnit 5 临时目录扩展（`@TempDir`）详解

JUnit 5 的临时目录扩展（通过 @TempDir 注解实现）允许在测试中自动创建和管理临时文件或目录，无需手动处理资源的创建和清理。它简化了文件操作的测试场景，确保资源隔离和测试独立性。

一、核心功能

自动创建临时目录
- 在测试方法或测试类运行时，自动生成临时目录。
自动清理资源
- 测试结束后，自动删除临时目录及其内容，避免残留文件。
线程安全和并发支持
- 每个测试方法或类实例使用独立的临时目录，避免并发冲突。

二、使用场景

文件读写测试
- 验证文件上传、下载或解析逻辑。
数据库或日志文件测试
- 生成临时数据库文件或日志文件。
资源隔离测试
- 确保每个测试使用独立目录，避免数据污染。

三、基本用法

1. 在测试方法参数中使用

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import java.nio.file.Path;

class TempDirExampleTest {

    @Test
    void testWithTempDirParameter(@TempDir Path tempDir) {
        Path file = tempDir.resolve("test.txt");
        // 创建文件并写入内容
        Files.write(file, "Hello, JUnit 5!".getBytes());
        Assertions.assertTrue(Files.exists(file));
    }
}

2. 在测试类字段中使用

class TempDirFieldExampleTest {

    @TempDir
    static Path sharedTempDir;  // 静态字段：所有测试方法共享

    @TempDir
    Path instanceTempDir;       // 实例字段：每个测试方法独立

    @Test
    void test1() {
        Path file = instanceTempDir.resolve("test1.txt");
        // ...
    }

    @Test
    void test2() {
        Path file = sharedTempDir.resolve("test2.txt");
        // ...
    }
}

四、操作临时目录

1. 创建文件和子目录

@Test
void createFilesAndDirs(@TempDir Path tempDir) throws IOException {
    // 创建文件
    Path file = tempDir.resolve("data.txt");
    Files.write(file, "content".getBytes());

    // 创建子目录
    Path subDir = tempDir.resolve("subdir");
    Files.createDirectory(subDir);

    Assertions.assertTrue(Files.isDirectory(subDir));
}

2. 读取和验证文件内容

@Test
void readFileContent(@TempDir Path tempDir) throws IOException {
    Path file = tempDir.resolve("test.csv");
    Files.write(file, List.of("name,age", "Alice,30"));

    List<String> lines = Files.readAllLines(file);
    Assertions.assertEquals(2, lines.size());
}

五、高级配置

1. 指定临时目录位置

默认情况下，临时目录由系统生成（如 java.io.tmpdir 路径），但可通过 JVM 参数自定义：

# 运行测试时指定临时目录根路径
mvn test -Djava.io.tmpdir=/custom/temp/path

2. 保留临时目录（调试用）

在测试失败时保留临时目录：

@Test
void debugTest(@TempDir(cleanup = CleanupMode.ON_SUCCESS) Path tempDir) {
    // 仅在测试成功时清理目录，失败时保留
    Assertions.fail("临时目录路径: " + tempDir);
}

六、注意事项

路径权限
- 确保测试进程有权限在系统临时目录中创建文件和目录。
并发测试
- 如果多个测试方法并发运行，避免共享非静态临时目录字段。
大文件处理
- 避免生成过大的临时文件，以免占用磁盘空间。
清理机制
- 默认在测试方法结束后清理目录，若需手动清理，可调用 FileUtils 工具类。

七、与其他扩展结合

临时目录扩展可与其他扩展（如 MockitoExtension）无缝协作：

@ExtendWith(MockitoExtension.class)
class CombinedTest {

    @Mock
    private FileService fileService;

    @Test
    void testFileUpload(@TempDir Path tempDir) {
        Path targetFile = tempDir.resolve("upload.txt");
        when(fileService.upload(targetFile)).thenReturn(true);
        Assertions.assertTrue(fileService.upload(targetFile));
    }
}