springboot单元测试技术

整个软件交付过程中，单元测试阶段是一个能够最早发现问题，并且可以重复回归问题的阶段，在单元测试阶段做的测试越充分，软件质量就越能得到保证。具体的代码参照示例项目 https://github.com/qihaiyan/springcamp/tree/main/spring-unit-test

一、概述

一个功能的全链路测试，往往要依赖于很多外部组件，如数据库、redis、kafka、第三方接口等，单元测试的执行环境有可能受网络限制没有办法访问这些外部服务。因此，我们希望通过一些技术手段，能够用单元测试技术进行完整的功能测试，而不依赖于外部服务。

本文已更新：示例代码已从 JUnit 4 迁移到 JUnit 5，并按当前的 Spring Boot 4.x 版本（示例项目使用 Spring Boot 4.1.1）重写。

二、REST接口的测试

springboot的单元测试运行环境的web服务是一个随机端口，是通过下面这个注解指定的：

ini 复制代码

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)

测试时通过@LocalServerPort注入实际的端口号，再通过RestClient发起请求（示例中使用RestClient代替了早期版本常用的TestRestTemplate）。以下是通过RestClient测试我们开发的/remote接口的方法：

csharp 复制代码

@LocalServerPort
    private int port;

    private RestClient restClient;

    @BeforeEach
    void before() {
        restClient = RestClient.builder().baseUrl("http://localhost:" + port).build();
    }

    @Test
    void testRemoteCallRest() {
        String resp = restClient.get().uri("/remote").retrieve().body(String.class);
        System.out.println("remote result : " + resp);
        assertThat(resp, is("{"code": 200}"));
    }

三、第三方接口的依赖

上面的例子中，我们的remote接口会调用一个第三方接口 http://someservice/foo，我们的构建服务器中有可能受网络限制，无法访问这个第三方接口，就会导致单元测试无法执行。我们可以通过springboot提供的 MockRestServiceServer 工具来解决这个问题。

在测试类上增加 @AutoConfigureMockRestServiceServer 注解（由 spring-boot-starter-restclient-test 依赖提供，以gradle配置为例）：

java 复制代码

testImplementation 'org.springframework.boot:spring-boot-starter-restclient-test'
@AutoConfigureMockRestServiceServer

这样就可以直接注入一个绑定到RestClient的MockRestServiceServer变量，不再需要手工bind：

java 复制代码

@Autowired
    private MockRestServiceServer mockRestServiceServer;

在单元测试的初始化阶段设置期望返回值（初始化方法已改为JUnit 5的 @BeforeEach）：

less 复制代码

@BeforeEach
    void before() {
        this.mockRestServiceServer.expect(manyTimes(), MockRestRequestMatchers.requestTo(Matchers.startsWithIgnoringCase("http://someservice/foo")))
                .andRespond(withSuccess("{"code": 200}", MediaType.APPLICATION_JSON));
    }

这样，当我们的单元测试程序中调用http://someservice/foo接口时，就会固定返回{"code": 200}这个返回值，而不是真正的去访问这个第三方接口。

四、数据库的依赖

数据库的依赖比较简单，直接使用h2这个嵌入式数据库就可以，所有的数据库操作都是在h2这个嵌入式数据库中执行的。

已gradle配置为例：

arduino 复制代码

testImplementation 'com.h2database:h2'

单元测试配置文件中的数据库连接使用h2（注意配置键是 spring.datasource.*，而不是 spring.data.*）:

yaml 复制代码

spring:
  datasource:
    url: jdbc:h2:mem:ut;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
    username: sa
    password:

单元测试程序中可以直接进行数据库操作：

ini 复制代码

MyDomain myDomain = new MyDomain();
myDomain.setName("test");
myDomain = myDomainRepository.save(myDomain);

当我们调用接口查询数据库中的记录时，能够正确查询到结果：

scss 复制代码

MyDomain resp = restClient.get().uri("/db?id=" + myDomain.getId()).retrieve().body(MyDomain.class);
System.out.println("db result : " + resp);
assertThat(resp.getName(), is("test"));

当接口返回Page分页数据时，需要做一点特殊处理，否则会报json序列化错误。

定义自己的Page类：

less 复制代码

public class TestRestResponsePage<T> extends PageImpl<T> {
    @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
    public TestRestResponsePage(@JsonProperty("content") List<T> content,
                                @JsonProperty("number") int number,
                                @JsonProperty("size") int size,
                                @JsonProperty("pageable") JsonNode pageable,
                                @JsonProperty("empty") boolean empty,
                                @JsonProperty("sort") JsonNode sort,
                                @JsonProperty("first") boolean first,
                                @JsonProperty("totalElements") long totalElements,
                                @JsonProperty("totalPages") int totalPages,
                                @JsonProperty("numberOfElements") int numberOfElements) {

        super(content, PageRequest.of(number, size), totalElements);
    }

    public TestRestResponsePage(List<T> content) {
        super(content);
    }

    public TestRestResponsePage() {
        super(new ArrayList<>());
    }
}

调用接口返回自定义的Page类：

scss 复制代码

ResponseEntity<TestRestResponsePage<MyDomain>> pageResp = restClient.get().uri("/dbpage").retrieve().toEntity(new ParameterizedTypeReference<TestRestResponsePage<MyDomain>>() {
    });
System.out.println("dbpage result : " + pageResp);
assertThat(pageResp.getBody().getTotalElements(), is(1L));

由于返回结果是泛型，需要使用toEntity方法并传入ParameterizedTypeReference，body方法不支持返回泛型。

五、redis的依赖

网上有一个开源的redis mockserver，模仿了大部分的redis指令，我们只需要引入这个redis-mockserver即可。最初版本是一个国人开发的，示例中引入的是老外fork的一个版本，补充了一些指令，但是找不到源码了，我又fork了一个版本，补充了setex、zscore两个指令，有需要的可以自己编译。代码连接 https://github.com/qihaiyan/redis-mock

已gradle配置为例：

arduino 复制代码

testImplementation 'com.github.fppt:jedis-mock:1.1.8'

单元测试配置文件中的redis连接（Spring Boot 3.0起配置键已从 spring.redis.* 迁移到 spring.data.redis.*）:

yaml 复制代码

spring:
  data:
    redis:
      port: 10033

增加一个单独的redis配置文件，用于在单元测试中启动redis mockserver，并在测试类上通过 @Import(TestRedisConfiguration.class) 引入该配置：

java 复制代码

@TestConfiguration
public class TestRedisConfiguration {

    private final RedisServer redisServer;

    public TestRedisConfiguration(@Value("${spring.data.redis.port}") final int redisPort) {
        redisServer = RedisServer.newRedisServer(redisPort);
    }

    @PostConstruct
    public void postConstruct() throws IOException {
        redisServer.start();
    }

    @PreDestroy
    public void preDestroy() {
        try {
            redisServer.stop();
        } catch (IOException ignored) {

        }
    }
}

六、kafka的依赖

spring提供了一个kafka的测试组件，可以在单元测试期间启动一个嵌入式的kafka服务EmbeddedKafka，模拟真实的kafka操作。

以gradle配置为例：

arduino 复制代码

testImplementation "org.springframework.kafka:spring-kafka-test"

Spring Kafka 4.x已移除 EmbeddedKafkaRule，通过 @ClassRule 初始化的写法不再可用，改为在测试类上使用 @EmbeddedKafka 注解，有两个topic: testEmbeddedIn 和 testEmbeddedOut 。

less 复制代码

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@DirtiesContext
@EmbeddedKafka(
        count = 1,
        controlledShutdown = true,
        topics = { "testEmbeddedIn", "testEmbeddedOut" }
)
class DemoApplicationTest {

注入 EmbeddedKafkaBroker，并通过 @DynamicPropertySource 将嵌入式broker的地址设置给spring cloud stream的kafka binder（@EmbeddedKafka 会自动设置 spring.kafka.bootstrap-servers 对应的系统属性）：

arduino 复制代码

private static final String INPUT_TOPIC = "testEmbeddedIn";
    private static final String OUTPUT_TOPIC = "testEmbeddedOut";
    private static final String GROUP_NAME = "embeddedKafkaApplication";

    @Autowired
    private EmbeddedKafkaBroker embeddedKafka;

    private KafkaTemplate<String, String> kafkaTemplate;

    private Consumer<String, String> consumer;

    @DynamicPropertySource
    static void kafkaProperties(DynamicPropertyRegistry registry) {
        registry.add("spring.cloud.stream.kafka.binder.brokers", () -> System.getProperty(EmbeddedKafkaBroker.SPRING_EMBEDDED_KAFKA_BROKERS));
    }

kafkaTemplate和consumer的初始化从 @BeforeClass 改到了JUnit 5的 @BeforeEach 中，并在 @AfterEach 中关闭consumer：

typescript 复制代码

@BeforeEach
    void before() {
        Map<String, Object> senderProps = KafkaTestUtils.producerProps(embeddedKafka);
        DefaultKafkaProducerFactory<String, String> pf = new DefaultKafkaProducerFactory<>(senderProps);
        kafkaTemplate = new KafkaTemplate<>(pf, true);

        Map<String, Object> consumerProps = KafkaTestUtils.consumerProps(GROUP_NAME, "false", embeddedKafka);
        DefaultKafkaConsumerFactory<String, String> cf = new DefaultKafkaConsumerFactory<>(consumerProps);
        consumer = cf.createConsumer();
        embeddedKafka.consumeFromAnEmbeddedTopic(consumer, OUTPUT_TOPIC);
    }

    @AfterEach
    void tearDown() {
        if (consumer != null) {
            consumer.close();
        }
    }

在单元测试程序的配置文件中，可以指定这2个kafka的topic

yaml 复制代码

spring:
  cloud.stream.bindings:
    handle-out-0.destination: testEmbeddedOut
    handle-in-0.destination: testEmbeddedIn
    handle-in-0.group: embeddedKafkaApplication

七、测试时修改配置属性

执行测试逻辑时，会遇到需要临时修改一个配置项的值，但是配置文件的内容无法在单元测试执行期间修改，这种情况可以通过 ReflectionTestUtils 处理。

正式代码中有一个配置项：

yaml 复制代码

common:
  value: origin

该配置项在MyService中通过属性 originValue 进行引用：

kotlin 复制代码

@Value("${common.value}")
    private String originValue;

在执行某个单元测试时期望将该配置项属性修改为 test:

arduino 复制代码

ReflectionTestUtils.setField(myService, "originValue", "test");