SpringBoot 实战：JUnit5+MockMvc+Mockito 做好单元测试

该图片由NickyPe在Pixabay上发布

你好，我是看山。

今天聊聊如何在 SpringBoot 中集成 Junit5、MockMvc、Mocktio。Junit5 是在 Java 栈中应用最广的测试框架，Junit4 一度霸榜。

升级到 Junit5 之后，除了增加 Java8 的很多特性，做了很多功能增强，在结构上做了优化调整，拆分了很多不同的模块，可以按需引入，比如：

JUnit Platform - 在 JVM 上启动测试框架
JUnit Jupiter - 在 JUnit5 中编写测试和扩展
JUnit Vintage - 提供运行基于 JUnit3 和 JUnit4 的测试引擎

从 SpringBoot 2.2.0 之后，Junit5 已经成为了默认的 Junit 版本。有了 JUnit Vintage，从 Junit4 迁移到 Junit5 的成本极低。所以本文就直接针对 Junit5 开始了。

版本

先说版本，是为了避免因为版本差异出现各种奇怪的问题：

JDK：jdk8（小版本可以忽略）
SpringBoot：2.5.2 - 继承spring-boot-starter-parent- 依赖spring-boot-starter-web- 依赖spring-boot-starter-test
JUnit：5.7.2
Mockito：3.9.0
hamcrest：2.2

SpringBoot 的好处在于，只要继承

spring-boot-starter-parent

或引入

spring-boot-pom-dependencies

，然后添加

spring-boot-starter-test

依赖即可。定义的 POM 内容如下：

<?xml version="1.0" encoding="UTF-8"?><projectxmlns="http://maven.apache.org/POM/4.0.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.5.2</version></parent><groupId>cn.howardliu.effective.spring</groupId><artifactId>springboot-junit5-mockito</artifactId><version>0.0.1-SNAPSHOT</version><name>springboot-junit5-mockio</name><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><optional>true</optional></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

因为继承了

spring-boot-starter-parent

，所以我们依赖的

spring-boot-starter-test

不需要写具体的版本，可以直接集成父级的版本定义。其中，

spring-boot-starter-web

是用于提供 REST API 的 web 容器，

spring-boot-starter-test

可以提供各种测试框架的，

spring-boot-maven-plugin

是将 SpringBoot 应用打包为可执行 jar 的插件。

项目结构

因为是 DEMO 示例，我们实现一个 Echo 接口，能够接收请求参数，并返回加工后的字符串。按照惯例，我们使用万能的

Hello, World!

。

我们的项目结构如下：

├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── cn
    │   │       └── howardliu
    │   │           └── effective
    │   │               └── spring
    │   │                   └── springbootjunit5mockio
    │   │                       ├── SpringbootJunit5MockioApplication.java
    │   │                       ├── controller
    │   │                       │   └── EchoController.java
    │   │                       └── service
    │   │                           ├── EchoService.java
    │   │                           └── impl
    │   │                               └── EchoServiceImpl.java
    │   └── resources
    │       └── application.yaml
    └── test
        └── java
            └── cn
                └── howardliu
                    └── effective
                        └── spring
                            └── springbootjunit5mockio
                                └── controller
                                    ├── EchoControllerMockTest.java
                                    └── EchoControllerNoMockitoTest.java

SpringbootJunit5MockioApplication：SpringBoot 应用启动入口
EchoController：接口定义
EchoService：实现业务逻辑接口
EchoServiceImpl：接口实现
EchoControllerMockTest：使用 Mock 代理 EchoService 实现
EchoControllerNoMockitoTest：直接测试接口实现

EchoServiceImpl

我们看下

EchoService

的实现，这将是我们 DEMO 的核心实现：

@ServicepublicclassEchoServiceImplimplementsEchoService{@OverridepublicStringecho(String foo){return"Hello, "+ foo;}}

EchoControllerNoMockitoTest

我们先使用 Junit5+MockMvc 实现 Controller 接口的普通调用，代码如下：

@SpringBootTest(classes =SpringbootJunit5MockioApplication.class)@AutoConfigureMockMvcclassEchoControllerNoMockitoTest{@AutowiredprivateMockMvc mockMvc;@Testvoidecho()throwsException{finalString result = mockMvc.perform(MockMvcRequestBuilders.get("/echo/").param("name","看山")).andExpect(MockMvcResultMatchers.status().isOk()).andDo(MockMvcResultHandlers.print()).andReturn().getResponse().getContentAsString(StandardCharsets.UTF_8);Assertions.assertEquals("Hello, 看山", result);}}

我们通过

SpringBootTest

注解定义这是一个 SpringBoot 应用的测试用例，然后通过

AutoConfigureMockMvc

启动测试容器。这样，就可以直接注入

MockMvc

实例测试 Controller 接口。

这里需要注意一点，网上很多教程会让写

@ExtendWith({SpringExtension.class})

这样一个注解，其实完全没有必要。通过源码我们可以知道，

SpringBootTest

注解已经添加了

ExtendWith

。

EchoControllerMockTest

这个测试用例中，我们通过 Mockito 组件代理

EchoService

的

echo

方法，代码如下：

@SpringBootTest(classes =SpringbootJunit5MockioApplication.class)@ExtendWith(MockitoExtension.class)@AutoConfigureMockMvcclassEchoControllerMockTest{@AutowiredprivateMockMvc mockMvc;@MockBeanprivateEchoService echoService;@BeforeEachvoidsetUp(){Mockito.when(echoService.echo(Mockito.any())).thenReturn("看山说："+System.currentTimeMillis());}@Testvoidecho()throwsException{finalString result = mockMvc.perform(MockMvcRequestBuilders.get("/echo/").param("name","看山的小屋")).andExpect(MockMvcResultMatchers.status().isOk()).andDo(MockMvcResultHandlers.print()).andReturn().getResponse().getContentAsString(StandardCharsets.UTF_8);Assertions.assertTrue(result.startsWith("看山"));}}

在这个示例中，我们需要注意

@ExtendWith(MockitoExtension.class)

注解，这个注解是用于引入

MockBean

的，我们通过对

echo

方法的拦截，使其返回我们定义好的响应结果。这种方式是为了在多系统或者多功能测试时，不需要真正调用接口。

比如，我们需要获取用户手机号，通常在接口中会校验用户有没有登录，我们就可以使用 Mockito 的能力代理登录验证，使结果永远是 true。

文末总结

至此，我们完成了 SpringBoot 集成 Junit5、MockMvc、Mockito 的示例。想要获取源码，只需要关注公众号「看山的小屋」，回复

spring

即可。

很多同学感觉单元测试没有编写的必要，直接使用 Swagger 或者 Postman 之类的工具就能很好的测试接口。确实如此，对于简单的 CRUD 接口，写单元测试的必要性不太高。但是，如果是复杂接口呢？接口参数有很多的组合，响应结果也需要各种验证，如果使用一次性的工具，每次测试组合参数就已经让人崩溃了，而且组合参数不能存留甚至不能在多人间传承，就会浪费很多的人力。

此时，单元测试的效果就会显现。我们只需要编写一次参数组合，放在 csv 之类的文件中，通过单元测试的参数化测试方式，即可多次运行，验证接口的正确性。

或者，当我们感觉系统已经臭味弥漫，对其重构之后，为了验证接口功能不变，也可以直接使用原来的测试用例加以验证。

综上，虽然测试用例编写麻烦，但是妙用无穷。

SpringBoot 实战：JUnit5+MockMvc+Mockito 做好单元测试

版本

项目结构

EchoServiceImpl

EchoControllerNoMockitoTest

EchoControllerMockTest

文末总结

推荐阅读

发表评论

“SpringBoot 实战：JUnit5+MockMvc+Mockito 做好单元测试”的评论:

关于作者

overfit同步小助手

相关阅读

文章导航