【Java 基础篇】Java JUnit 使用详解

蔚落 2023-10-16 15:07 6阅读 0赞

![在这里插入图片描述][1f2eccffa7644416ac121946452b7683.png]

JUnit是一个用于编写和运行单元测试的Java框架。它是开发高质量、可维护和可扩展的Java应用程序的关键工具之一。本文将详细介绍JUnit的使用，包括JUnit的安装、基本用法、常见注解、测试套件、参数化测试等内容。

### 什么是单元测试？ ###

在深入JUnit之前，让我们首先了解一下什么是单元测试。单元测试是一种软件测试方法，用于验证应用程序中的最小代码单元（通常是一个函数、方法或类）是否按照预期工作。单元测试的目的是隔离代码的不同部分并确保它们在独立测试时按照规范运行。

### JUnit的安装 ###

要使用JUnit，首先需要将JUnit库添加到您的项目中。可以通过以下两种方式之一进行安装：

#### 方法一：手动下载并添加JUnit库 ####

1.  访问JUnit的官方网站：[https://junit.org/junit5/][https_junit.org_junit5]。
2.  下载JUnit的JAR文件（通常是`junit-platform-console-standalone.jar`）。
3.  将下载的JAR文件添加到您的项目中的类路径中。

#### 方法二：使用构建工具（如Maven或Gradle） ####

如果您的项目使用Maven或Gradle等构建工具，可以很容易地添加JUnit依赖。以下是使用Maven的示例：

##### Maven: #####

在项目的`pom.xml`文件中，添加以下JUnit依赖：

<dependencies>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>5.7.2</version> 
            <scope>test</scope>
        </dependency>
    </dependencies>

Gradle用户可以通过在`build.gradle`文件中添加相应的依赖来完成类似的操作。

### 基本用法 ###

一旦您的项目配置好了JUnit，就可以开始编写测试用例了。JUnit使用注解来标识测试方法，以下是一个简单的示例：

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

在上面的示例中，我们创建了一个名为`MyMathTest`的测试类，其中包含一个名为`testAdd`的测试方法。该方法使用`assertEquals`断言来检查`math.add(2, 3)`的结果是否等于5。如果不等于5，测试将失败。

要运行这个测试，您可以使用您的IDE（如Eclipse或IntelliJ IDEA）或者使用命令行工具执行JUnit测试。通常情况下，JUnit测试类的命名约定是在类名后面添加`Test`，这有助于JUnit自动识别测试类。

### 常见JUnit注解 ###

JUnit使用各种注解来控制测试的行为和配置。以下是一些常用的JUnit注解：

#### `@Test` ####

`@Test`注解用于标识测试方法。JUnit将执行所有带有`@Test`注解的方法，并报告测试结果。

@Test
    public void testAdd() {
        
        // 测试代码
    }

#### `@Before` 和 `@After` ####

`@Before`和`@After`注解用于在测试方法之前和之后执行一些设置或清理工作。这对于准备测试环境和资源的初始化非常有用。

@Before
    public void setUp() {
        
        // 执行测试前的准备工作
    }
    
    @After
    public void tearDown() {
        
        // 执行测试后的清理工作
    }

#### `@BeforeEach` 和 `@AfterEach` ####

`@BeforeEach`和`@AfterEach`注解与`@Before`和`@After`类似，但它们在每个测试方法之前和之后执行，而不是在测试类级别执行。

@BeforeEach
    public void init() {
        
        // 在每个测试方法前执行初始化
    }
    
    @AfterEach
    public void cleanup() {
        
        // 在每个测试方法后执行清理工作
    }

#### `@BeforeAll` 和 `@AfterAll` ####

`@BeforeAll`和`@AfterAll`注解用于在测试类中的所有测试方法之前和之后执行一次。通常用于执行全局初始化和清理工作。

@BeforeAll
    public static void initAll() {
        
        // 在所有测试方法前执行初始化
    }
    
    @AfterAll
    public static void tearDownAll() {
        
        // 在所有测试方法后执行清理工作
    }

#### `@Disabled` ####

`@Disabled`注解用于禁用测试方法。被标记为`@Disabled`的测试方法不会被执行。

@Disabled
    @Test
    public void disabledTest() {
        
        // 这个测试方法被禁用
    }

### 其它JUnit注解 ###

除了上面介绍的常用JUnit注解之外，JUnit 5还提供了一些其他有用的注解，可以用于测试和测试方法的各种配置和控制。以下是一些其他常用的JUnit注解：

#### `@Timeout` ####

`@Timeout`注解用于指定测试方法的超时时间。如果测试方法执行时间超过指定的超时时间，测试将被标记为失败。

@Test
    @Timeout(2) // 指定超时时间为2秒
    public void testWithTimeout() throws InterruptedException {
        
        Thread.sleep(3000); // 这个测试方法将会失败，因为执行时间超过了2秒
    }

#### `@RepeatedTest` ####

`@RepeatedTest`注解用于重复运行相同的测试方法多次。

@RepeatedTest(3) // 重复运行3次
    public void repeatedTest() {
        
        // 这个测试方法将会被运行3次
    }

#### `@Tag` ####

`@Tag`注解用于为测试类或测试方法添加标签。标签可以用于组织和筛选测试，例如只运行特定标签的测试。

@Tag("integration") // 给测试方法添加一个名为"integration"的标签
    @Test
    public void integrationTest() {
        
        // 这个测试方法被标记为"integration"标签
    }

#### `@DisplayName` ####

`@DisplayName`注解用于为测试类或测试方法指定自定义的显示名称，用于更清晰地描述测试的目的。

@DisplayName("Custom Display Name") // 自定义显示名称
    @Test
    public void customDisplayNameTest() {
        
        // ...
    }

#### `@ExtendWith` ####

`@ExtendWith`注解用于指定扩展，扩展是JUnit 5中的插件机制，可以扩展测试框架的功能。常见的扩展包括参数解析、条件测试、测试拦截等。

@ExtendWith(MyExtension.class) // 使用自定义扩展
    @Test
    public void testWithCustomExtension() {
        
        // ...
    }

这些是JUnit 5中的一些其他常用注解，它们可以帮助您更灵活地控制和配置测试。根据您的测试需求，可以选择适当的注解来优化测试代码。

### 测试套件 ###

测试套件是一种将多个测试类组合在一起运行的方式。JUnit 5引入了更灵活的测试套件机制，通过`@RunWith`注解来定义测试套件已经不再需要。

要创建一个测试套件，可以使用`@SelectClasses`注解来指定要包括在套件中的测试类，然后使用`@RunWith`注解运行测试套件。

import org.junit.platform.suite.api.SelectClasses;
    import org.junit.platform.suite.api.Suite;
    
    @Suite
    @SelectClasses({
        TestClass1.class, TestClass2.class})
    public class TestSuite {
        
        // 这里不需要编写任何代码
    }

### 参数化测试 ###

JUnit 5引入了参数化测试的概念，使您可以轻松地运行相同的测试方法多次，但使用不同的输入参数。这对于测试具有多个输入组合的方法非常有用。

要创建参数化测试，您可以使用`@ParameterizedTest`注解，然后提供测试参数和测试工厂方法。

import org.junit.jupiter.params.ParameterizedTest;
    import org.junit.jupiter.params.provider.CsvSource;
    import static org.junit.jupiter.api.Assertions.assertEquals;
    
    public class ParameterizedMathTest {
        
    
        @ParameterizedTest
        @CsvSource({
        "2, 3, 5", "5, 7, 12", "10, 0, 10"})
        public void testAdd(int a, int b, int expected) {
        
            MyMath math = new MyMath();
            int result = math.add(a, b);
            assertEquals(expected, result);
        }
    }

在上面的示例中，`@CsvSource`提供了测试参数，每个参数组由逗号分隔。参数化测试将会对每组参数运行测试方法，并验证是否符合预期的结果。

### 案例讲解 ###

以下是一个简单的JUnit 5注解的示例，演示如何使用JUnit来测试一个简单的Calculator类：

import org.junit.jupiter.api.BeforeEach;
    import org.junit.jupiter.api.Test;
    import static org.junit.jupiter.api.Assertions.*;
    
    public class CalculatorTest {
        
        private Calculator calculator;
    
        @BeforeEach
        void setUp() {
        
            // 在每个测试方法之前初始化Calculator对象
            calculator = new Calculator();
        }
    
        @Test
        void testAddition() {
        
            int result = calculator.add(2, 3);
            assertEquals(5, result); // 验证相等
        }
    
        @Test
        void testSubtraction() {
        
            int result = calculator.subtract(5, 3);
            assertEquals(2, result); // 验证相等
        }
    
        @Test
        void testMultiplication() {
        
            int result = calculator.multiply(2, 3);
            assertEquals(6, result); // 验证相等
        }
    
        @Test
        void testDivision() {
        
            int result = calculator.divide(6, 2);
            assertEquals(3, result); // 验证相等
        }
    
        @Test
        void testDivisionByZero() {
        
            assertThrows(ArithmeticException.class, () -> calculator.divide(5, 0));
        }
    }

在这个示例中，我们使用了以下JUnit注解：

*  `@BeforeEach`：用于标记在每个测试方法之前执行的方法。在此示例中，我们在每个测试方法之前初始化Calculator对象。
 *  `@Test`：用于标记测试方法。每个测试方法都应以`@Test`注解进行标记。
 *  `assertEquals`：JUnit的断言方法之一，用于验证预期值和实际值是否相等。
 *  `assertThrows`：JUnit的断言方法之一，用于验证是否抛出了预期的异常。

这个示例测试了一个Calculator类的基本数学运算方法，包括加法、减法、乘法、除法以及除零操作。JUnit通过注解和断言来简化测试，并提供了测试报告和结果的详细信息。

### 注意事项 ###

在使用JUnit进行单元测试时，有一些注意事项和最佳实践，以确保测试的准确性和可维护性。以下是一些常见的JUnit使用注意事项：

1.  **命名规范**：使用有意义的命名来标识测试方法和测试类。通常，测试方法的名称应以`test`开头，并描述被测试方法的行为。
    
        @Test
        void testCalculateTotalAmount() {
              
            // 测试方法的名称应描述被测试方法的行为
        }
2.  **独立性**：每个测试方法应该是相互独立的，不应该依赖于其他测试方法的状态。每个测试方法应该在一个干净的环境中运行，不受其他测试方法的影响。
3.  **注释和文档**：为测试方法和测试类添加清晰的注释和文档，以解释测试的目的和预期行为。这将有助于其他开发人员理解测试的意图。
4.  **断言**：使用适当的断言来验证被测试方法的行为。JUnit提供了多种断言方法，如`assertEquals`、`assertTrue`、`assertNotNull`等，根据需要选择合适的断言。
    
        @Test
        void testAddition() {
              
            int result = calculator.add(2, 3);
            assertEquals(5, result); // 验证相等
        }
5.  **异常测试**：对于可能抛出异常的方法，编写相应的异常测试。使用`assertThrows`来验证是否抛出了预期的异常。
    
        @Test
        void testDivisionByZero() {
              
            assertThrows(ArithmeticException.class, () -> calculator.divide(5, 0));
        }
6.  **组织测试**：使用JUnit的`@BeforeAll`、`@BeforeEach`、`@AfterEach`和`@AfterAll`注解来执行一次性的准备和清理工作，以及在每个测试方法前后执行的操作。
    
        @BeforeEach
        void setUp() {
              
            // 在每个测试方法之前执行
        }
        
        @AfterEach
        void tearDown() {
              
            // 在每个测试方法之后执行
        }
7.  **测试顺序**：默认情况下，JUnit不保证测试方法的执行顺序。确保您的测试方法是独立的，不依赖于执行顺序。
8.  **测试套件**：JUnit允许您创建测试套件，将一组相关的测试类组合在一起运行。这对于执行整个测试集合非常有用。
9.  **参数化测试**：JUnit 5支持参数化测试，允许您运行相同的测试方法多次，但使用不同的输入参数。这可以大大减少代码冗余。
10. **超时设置**：在测试方法上使用`@Timeout`注解可以设置测试方法的最大执行时间，以避免无限等待。

@Test
    @Timeout(5) // 设置最大执行时间为5秒
    void testTimeout() {
        
        // ...
    }

1.  **忽略测试**：在开发过程中，有时您可能需要忽略某些测试。您可以使用`@Disabled`注解来禁用测试方法。

@Disabled
    @Test
    void testDisabled() {
        
        // 这个测试方法被禁用
    }

1.  **使用Mock对象**：当测试依赖于外部资源或其他类时，考虑使用Mock对象来模拟这些依赖，以隔离测试并使其更可靠。

这些注意事项可以帮助您编写更好的JUnit单元测试，确保测试的可维护性和可靠性。根据项目的需求，还可以进一步探索JUnit的高级功能和扩展。

### 结语 ###

JUnit是Java开发中必不可少的测试框架之一，它可以帮助您编写高质量、可维护的单元测试。本文介绍了JUnit的基本用法、常用注解、测试套件和参数化测试等内容，希望对您的测试工作有所帮助。在实际项目中，合理的单元测试可以提高代码的质量、可靠性和可维护性，因此请养成编写单元测试的习惯。

<table> 
 <tbody> 
  <tr> 
   <td> <strong><font>作者信息</font></strong><br> <br> <font> 作者 ： 繁依Fanyi</font><br> <font>CSDN：</font> <a href="https://blog.csdn.net/qq_21484461?spm=1000.2115.3001.5343" rel="nofollow"><font>https://techfanyi.blog.csdn.net</font></a><br> <font>掘金：</font><a href="https://juejin.cn/user/4154386571867191" rel="nofollow"><font>https://juejin.cn/user/4154386571867191</font></a> </td> 
  </tr> 
 </tbody> 
</table>

[1f2eccffa7644416ac121946452b7683.png]: https://img-blog.csdnimg.cn/1f2eccffa7644416ac121946452b7683.png
[https_junit.org_junit5]: https://junit.org/junit5/