JUnit常见注解

大家好，欢迎来到IT知识分享网。

JUnit 是 Java 中广泛使用的单元测试框架，其提供了丰富的注解来简化测试代码的编写和管理。不同版本的 JUnit 在注解的使用上略有差异，下面将分别介绍 JUnit 4 和 JUnit 5 中常见的注解。

JUnit 4 常见注解

1.@Test

• 作用：用于标记一个方法为测试方法。JUnit 会自动识别带有该注解的方法并执行。
• 示例：

java

import org.junit.Test; import static org.junit.Assert.assertEquals; public class CalculatorTest { @Test public void testAdd() { Calculator calculator = new Calculator(); int result = calculator.add(2, 3); assertEquals(5, result); } } class Calculator { public int add(int a, int b) { return a + b; } } 

2.@Before

• 作用：被该注解标记的方法会在每个测试方法执行之前执行，通常用于初始化测试所需的对象或数据。
• 示例：

java

import org.junit.Before; import org.junit.Test; import static org.junit.Assert.assertEquals; public class CalculatorTest { private Calculator calculator; @Before public void setUp() { calculator = new Calculator(); } @Test public void testAdd() { int result = calculator.add(2, 3); assertEquals(5, result); } } 

3.@After

• 作用：被该注解标记的方法会在每个测试方法执行之后执行，通常用于释放测试过程中占用的资源，如关闭数据库连接、文件句柄等。
• 示例：

java

import org.junit.After; import org.junit.Before; import org.junit.Test; import java.io.File; import java.io.FileWriter; import java.io.IOException; public class FileTest { private FileWriter writer; @Before public void setUp() throws IOException { File file = new File("test.txt"); writer = new FileWriter(file); } @Test public void testWrite() throws IOException { writer.write("Hello, World!"); } @After public void tearDown() throws IOException { if (writer != null) { writer.close(); } } } 

4.@BeforeClass

• 作用：被该注解标记的方法必须是静态方法，它会在所有测试方法执行之前执行一次，通常用于进行一些耗时的初始化操作，如加载配置文件、初始化数据库连接池等。
• 示例：

java

import org.junit.BeforeClass; import org.junit.Test; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; public class DatabaseTest { private static Connection connection; @BeforeClass public static void setUpClass() throws SQLException { connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/test", "root", "password"); } @Test public void testQuery() throws SQLException { // 执行数据库查询操作 } } 

5.@AfterClass

• 作用：被该注解标记的方法必须是静态方法，它会在所有测试方法执行之后执行一次，通常用于释放 @BeforeClass 方法中初始化的资源。
• 示例：

java

import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Test; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; public class DatabaseTest { private static Connection connection; @BeforeClass public static void setUpClass() throws SQLException { connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/test", "root", "password"); } @Test public void testQuery() throws SQLException { // 执行数据库查询操作 } @AfterClass public static void tearDownClass() throws SQLException { if (connection != null) { connection.close(); } } } 

6.@Ignore

• 作用：被该注解标记的测试方法会被 JUnit 忽略，不会被执行。通常用于临时禁用某个测试方法，例如该方法依赖的功能还未实现或存在问题。
• 示例：

java

import org.junit.Ignore; import org.junit.Test; public class IgnoredTest { @Test public void testMethod1() { // 正常执行的测试方法 } @Ignore("该方法暂时不执行，等待功能完善") @Test public void testMethod2() { // 被忽略的测试方法 } } 

JUnit 5 常见注解

1.@Test

• 作用：与 JUnit 4 中的 @Test 类似，用于标记一个方法为测试方法。
• 示例：

java

import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; public class CalculatorTest { @Test public void testAdd() { Calculator calculator = new Calculator(); int result = calculator.add(2, 3); assertEquals(5, result); } } 

2.@BeforeEach

• 作用：类似于 JUnit 4 中的 @Before，被该注解标记的方法会在每个测试方法执行之前执行。
• 示例：

java

import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; public class CalculatorTest { private Calculator calculator; @BeforeEach public void setUp() { calculator = new Calculator(); } @Test public void testAdd() { int result = calculator.add(2, 3); assertEquals(5, result); } } 

3.@AfterEach

• 作用：类似于 JUnit 4 中的 @After，被该注解标记的方法会在每个测试方法执行之后执行。
• 示例：

java

import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import java.io.File; import java.io.FileWriter; import java.io.IOException; public class FileTest { private FileWriter writer; @BeforeEach public void setUp() throws IOException { File file = new File("test.txt"); writer = new FileWriter(file); } @Test public void testWrite() throws IOException { writer.write("Hello, World!"); } @AfterEach public void tearDown() throws IOException { if (writer != null) { writer.close(); } } } 

4.@BeforeAll

• 作用：类似于 JUnit 4 中的 @BeforeClass，被该注解标记的方法必须是静态方法，会在所有测试方法执行之前执行一次。
• 示例：

java

import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; public class DatabaseTest { private static Connection connection; @BeforeAll public static void setUpClass() throws SQLException { connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/test", "root", "password"); } @Test public void testQuery() throws SQLException { // 执行数据库查询操作 } } 

5.@AfterAll

• 作用：类似于 JUnit 4 中的 @AfterClass，被该注解标记的方法必须是静态方法，会在所有测试方法执行之后执行一次。
• 示例：

java

import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException; public class DatabaseTest { private static Connection connection; @BeforeAll public static void setUpClass() throws SQLException { connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/test", "root", "password"); } @Test public void testQuery() throws SQLException { // 执行数据库查询操作 } @AfterAll public static void tearDownClass() throws SQLException { if (connection != null) { connection.close(); } } } 

6.@Disabled

• 作用：类似于 JUnit 4 中的 @Ignore，被该注解标记的测试方法会被 JUnit 5 忽略，不会被执行。
• 示例：

java

import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; public class DisabledTest { @Test public void testMethod1() { // 正常执行的测试方法 } @Disabled("该方法暂时不执行，等待功能完善") @Test public void testMethod2() { // 被忽略的测试方法 } } 

7.@DisplayName

• 作用：用于为测试类或测试方法指定一个自定义的显示名称，在测试报告中会显示该名称，提高测试报告的可读性。
• 示例：

java

import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; @DisplayName("计算器测试类") public class CalculatorTest { @Test @DisplayName("测试加法功能") public void testAdd() { Calculator calculator = new Calculator(); int result = calculator.add(2, 3); // 断言操作 } } 

8.@RepeatedTest

• 作用：用于指定一个测试方法需要重复执行的次数，常用于需要多次验证的场景。
• 示例：

java

import org.junit.jupiter.api.RepeatedTest; import org.junit.jupiter.api.Test; public class RepeatedTestExample { @RepeatedTest(5) public void testRepeatedly() { // 重复执行 5 次的测试方法 } } 

通过合理使用这些注解，可以使 JUnit 测试代码更加清晰、易于维护，提高单元测试的效率和质量。