26. 如何在Spring Boot中进行测试？Spring Boot Test有哪些常用的测试注解？

PangHu大约 4 分钟

在 Spring Boot 中进行测试非常方便，Spring Boot 提供了丰富的测试支持，并且通过自动配置简化了测试环境的搭建。Spring Boot Test 是 Spring Boot 提供的一个强大的测试框架，集成了 JUnit、Mockito 和 Spring 的测试功能，允许开发者轻松编写和运行单元测试、集成测试等。

1. Spring Boot 中的测试类型

Spring Boot 提供了多种测试类型，包括：

单元测试：针对独立的代码单元（如服务、控制器）的测试，通常不依赖于 Spring 上下文。
集成测试：测试多个组件之间的交互，通常需要加载 Spring 上下文。
Web 测试：针对 Spring MVC 控制器的测试，验证 HTTP 请求和响应。

2. Spring Boot Test 的常用测试注解

Spring Boot Test 提供了一系列注解，用于简化测试环境的配置和测试的执行。以下是常用的测试注解：

2.1 `@SpringBootTest`

@SpringBootTest 是最常用的注解，它会启动整个 Spring 应用上下文，适合进行集成测试。它可以模拟一个完整的 Spring Boot 应用环境，包括所有的 Bean 和自动配置。

使用示例：

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

@SpringBootTest
public class MyApplicationTests {

    @Test
    void contextLoads() {
        // 测试 Spring 上下文是否加载成功
    }
}

2.2 `@WebMvcTest`

@WebMvcTest 专门用于测试 Spring MVC 控制器。它只加载 Web 层相关的 Bean，如控制器、ControllerAdvice、MessageConverter 等，不加载服务层和数据层的 Bean。

使用示例：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(MyController.class)
public class MyControllerTests {

    @Autowired
    private MockMvc mockMvc;

    @Test
    void shouldReturnDefaultMessage() throws Exception {
        this.mockMvc.perform(get("/"))
                .andExpect(status().isOk());
    }
}

2.3 `@DataJpaTest`

@DataJpaTest 用于测试 JPA 相关的功能，如 Repository。它只加载 JPA 相关的 Bean，并默认使用嵌入式数据库进行测试。

使用示例：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;

@DataJpaTest
public class UserRepositoryTests {

    @Autowired
    private UserRepository userRepository;

    @Test
    void testFindByUsername() {
        // 测试 JPA 方法
        User user = userRepository.findByUsername("test");
        assertNotNull(user);
    }
}

2.4 `@MockBean`

@MockBean 注解用于在 Spring 测试上下文中创建和注入一个模拟对象（mock），通常用于替换实际的依赖，以便在测试中控制依赖行为。

使用示例：

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

@SpringBootTest
public class MyServiceTests {

    @MockBean
    private MyRepository myRepository;

    @Autowired
    private MyService myService;

    @Test
    void testServiceMethod() {
        Mockito.when(myRepository.findData()).thenReturn("Mock Data");
        String data = myService.getData();
        assertEquals("Mock Data", data);
    }
}

2.5 `@MockMvc`

MockMvc 是 Spring 提供的一个用于测试 Spring MVC 控制器的模拟框架，结合 @WebMvcTest 注解使用，能够在不启动服务器的情况下测试控制器。

使用示例：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest
public class WebLayerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void shouldReturnDefaultMessage() throws Exception {
        this.mockMvc.perform(get("/"))
                .andExpect(status().isOk());
    }
}

2.6 `@AutoConfigureMockMvc`

@AutoConfigureMockMvc 注解用于自动配置 MockMvc，可以与 @SpringBootTest 结合使用，以便在不使用 @WebMvcTest 时也能够测试控制器。

使用示例：

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.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.test.web.servlet.MockMvc;

@SpringBootTest
@AutoConfigureMockMvc
public class FullContextTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    void testHomePage() throws Exception {
        mockMvc.perform(get("/"))
               .andExpect(status().isOk());
    }
}

2.7 `@TestConfiguration`

@TestConfiguration 注解用于在测试类中定义额外的 Spring 配置，它只会在测试环境中加载，适合为测试场景提供额外的 Bean 配置。

使用示例：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@TestConfiguration
public class TestConfig {

    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }
}

3. 测试的最佳实践

使用@SpringBootTest进行集成测试：@SpringBootTest 能够加载完整的 Spring 上下文，适合进行跨层次的集成测试。
使用@WebMvcTest进行控制器测试：@WebMvcTest 能够模拟 Web 环境，适合对控制器进行单独测试。
使用@DataJpaTest进行数据层测试：@DataJpaTest 提供了 JPA 的测试支持，适合对数据访问层的测试。
使用@MockBean和@MockMvc简化测试：@MockBean 允许模拟依赖，@MockMvc 允许测试 Web 请求，结合起来可以轻松实现复杂场景的测试。

总结

@SpringBootTest：用于加载完整的 Spring 上下文，适合集成测试。
@WebMvcTest：用于测试 Spring MVC 控制器，仅加载 Web 层相关 Bean。
@DataJpaTest：用于测试 JPA 相关功能，加载数据层相关 Bean。
@MockBean：用于在测试环境中创建和注入模拟对象。
@AutoConfigureMockMvc 和 @MockMvc：用于模拟 Web 请求，测试控制器的行为。

Spring Boot 提供的这些测试注解和工具，使得开发者能够在不同的层次上进行全面的测试，从单元测试到集成测试，确保应用的质量和稳定性。