Spring Boot Test 系列1 - 入门

Dear 丶 2022-10-19 12:49 168阅读 0赞

### 文章目录 ###

*  Spring Boot Test 系列1 - 入门
 *   *  前言
     *  创建Spring Boot项目
     *  Spring Boot Starter Test依赖
     *  集成测试
     *   *  集成测试，不启动server
         *  集成测试，启动server
     *  单元测试
     *  后记
     *  参考文档
     *  扩展阅读

# Spring Boot Test 系列1 - 入门 #

## 前言 ##

本文为Spring Boot Test系列的第一篇的入门文章。

工具：

*  Intellij IDEA Ultimate
 *  Spring Boot 2.4.0
 *  JUnit5 (Spring Boot Test 2.4.0默认为JUnit5)
 *  Maven
 *  Java 8+

## 创建Spring Boot项目 ##

在Intellj中使用Spring Initialzr向导创建Spring Boot项目。

选择Spring Boot 2.4，并选择：

*  Developer Toools
    
     *  Spring Boot DevTools
     *  Lombok
 *  Web
    
     *  Spring Web

默认包含了Spring Boot Starter Test模块。

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>

参见：

*  [使用IDEA Community创建Spring Boot项目][IDEA Community_Spring Boot]

## Spring Boot Starter Test依赖 ##

运行`mvn dependency:tree`查看依赖，其中Spring Boot Starter Test的依赖如下：

\- org.springframework.boot:spring-boot-starter-test:jar:2.4.0:test
       +- org.springframework.boot:spring-boot-test:jar:2.4.0:test
       +- org.springframework.boot:spring-boot-test-autoconfigure:jar:2.4.0:test
       +- com.jayway.jsonpath:json-path:jar:2.4.0:test
       |  +- net.minidev:json-smart:jar:2.3:test
       |  |  \- net.minidev:accessors-smart:jar:1.2:test
       |  |     \- org.ow2.asm:asm:jar:5.0.4:test
       |  \- org.slf4j:slf4j-api:jar:1.7.30:compile
       +- jakarta.xml.bind:jakarta.xml.bind-api:jar:2.3.3:test
       |  \- jakarta.activation:jakarta.activation-api:jar:1.2.2:test
       +- org.assertj:assertj-core:jar:3.18.1:test
       +- org.hamcrest:hamcrest:jar:2.2:test
       +- org.junit.jupiter:junit-jupiter:jar:5.7.0:test
       |  +- org.junit.jupiter:junit-jupiter-api:jar:5.7.0:test
       |  |  +- org.apiguardian:apiguardian-api:jar:1.1.0:test
       |  |  +- org.opentest4j:opentest4j:jar:1.2.0:test
       |  |  \- org.junit.platform:junit-platform-commons:jar:1.7.0:test
       |  +- org.junit.jupiter:junit-jupiter-params:jar:5.7.0:test
       |  \- org.junit.jupiter:junit-jupiter-engine:jar:5.7.0:test
       |     \- org.junit.platform:junit-platform-engine:jar:1.7.0:test
       +- org.mockito:mockito-core:jar:3.6.0:test
       |  +- net.bytebuddy:byte-buddy:jar:1.10.18:test
       |  +- net.bytebuddy:byte-buddy-agent:jar:1.10.18:test
       |  \- org.objenesis:objenesis:jar:3.1:test
       +- org.mockito:mockito-junit-jupiter:jar:3.6.0:test
       +- org.skyscreamer:jsonassert:jar:1.5.0:test
       |  \- com.vaadin.external.google:android-json:jar:0.0.20131108.vaadin1:test
       +- org.springframework:spring-core:jar:5.3.1:compile
       |  \- org.springframework:spring-jcl:jar:5.3.1:compile
       +- org.springframework:spring-test:jar:5.3.1:test
       \- org.xmlunit:xmlunit-core:jar:2.7.0:test

Spring Boot Stater Test中包含的依赖有：

*  [JUnit 5][]: Java单元测试框架
 *  [Spring Test][] & Spring Boot Test: Spring Boot的测试工具和支持
 *  [AssertJ][]: 流式断言
 *  [Hamcrest][]: Hamcrest断言
 *  [Mockito][]: Java Mock框架
 *  [JSONassert][]: JSON断言
 *  [JsonPath][]: XPath for JSON.

## 集成测试 ##

### 集成测试，不启动server ###

以创建项目后自动生成的默认测试类为例：

@SpringBootTest
    class TestDemoApplicationTests { 
    
        @Test
        void contextLoads() { 
        }
    
    }

默认无参数的`@SpringBootTest` 注解会加载一个Web Application Context并提供Mock Web Environment，但是不会启动内置的server。

这点从日志中没有打印`Tomcat started on port(s)`可以佐证。

参见：

*  [https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/\#features.testing.spring-boot-applications][https_docs.spring.io_spring-boot_docs_current_reference_htmlsingle_features.testing.spring-boot-applications]

### 集成测试，启动server ###

新建一个测试类如下：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    public class DemoTest { 
    
        @LocalServerPort
        private Integer port;
    
        @Test
        @DisplayName("should access application")
        void shouldAccessApplication() { 
            assertThat(port).isGreaterThan(1024);
        }
    }

指定`@SpringBootTest`的Web Environment为`RANDOM_PORT`。

此时，将会加载Applicaiton Context，并启动server，server侦听在随机端口上。在测试类中通过`@LocalServerPort`获取该端口值。

这点从日志中打印出`Tomcat started on port(s)`可以佐证。

也可以通过指定`@SpringBootTest`的Web Environment为`DEFINED_PORT` 来指定server侦听应用程序配置的端口，默认为8080。不过这种指定端口的方式很少使用，因为如果本地同时启动应用时，会导致端口冲突。

相比不启动server方式，启动server的集成测试用时更长。

参见：

## 单元测试 ##

Spring新手常犯的一个错误就是，在所有的测试中都使用`@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)` 。如果测试类很多，这会明显拖慢整个测速速度，也会导致CI Pipeline慢到无法忍受。

对单元测试来说：

*  如果测试的是非Spring的代码，不需要引入`@SpringBootTest`，直接使用JUnit来测试。
 *  如果测试的是Spring代码
    
     *  可以只引入默认的无参数`@SpringBootTest`，并使用`@MockBean` 来mock要测试的Spring Bean。
     *  或者使用[Spring Boot Test Slices][]来测试指定的Slice（web、database等）

总之，就是要减少测试运行时的依赖，来加快测试运行速度。

## 后记 ##

后面将会单独介绍使用`@SpringBootTest` 作测试的真实例子。

## 参考文档 ##

*  [Spring Boot Testing][]
 *  [Spring Testing][]
 *  [Guide to Testing With the Spring Boot Starter Test][]
 *  [Guide to @SpringBootTest for Spring Boot Integration Tests][Guide to _SpringBootTest for Spring Boot Integration Tests]
 *  [Spring Boot Test Slices: Overview and Usage][Spring Boot Test Slices]
 *  [Spring Boot Unit and Integration Testing Overview][]

## 扩展阅读 ##

*  [How to test a controller in Spring Boot - a practical guide][]

[IDEA Community_Spring Boot]: https://blog.csdn.net/nklinsirui/article/details/104461633
[JUnit 5]: https://junit.org/junit5/
[Spring Test]: https://docs.spring.io/spring-framework/docs/5.3.8/reference/html/testing.html#integration-testing
[AssertJ]: https://assertj.github.io/doc/
[Hamcrest]: https://github.com/hamcrest/JavaHamcrest
[Mockito]: https://site.mockito.org/
[JSONassert]: https://github.com/skyscreamer/JSONassert
[JsonPath]: https://github.com/jayway/JsonPath
[https_docs.spring.io_spring-boot_docs_current_reference_htmlsingle_features.testing.spring-boot-applications]: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.testing.spring-boot-applications
[Spring Boot Test Slices]: https://rieckpil.de/spring-boot-test-slices-overview-and-usage/
[Spring Boot Testing]: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.testing
[Spring Testing]: https://docs.spring.io/spring-framework/docs/5.3.8/reference/html/testing.html#testing
[Guide to Testing With the Spring Boot Starter Test]: https://rieckpil.de/guide-to-testing-with-spring-boot-starter-test/
[Guide to _SpringBootTest for Spring Boot Integration Tests]: https://rieckpil.de/guide-to-springboottest-for-spring-boot-integration-tests/
[Spring Boot Unit and Integration Testing Overview]: https://rieckpil.de/spring-boot-unit-and-integration-testing-overview/
[How to test a controller in Spring Boot - a practical guide]: https://thepracticaldeveloper.com/guide-spring-boot-controller-tests/