Simplify Resource Cleanup in JUnit with the New @AutoClose Annotation

1. Introduction

The @AutoClose annotation was added to the JUnit testing framework in version 5.11 and continues in JUnit 6. It aims to simplify resource management in test classes by automatically closing annotated fields after each test execution.

2. Traditional approach

Before @AutoClose, developers had to initialize resources in a @BeforeEach method and manually close them in a @AfterEach method, adding null‑checks to avoid NullPointerException. The following example shows this pattern for reading and writing a file:

public class Junit5FileIOCloseTest {
  private BufferedReader reader;
  private FileWriter writer;

  @BeforeEach
  public void setup() throws IOException {
    Path tempFile = Files.createFile(Path.of("d:/ssss.txt"));
    writer = new FileWriter(tempFile.toFile());
    reader = new BufferedReader(new FileReader(tempFile.toFile()));
  }

  @AfterEach
  public void cleanup() throws IOException {
    if (reader != null) {
      reader.close();
    }
    if (writer != null) {
      writer.close();
    }
  }

  @Test
  public void testReadWriteFile() throws IOException {
    writer.write("Spring Boot3实战案例200讲");
    writer.flush();
    String content = reader.readLine();
    Assertions.assertNotNull(content);
  }
}

@BeforeEach runs before each test method, creating a fresh state; @AfterEach runs after each test, requiring explicit null checks and extra lines of code that are easy to forget.

2.1 Using @AutoClose

By annotating the resource fields with @AutoClose, the @AfterEach method can be removed. JUnit’s extension framework detects the annotation, registers the fields, and automatically invokes their close() methods after the test, even if the test throws an exception or fails an assertion. The order of closing is the reverse of the declaration order.

public class Junit6FileIOCloseTest {
  @AutoClose
  private BufferedReader reader;
  @AutoClose
  private FileWriter writer;

  @BeforeEach
  public void setup() throws IOException {
    Path tempFile = Files.createFile(Path.of("d:/ssss.txt"));
    writer = new FileWriter(tempFile.toFile());
    reader = new BufferedReader(new FileReader(tempFile.toFile()));
  }

  @Test
  public void testFileOperations() throws IOException {
    writer.write("Spring Boot3实战案例200讲");
    writer.flush();
    String content = reader.readLine();
    Assertions.assertNotNull(content);
  }
}

If a field annotated with @AutoClose is null, JUnit logs a warning, for example:

12月 13, 2025 8:32:07 上午 org.junit.jupiter.engine.extension.AutoCloseExtension closeField
警告: Cannot @AutoClose field com.pack.test6.Junit6FileIOCloseTest.reader because it is null.

2.2 Other scenario applications

Database connection – the annotation ensures the connection is returned to the pool or released after each test.

public class DatabaseTest {
  @AutoClose
  private Connection connection;

  @BeforeEach
  public void setup() throws SQLException {
    connection = DriverManager.getConnection("jdbc:h2:mem:testdb");
  }

  @Test
  public void testQuery() throws SQLException {
    // ... test logic ...
  }
}

HTTP client – closing the Apache HttpClient releases its internal thread pool and connection pool.

public class ApiClientTest {
  @AutoClose
  private CloseableHttpClient httpClient;

  @BeforeEach
  public void setup() {
    httpClient = HttpClients.createDefault();
  }

  @Test
  public void testApiEndpoint() throws IOException {
    // ... test logic ...
  }
}

Stream processing – a Stream<String> created from a file is automatically closed after the test.

public class StreamProcessorTest {
  @AutoClose
  private Stream<String> lines;

  @BeforeEach
  public void setup() throws IOException {
    Path file = Files.createFile(Path.of("d:/ssss.txt"));
    Files.write(file, List.of("line1", "line2", "line3"));
    lines = Files.lines(file);
  }

  @Test
  public void testStreamProcessing() {
    long count = lines.filter(line -> line.startsWith("line")).count();
    Assertions.assertEquals(3, count);
  }
}

Custom AutoCloseable class – any class that implements AutoCloseable can be annotated. The class must provide a close() method.

public class PackFile implements AutoCloseable {
  @Override
  public void close() throws Exception {
    System.err.println("PackFile close...");
  }
}

Usage in a test:

public class AutoCloseCustomClassTest {
  @AutoClose
  private PackFile packFile;
}

If the class does not implement AutoCloseable or lacks a close() method, JUnit throws an error, illustrated by the following screenshot: