第4章 使用ExternalResource管理资源

4.1 原理说明

ExternalResource 是 JUnit 4.7 引入的 TestRule 抽象子类，专门管理需要在每个测试前后进行生命周期的外部资源（如文件流、网络连接、数据库链接）。其核心机制是模板方法模式：子类实现 before() 完成资源获取，实现 after() 完成资源释放。JUnit 保证无论测试通过、失败或抛出异常，after() 都会被执行，从而防止资源泄漏。

4.2 实现步骤

1. 定义继承 ExternalResource 的类，例如 DatabaseResource。
2. 在类中保存数据库连接对象（如 Connection）作为字段。
3. 重写 protected void before() throws Throwable：建立连接，可设置自动提交、初始化数据源。
4. 重写 protected void after()：关闭连接（和 Statement/PreparedStatement 等），置空引用。
5. 在测试类中通过 @Rule 或 @ClassRule 注入该 Rule 实例。
6. 在测试方法中通过 Rule 提供的公共 getter 获取连接，执行 SQL。

4.3 代码示例

import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExternalResource;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

public class DatabaseResource extends ExternalResource {
    private Connection connection;
    private final String url = "jdbc:h2:mem:test";
    private final String user = "sa";
    private final String password = "";

    @Override
    protected void before() throws Throwable {
        connection = DriverManager.getConnection(url, user, password);
        System.out.println("[DatabaseResource] Connection opened: " + connection);
        // 可选：初始化表结构
        try (Statement stmt = connection.createStatement()) {
            stmt.execute("CREATE TABLE IF NOT EXISTS users (id INT PRIMARY KEY, name VARCHAR(50))");
        }
    }

    @Override
    protected void after() {
        if (connection != null) {
            try {
                connection.close();
                System.out.println("[DatabaseResource] Connection closed.");
            } catch (Exception e) {
                throw new RuntimeException("Failed to close connection", e);
            }
        }
    }

    public Connection getConnection() {
        return connection;
    }
}

public class UserDaoTest {
    @Rule
    public DatabaseResource dbResource = new DatabaseResource();

    @Test
    public void shouldInsertUser() throws Exception {
        Connection conn = dbResource.getConnection();
        try (Statement stmt = conn.createStatement()) {
            stmt.execute("INSERT INTO users (id, name) VALUES (1, 'Alice')");
            ResultSet rs = stmt.executeQuery("SELECT name FROM users WHERE id=1");
            rs.next();
            System.out.println("User name: " + rs.getString("name"));
        }
    }
}

4.4 配置细节

4.5 调试方法

• 打印生命周期事件：在 before() 和 after() 添加日志（如上例 System.out），运行测试观察控制台输出顺序。
• 启用数据库连接监控：在 H2 等内存数据库中使用 TRACE_LEVEL_SYSTEM_OUT=2 查看连接打开/关闭细节。
• 断点调试：在 after() 内设置条件断点，某些测试失败时检查连接是否仍处于开放状态。
• 模拟超时异常：在 before() 中故意抛出异常，验证 after() 不会被错误跳过（JUnit 保证不会执行 after 如果 before 失败）——但仍需确保资源状态一致性。

4.6 常见错误及优化

4.7 优化技巧

• 使用 @ClassRule 复用连接池：将 DatabaseResource 声明为 @ClassRule，所有测试方法共享同一个连接池，显著减少连接创建开销。
• 结合 @Before / @After 做事务隔离：在 Rule 的 before() 中开始事务，在 after() 中回滚，保证每个测试不受其他测试影响。
• 泛型化 ExternalResource：创建抽象 ResourceRule<T> extends ExternalResource，支持任意资源类型，提高代码复用。
• 异常边界处理：在 after() 中捕获所有异常并记录，不要吞掉原始测试异常（可配合 MultipleFailureException）。