@SpringBootTest注解

@SpringBootTest 是 Spring Boot 提供的一个注解，用于编写集成测试。它可以帮助你在测试环境中启动一个完整的 Spring 应用程序上下文，以便你可以对应用程序的各个组件进行全面的测试。以下是 @SpringBootTest 注解的详细使用说明，包括其属性、使用场景和示例。

基本用法

@SpringBootTest 注解的基本用法如下：

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.junit.runner.RunWith;

@RunWith(SpringRunner.class)
@SpringBootTest
public class MyApplicationTests {

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

属性说明

@SpringBootTest 注解提供了多个属性，用于定制测试环境：

1. classes：指定要加载的配置类。默认情况下，Spring Boot 会自动检测并加载主配置类。

   @SpringBootTest(classes = MyConfiguration.class)
   

2. webEnvironment：指定 Web 环境类型。可选值包括：

   • MOCK（默认）：启动一个模拟的 Web 环境。
   • RANDOM_PORT：启动一个真实的 Web 服务器，并使用随机端口。
   • DEFINED_PORT：启动一个真实的 Web 服务器，并使用定义的端口。
   • NONE：不启动 Web 环境。

   @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
   

3. properties：指定额外的属性，可以覆盖 application.properties 中的配置。

   @SpringBootTest(properties = "app.test=true")
   

4. args：指定应用程序启动参数。

   @SpringBootTest(args = "--app.test=true")
   

使用场景

1. 集成测试：测试整个应用程序的各个组件是否能正常协同工作。
2. Web 环境测试：测试 Web 层（Controller）是否能正确处理请求和响应。
3. 数据库测试：测试数据访问层（Repository）是否能正确操作数据库。

示例

基本集成测试

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

@SpringBootTest
public class MyApplicationTests {

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

使用随机端口进行 Web 测试

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.server.LocalServerPort;

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class MyWebTests {

    @LocalServerPort
    private int port;

    @Autowired
    private TestRestTemplate restTemplate;

    @Test
    public void exampleTest() {
        String body = this.restTemplate.getForObject("http://localhost:" + port + "/", String.class);
        // 断言和验证
    }
}

使用自定义属性

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

@SpringBootTest(properties = "app.test=true")
public class MyPropertyTests {

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

使用自定义配置类

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

@SpringBootTest(classes = MyConfiguration.class)
public class MyCustomConfigTests {

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

总结

@SpringBootTest 注解是 Spring Boot 提供的一个强大工具，用于编写集成测试。通过合理使用其属性和配置，你可以轻松地对应用程序的各个组件进行全面的测试。无论是基本的集成测试、Web 环境测试还是数据库测试，@SpringBootTest 都能满足你的需求。