Springboot整合Junit 实战详解

JUnit是一个流行的Java单元测试框架，而Spring Boot则简化了使用JUnit进行测试的过程。

下面是Spring Boot整合JUnit的基本步骤：

1. 添加依赖

首先，你需要在pom.xml文件中添加JUnit和Spring Boot测试支持的依赖。对于JUnit 5，这通常是spring-boot-starter-test，它会自动包含JUnit 5和相关的测试工具。

<dependency>
    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-test</artifactId>

    <scope>test</scope>

    <exclusions>
        <exclusion>
            <groupId>org.junit.vintage</groupId>

            <artifactId>junit-vintage-engine</artifactId>

        </exclusion>

    </exclusions>

</dependency>

如果想要使用JUnit 4，可以调整依赖项以匹配JUnit 4的版本。

2. 编写测试类

接下来，创建一个测试类，并使用@SpringBootTest注解来指定这是一个Spring Boot测试类。这个注解会告诉Spring Boot加载整个应用上下文。

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class ExampleServiceTest {

    @Test
    void contextLoads() {
        // 这个测试方法会检查Spring Boot上下文是否能正常加载
    }
}

3. 使用测试注解

在测试方法上使用@Test注解来标记这是一个测试方法。你可以添加更多JUnit提供的注解，比如@BeforeAll, @BeforeEach, @AfterEach, 和@AfterAll等，用于设置和清理测试环境。

4. 注入依赖

你可以在测试类中注入任何Spring管理的bean。使用@Autowired注解来注入实际的bean，或者使用@MockBean来模拟特定的bean行为。

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.test.context.ActiveProfiles;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.when;

@SpringBootTest
@ActiveProfiles("test")
public class ExampleServiceTest {

    @Autowired
    private ExampleService exampleService;

    @MockBean
    private ExampleRepository exampleRepository;

    @Test
    void shouldReturnDefaultMessage() {
        when(exampleRepository.findById(1L)).thenReturn(Optional.of(new ExampleEntity()));

        String result = exampleService.getMessage(1L);

        assertEquals("Expected message", result);
    }
}

5. 运行测试

最后，运行你的测试。大多数IDE都有内置的支持来运行JUnit测试，或者你也可以通过Maven命令行运行测试。

mvn test

JUnit提供了多种机制来处理和测试异常：

1. 预期异常

• • JUnit 5 提供了一个简单的注解 @Test 的属性 expected 来指定期望抛出的异常类型。但在JUnit 5中，推荐使用 assertThrows() 方法来更灵活地处理异常。
  • 示例：

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertThrows;

@Test
void shouldThrowArithmeticExceptionWhenDivideByZero() {
    assertThrows(ArithmeticException.class, () -> {
        int result = 1 / 0;
    });
}

1. 断言异常消息

• • 使用 assertThrows() 返回的异常对象，你可以进一步断言异常的消息或其它属性。
  • 示例：

@Test
void shouldThrowIllegalArgumentExceptionWithCorrectMessage() {
    IllegalArgumentException exception = assertThrows(IllegalArgumentException.class, () -> {
        throw new IllegalArgumentException("Invalid argument");
    });

    assertEquals("Invalid argument", exception.getMessage());
}

1. 测试异常链

• • 如果一个异常被另一个异常所引起，你可以使用 assertThrows() 结合 getCause() 方法来验证异常链。
  • 示例：

@Test
void shouldThrowIOExceptionCausedByFileNotFoundException() {
    IOException ioException = assertThrows(IOException.class, () -> {
        // 模拟IO操作失败
    });

    assertTrue(ioException.getCause() instanceof FileNotFoundException);
}

1. 使用try-catch块

• • 如果你想在测试中捕获异常并进行一些清理工作，你可以使用传统的try-catch块。
  • 示例：

@Test
void shouldHandleExceptionProperly() {
    try {
        // 执行可能抛出异常的操作
        operationThatMayThrow();
    } catch (Exception e) {
        // 清理资源或记录日志
        cleanup();
    }
}

1. 测试异常处理逻辑

• • 如果你的代码中有异常处理逻辑，例如使用 try-catch 或者 @ExceptionHandler 注解，你应该编写测试来验证这些逻辑是否按预期工作。

1. 忽略某些测试

• • 如果某个测试在某些条件下会抛出异常，而你希望暂时忽略它，可以使用 @Disabled 注解禁用该测试。

1. 条件性测试执行

• • 使用 @ConditionalOnExpression 或 @EnabledIfEnvironmentVariable 等注解，可以在满足特定条件时才执行测试，避免不必要的异常抛出。