Skip to content

Latest commit

 

History

History
605 lines (455 loc) · 56.6 KB

EASY-SPRING-TEST.md

File metadata and controls

605 lines (455 loc) · 56.6 KB

一、背景

最近公司研发团队对于业务系统单元测试的准确率与通过率提出了更高的要求,越来越多的工程开始了提高单元测试覆盖率与准确率的升级改造,但是效果却有些不尽人意,同时也收到了很多同学的抱怨,“单元测试太不稳定了,时好时坏,准确率又很低,写单测不就是浪费时间么,还不如不写呢!”、“我费了很大精力写的单测,从 DEV 环境换到 TEST 环境就不能用了,哎,白写了”、“我的单测刚才运行还成功了呢,但是不知道谁把我的测试数据搞乱了,现在怎么执行都不成功了,真麻烦,属实不想写单测了”,“业务系统的依赖太复杂了,依赖各种各样的中间件,导致写单测的成本太高了,然后写完的单测还不一定有用,收益实在是太低了”,上面那些对单元测试抱怨的话想必每个业务开发同学多多少少都体会过或者抱怨过,那单元测试有这么多的问题,我们到底应不应该继续写呢?这些问题是不是能够找到合适的解决方案呢?

二、问题和方案

2.1 现有单测方案

在分析问题和寻找解决方案之前我们先看看现有的单测方案有哪些

单测方案

测试方式

优点

缺点

方案一:基于 Spring/Spring Boot 的单元测试

使用 SpringRunner 或者@SpringBootTest 注解的方式,启动整个 Spring 容器,然后在测试类中注入待测试类,并对类中的方法进行测试

①测试代码编写简单

②不需要关心 Spring Bean 代码依赖关系

①单测执行速度非常慢

②依赖复杂,加载全部组件,稳定性差

③环境相关性高,准确率低

方案二:脱离 Spring 及其他中间件的单元测试

不启动 Spring 容器,在单测的 Before 方法中直接 new 一个待测试的类的对象实例,然后分析待测试类的依赖关系把所有依赖的本地类都 new 一遍并手动注入

①单测执行速度快

②无复杂依赖,稳定性好

③环境无关,准确率高

①没有成熟的落地方案

②无法进行SQL测试

③测试代码编写非常复杂,需要人工梳理并注入依赖

在介绍这两个单测方案前,先来了解两个概念“集成测试”与“单元测试”,引用下维基百科上对这两个概念的解释,集成测试:又称整合测试、组装测试,即对程序模块采用一次性或增值方式组装起来,对系统的接口进行正确性检验的测试工作。整合测试一般在单元测试之后、系统测试之前进行。实践表明,有时模块虽然可以单独工作,但是并不能保证组装起来也可以同时工作。单元测试:在计算机编程中,单元测试(英语:Unit Testing)又称为模块测试 ,是针对程序模块(软件设计的最小单位)来进行正确性检验的测试工作。程序单元是应用的最小可测试部件。在过程化编程中,一个单元就是单个程序、函数、过程等;对于面向对象编程,最小单元就是方法,包括基类(超类)、抽象类、或者派生类(子类)中的方法。

在了解了“集成测试”与“单元测试”的概念之后,再来看一下上面的两种单测方案,首先是基于 Spring/Spring Boot 的单元测试方案,该方案是现在主流的单测方案,同时我们团队内部也是采用的这种方案,这个方案的特点是启动一个完整的、通过自动扫包机制自动加载所有 Spring Bean 的上下文,优点是不需要手动管理依赖关系,编写测试代码也比较高效,但是缺点也很明显,加载了整个正式运行的 Spring 上下文,导致了与测试单元无关的中间件、内外部依赖等全部都加载并初始化了,不仅执行速度非常慢,而且稳定性还很差,这其实导致了一个严重的问题,它违背了单元测试的独立性、可重复性原则,所以这个方案相较于单元测试,更偏向于对所有组件都进行测试的集成测试的方式。然后是脱离 Spring 及其他中间件的单元测试方案,该方案目前因为没有成熟的落地方案且无法进行 SQL 测试导致覆盖度提升困难且测试代码编写困难等原因并没有被广泛的采用,但是这个方案才是真的符合单元测试原则的。

综上所述,目前两个方案都存在一定的问题,尤其是方案二,虽然理论上头头是道,但是想要真正的应用起来却是阻碍重重,尤其是网上有大量的文章建议使用这种方案,但是却鲜有文章介绍如何落地。现在大家可以考虑下是不是可以有一个方案三,同时吸取前两个方案的优点,又能够解决它们的缺点呢?

2.2 问题与根因分析

在上文了解了集成测试与单元测试的区别与核心思想之后,再来看看目前这两种单元测试方案所面临的问题和解决思路:

单测方案

问题

问题分类

难点&解决思路

基于 Spring/Spring Boot 的单元测试

只想运行一个方法的单元测试,理论上应该非常快就结束了(几秒内),但是现在一次执行却需要60至100秒的时间,甚至有的工程超过了150秒

非最小化测试环境

难点

如何通过最少的单测配置改动或完全不改动的情况下,启动一个独立的最小化的 Spring 容器

解决思路

启动一个关闭了 Spring/Spring Boot 的自动扫包、自动配置等功能的上下文,然后手动引入与待测试部分相关的内容

①单测在 DEV 环境是好使的,但是把同样的单测在 TEST 或其他环境中执行的时候却报错了

②在办公网络下运行单测是好好的,但是回到家后在非办公网络情况下运行单测却怎么也不成功

③在本地跑的单元测试都是通过的,但是用集成工具或发版工具发布编译的时候单元测试结果却都是失败的

环境相关性高

难点

①如何使 Spring 在启动的时候完全不去连接外部的任何组件,关闭 Spring 的自动扫包机制,完全与当前运行单测的环境隔离开

②如何通过简单的易理解的方式梳理待测试单元的所有依赖,并在当前的 Spring 上下文中引入与单测相关的内容

解决思路

通过指定的配置文件启动一个只包含内存数据库的 Spring 上下文,然后梳理待测试单元相关的所有依赖并引入当前 Spring 上下文中,最终构造一个完全不包含任何外部依赖只包含待测试单元相关的本地依赖的环境

只想运行一个简单的测试,不依赖任何外部环境的测试,刚才还好好的,啥也没动,突然就不好用了

依赖复杂度高

脱离 Spring 与其他中间件的单元测试

编写单测难度太高了,需要手动梳理依赖树并手动 new 依赖类的实例然后进行注入,编写效率太低。

单测编写难度高

难点

①脱离了 Spring 环境,在正式代码中的所有 Spring 依赖都需要重新梳理然后手动引入,成本非常高

②现代业务工程和大多数中间件都非常依赖于 Spring 框架,如果脱离 Spring 框架进行单测会导致大部分内容都无法进行测试覆盖,在下一层测试中才能暴露出来

解决思路

启动一个包含 Spring 核心能力的上下文,该上下文可以自动管理并自动注入待测试单元相关的 Bean,同时屏蔽了所有与测试无关的内容,包括外部中间件依赖和内部依赖等

①没有办法进行 SQL 测试,现在的 ORM 框架的使用都是依赖于 Spring 的,脱离 Spring 环境后基本没办法测试。

②单测时的依赖关系是好的,但是运行时却报错了,提示依赖不存在或依赖对象为空。

测试覆盖度低

上表中的单测执行时间,来源于团队内23个工程的单测启动时间的长短分布,平均执行时间为83秒,功能比较少且创建时间比较短的工程一般在60至80秒之间,但是复杂一些的历史工程启动时间大部分都在100秒以上,甚至有部分超过了150秒。

想必大家学习过 Spring 框架后都可以倒背如流的说出 Spring 框架两大特性之一的 IOC(控制反转),控制反转的核心是什么呢?是将工程中的所有依赖都管理在 Spring 中,然后需要的时候向 Spring 容器索取,而随着 Spring 框架的不断迭代更新,使用方式也变成了对用户来说越来越便利的注解加自动扫包的机制,而且 Spring Boot 的项目因为 Spring Boot 的 AutoConfig 机制更加剧了这种情况的产生。这就导致了通常在单元测试启动时默认将一个完整的拥有非常庞大依赖关系的 Spring 容器给启动了,最终使得单元测试又慢又不稳定。

由于大多数业务工程代码都是强依赖 Spring 框架的,代码如果想脱离 Spring 环境进行单元测试需要非常高的改造成本,然后是业务工程连接的组件非常之多,如注册中心、配置中心、Redis、MQ等,在工程启动的时候都要与这些组件建立连接,而本地环境的网络情况和这些外部服务的不稳定还可能会导致连接失败然后进行重试。这就导致了启动单测也不得不启动整个工程,然后还要忍受网络和外部服务的不稳定带来的问题,这么一看是不是单测能够启动起来并且启动时间约等于工程启动时间就很不错了?

而且工程会连接很多外部服务,通常外部服务大概率也都是区分环境的,比如 DEV 环境配置中心配置的某个配置值为 2,但是在 TEST 环境这个值配置为 5 甚至不存在,这无疑是给单测带来了极大的不确定性,同时不同环境中的配置还可能随时被人修改,在这样的情况下想让单测不受影响岂不是及其困难?

2.3 探寻解决方案

现在知道了基于 Spring 环境单元测试低效、不稳定的根源其实是由于 Spring 环境对工程中所有的依赖都进行了自动管理导致的,所以首先要解决的问题就是最小化启动 Spring 容器,这个容器在默认情况下是不会加载任何业务组件的,同时也不能进行自动扫包和自动配置,然后在编写单测的时候根据实际情况按需引入。

对于要执行的单元测试来说可以将整个 Spring 上下文中的内容分为三大部分:待测试部分、不相关部分、依赖但非测试部分,对于这三部分的处理是不同的,首先是加载待测试部分、不加载不相关部分,然后是 Mock 依赖但非测试部分,这样就得到了一个符合环境无关的、测试单元最小化的单元测试,同时它肯定也会表现的稳定与高效。

那为什么要这样划分和处理呢?

首先看待测试部分,这部分通常包括待测试的代码以及编写好的 SQL 等,特点是新编写的准确性待验证的内容,需要用单元测试来做正确性验证,所以是必须加载的部分。

然后是不相关部分,这部分通常包括注册中心、降级限流组件、MQ 组件及其他与单测无关的内部或外部功能,特点是与要执行的单元测试毫不相干,不加载完全不影响单元测试的执行,但是加载过程中可能会出现各种异常问题导致 Spring 容器启动失败,最终导致单元测试失败,所以这部分是坚决不要进行加载的。

最后是依赖但非测试部分,这部分通常包括待测试代码中的 RPC 依赖、配置中心依赖、Redis 依赖、及其他组件 API 依赖,特点是属于待测试代码中的依赖部分,但并不是进行单元测试的目标,而且这些依赖的不同返回值还会影响单元测试的结果,所以对于这部分最好是要进行 Mock 操作的。

三、收益

那么,在解决了上面的问题后可以得到什么样的收益呢?

(1)大幅减少单测执行等待时间,极大的提升研发效率,通常大家在编写代码和单测的时候都是依次编写并执行的,每次执行都将减少60至100秒的等待时间。

(2)单测编写难度降低,覆盖率提升,编写单测时可以依赖 Spring 的部分自动注入能力,降低梳理与重复编写成本,提升单测编写效率。

(3)可以彻底从繁重的无效的单测失败原因排查中解脱出来,无论单测运行在什么环境下都是成功的,失败的原因只可能是代码逻辑故障。

(4)会规避很多与测试单元无关的未知因素的干扰,提升单测稳定性与准确率,一个测试单元有问题一定是这个单元相关的依赖或者自身的问题。

如上,可以发现解决了这些问题后对研发效率、代码纠错等方面的帮助与收益还是非常明显的,无论是从短期还是长期收益来看这些问题都是非常值得去解决的。

四、最佳实践

在上文寻找到了一个解决方案,启动一个最小化的 Spring 上下文,然后加载待测试部分、不加载不相关部分,最后 Mock 依赖但非测试部分。基于这个方案,可以确定单元测试整体流程如下。

第一步:将工程中的所有功能(依赖)按照与单元测试的关系进行三部分的划分

第二步:最小化启动 Spring 单元测试环境,本步骤主要是加载部分待测试依赖(内嵌数据库H2)以及忽略不相关部分依赖的加载

第三步:主动引入待测试部分依赖到本次执行单元测试的 Spring 上下文中

第四步:将待执行单元测试的依赖但是不需要进行测试的部分进行合理 Mock

在实践部分将流程分为上述四步,下面对上述流程进行拆解,并进行实际的落地。

4.1 启动环境无关、最小化的 Spring 单测环境

目前的大多数工程其实都是通过 SQL 与 Mysql 等数据库进行通信的上层应用,由于编写了很多 SQL,而且这些 SQL 也是与我们的业务代码正确与否息息相关的,完全可以当成业务代码的一部分,所以可以肯定的说单测需要对这些 SQL 进行覆盖验证,但是连接一个外部的服务又违背了单测的原则,针对这种情况我们可以引入一个内嵌式的内存数据库,比如我们熟知的 H2。不过其他的大多数中间件其实都是简单的通过 API 的形式进行交互,这部分中间件在单测阶段其实是完全没必要的外部依赖,而且对于这部分 API 的正确性也不是单元测试需要关心的,是属于集成测试的范畴,所以单测中完全可以 Mock 掉它们或者按需引入(按需引入的前提条件是不依赖任何环境即可启动,例如用内嵌数据库 H2 来代替 Mysql,如果想测试 Redis 也可以用类似的思路,引入一个内嵌的 Redis,但是绝不能引入任何的外部 Redis,但是使用 Redis 通常都是直接使用它的 API,所以直接采用 Mock 的方式更便利),最终确定了 Spring 容器启动应该包含的内容:只有数据库相关的部分与待测试依赖部分,下面看一看具体的代码。

首先,需要引入 spring-test 和 spring-boot-test 这两个依赖包

<!-- Spring 环境的单元测试的核心包 -->
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-test</artifactId>
  <version>${当前工程 spring 的版本}</version>
  <scope>test</scope>
</dependency>

<!-- 下文用到的 @Import 功能和 @MockBean、@SpyBean 功能在该包里引入,虽然这是个 Spring Boot 的包,但是普通的 Spring 项目也是可以使用的,没有任何问题 -->
<!-- 这里的版本需要注意下,如果用的是 Spring4.x 的版本,这里要引入 1.5.xx.RELEASE 的版本,推荐使用 1.5.22.RELEASE -->
<!-- 如果用的是 Spring5.1.x 的版本,这里要引入 2.3.xx.RELEASE 的版本,推荐使用 2.3.8.RELEASE -->
<!-- 如果是其他的 Spring 版本,可以再推荐使用的版本上适当的进行加减 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-test</artifactId>
  <version>2.3.8.RELEASE</version>
  <scope>test</scope>
</dependency>

然后就是创建单元测试基类,基于 Testng、Junit4 和 Junit5 的实现方案有些许差别,代码如下:

/**
 * 单元测试基类,基于 Testng
 */
// Spring 容器配置文件,因为是最小化启动,所以只加载 DB 的配置,用 H2 替换 Mysql
@ContextConfiguration("classpath:dataSource.xml")
// 使 @MockBean 和 @SpyBean 注解生效的配置,具体使用方式在4.4小节讲
@TestExecutionListeners(MockitoTestExecutionListener.class)
public abstract class BaseTest extends AbstractTestNGSpringContextTests {
    
}

/**
 * 单元测试基类,基于 Junit4
 */
@RunWith(SpringRunner.class)
@ContextConfiguration(locations = "classpath:dataSource.xml")
// 基于 Junit4 需要添加 MockitoTestExecutionListener.class,DependencyInjectionTestExecutionListener.class 来实现 mock 和依赖注入
@TestExecutionListeners({MockitoTestExecutionListener.class, DependencyInjectionTestExecutionListener.class})
public abstract class BaseTest {

}

/**
 * 单元测试基类,基于Junit5
 */
@ExtendWith(SpringExtension.class)
@ContextConfiguration(locations = "classpath:dataSource.xml")
// 基于 Junit5 需要添加 MockitoTestExecutionListener.class,DependencyInjectionTestExecutionListener.class 来实现 mock 和依赖注入
@TestExecutionListeners({MockitoTestExecutionListener.class, DependencyInjectionTestExecutionListener.class})
public abstract class BaseTest {

}

上面 @ContextConfiguration 注解引入的 dataSource.xml 配置文件如下(如果大家的项目是多数据源的话只需要把所有的表都放在这一个数据源下即可,分库分表亦是如此):

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns="http://www.springframework.org/schema/beans" xmlns:jdbc="http://www.springframework.org/schema/jdbc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/tx
       http://www.springframework.org/schema/tx/spring-tx.xsd
       http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd">

    <jdbc:embedded-database id="h2TestDataSource" type="H2" database-name="xxxDataSource;DATABASE_TO_UPPER=TRUE;MODE=MYSQL;">
        <!-- 这里的 h2/init.sql 是要初始化表结构的文件 -->
        <jdbc:script location="classpath:h2/init.sql"/>
    </jdbc:embedded-database>

    <!--  sqlSessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="h2TestDataSource"/>
        <!-- 配置 Mybatis 配置文件的位置 -->
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <property name="mapperLocations">
            <list>
              <!-- 这里的 value 要替换成真实的 Mybatis 的 Mapper 文件地址 -->
                <value>classpath:mapper/**/*DAO.xml</value>
            </list>
        </property>
    </bean>

    <bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
        <constructor-arg ref="sqlSessionFactory"/>
    </bean>

    <!-- 配置扫描 Mapper 接口的包路径 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.meituan.xxx.dao"/>
        <property name="sqlSessionFactory" ref="sqlSessionFactory"/>
    </bean>

    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"
          p:dataSource-ref="h2TestDataSource"/>

    <tx:annotation-driven />
</beans>

dataSource.xml 配置文件需要放在 test/resources 目录下,在写单测的时候只需要继承上面经过改造后的 BaseTest 类即可。

最后看一下配置好的 test 目录内容如下,其中 datasets、h2/init.sql 是 Database-rider 组件使用的文件,在下面会介绍。

4.2 使用 H2 和 Database-rider 进行 SQL 测试

上文已经提到最小化的单元测试是需要包含数据库的,但是如果引入一个外部的数据库的话,那就违背了单元测试环境无关的原则。所以,要用一个内嵌的数据库来替代外部的数据库,而 H2 就是需要的那个嵌入式数据库。Database-rider 又是什么呢?它其实是一个方便进行 SQL 测试的工具,它提供了数据初始化、数据清理、结果对比等功能。所以 H2 和 Database-rider 的搭配使用,能够使 SQL 测试更加高效便捷的进行。

首先,引入 H2 和 Database-rider 的依赖

<!-- H2 数据库依赖 -->
<dependency>
  <groupId>com.h2database</groupId>
  <artifactId>h2</artifactId>
  <version>2.1.210</version>
  <scope>test</scope>
</dependency>
<!-- Database-rider 依赖 -->
<dependency>
  <groupId>com.github.database-rider</groupId>
  <artifactId>rider-core</artifactId>
  <version>1.32.3</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>com.github.database-rider</groupId>
  <artifactId>rider-spring</artifactId>
  <version>1.32.3</version>
  <scope>test</scope>
</dependency>

然后引入配置

<!-- 这里是 H2 数据库的配置,可以将其当做一个数据源,配置在 dataSource.xml 文件中 -->
<jdbc:embedded-database id="h2TestDataSource" type="H2" database-name="xxxDataSource;DATABASE_TO_UPPER=TRUE;MODE=MYSQL;">
  <!-- 这里的 h2/init.sql 是要初始化表结构的文件,在单元测试启动时会自动将 init.sql 中的 SQL 执行来达到创建表的目的 -->
  <jdbc:script location="classpath:h2/init.sql"/>
</jdbc:embedded-database>

由于批量执行单测时当前虚拟机下只存在一个 H2 实例,但是 Spring 容器每次都是全新的,这就会导致重复建表,所以 init.sql 中的建表语句推荐使用 create table if not exist 语句

下面举一个简单的例子来看一下如何使用

// 这个是注解是 Database-rider 的核心,放在测试类上表示本测试类需要使用 Database-rider 的功能。注意:不可将该注解添加到 BaseTest 上,会导致 DBRider 不生效
@DBRider(dataSourceBeanName = "h2TestDataSource")
// 引入依赖到 Spring 上下文中的核心注解,使用该注解把所有需要加入到 Spring 上下文的 Bean 引入,下文会详细介绍
@Import({ServiceB.class, ServiceA.class})  
public class ServiceATest extends BaseTest {
  
    @Autowired
    private ServiceA serviceA;

    @Test
  	// 这个是注解是用于在单测执行前进行数据初始化的,会根据 xxx.json 中的数据进行初始化,cleanBefore = true 意思是在单测启动前会将 H2 中的所有数据清空,创造一个干净的数据环境
  	@DataSet(value = "datasets/xxx/xxx.json", cleanBefore = true)
  	// 这个是注解是用于在单测执行后对数据库中的数据做比对的,会将 H2 中的数据与 xxx.json 中的数据进行对比,如果不一样则单测执行失败,ignoreCols 表示忽略对比的字段,比如一些随机值
  	@ExpectedDataSet(value = "datasets/xxx/xxx.json", ignoreCols = {"id"})
    public void testServiceA() {
    }
}

由于篇幅有限,本文只介绍简单的使用,关于 H2 和 Database-rider 的更多功能大家可以自行探索。

4.3 使用 Spring 依赖管理简化单测

由于使用最小化的 Spring 环境来启动的单元测试,所以在 Spring 容器中只有与 DAO 相关的 Bean,而其他的所有 Bean 都需要手动引入,这样就得到了一个纯净的、最小化的、按需引入的 Spring 上下文。

先来看一种简单的情况,如果要测试的服务是 ServiceA,该服务依赖关系如下:

ServiceA 依赖 ServiceB 和 ADao

ServiceB 依赖 BDao

代码片段如下:

// ServiceA 代码片段
@Service
public class ServiceA {
    @Autowired
    private ServiceB serviceB;
    @Autowired
    private ADao aDao;
}

// ServiceB 代码片段
@Service
public class ServiceB {
    @Autowired
    private BDao bDao;
}

要对 ServiceA 进行测试,由于 ServiceA 的所有依赖和间接依赖都是本地依赖,没有任何外部依赖,所以可以将其依赖的所有服务都加载到 Spring 上下文中,测试类代码如下:

// 引入依赖到 Spring 上下文中的核心注解,使用该注解把所有需要加入到 Spring 上下文的 Bean 引入
@Import({ServiceB.class, ServiceA.class})
public class ServiceATest extends BaseTest {
    @Autowired
    private ServiceA serviceA;

    @Test
    public void testServiceA() {
    }
}

再来看一个稍微复杂一点的情况,如果要测试的服务还是 ServiceA,该服务依赖关系如下:

ServiceA 依赖 ServiceB 和 ADao

ServiceB 依赖 ServiceC 和 BDao

ServiceC 依赖 ServiceD

ServiceD 没有依赖

可以看到这个例子要比上面的例子的依赖层级要深一些,这里是4层依赖关系(从 ServiceA 为第一层算起),这里虽然比上面的例子要复杂一些,但是解决方案还是一样的,只需要使用 @Import 注解将所有本地依赖全部引入到当前的 Spring 上下文中即可。代码如下:

@Import({ServiceA.class, ServiceB.class, ServiceC.class, ServiceD.class})  // 引入依赖到 Spring 上下文中的核心注解,使用该注解把所有需要加入到 Spring 上下文的 Bean 引入
public class ServiceATest extends BaseTest {
    @Autowired
    private ServiceA serviceA;

    @Test
    public void testServiceA() {
    }
}

在上面这个例子中依赖关系就比较复杂了,需要人工梳理的层级也比较深了,不过通常的依赖层级都是在3到4级左右,依赖的 Bean 也是在10个以内,如果依赖层级、依赖 Bean 太多的话那就要思考一下服务拆分的是否合理,是否满足单一职责原则了。

由于 @Import 注解需要人为梳理 Spring 依赖关系,导致效率比较低,虽然可以帮助大家检查依赖树是否层级太深,但是违背了提效的初衷,所以作者编写了一个简化工具包(easy-spring-test)来简化流程,具体使用细节看第五小节【优化提效】

4.4 使用 Mock 来屏蔽外部依赖

首先,需要引入一个 Spring 官方的 Mock 功能的依赖和 Mockito 的依赖:

<!-- 上文已经提到,这个包提供了 @MockBean、@SpyBean 和 @Import 的功能 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-test</artifactId>
  <version>2.3.8.RELEASE</version>
  <scope>test</scope>
</dependency>

<!-- 这里推荐使用的版本号是 3.8.0,如果出现不兼容的情况可以适当降低版本 -->
<!-- 这里注意下可以选择引入 mockito-core 还是 mockito-inline,这是因为 mockito-core 默认是不支持 mock final类/方法和static方法的 -->
<!-- 所以如果想要 mock final类/方法和static方法需要引入 mockito-inline,大家可以按需引入 -->
<dependency>
  <groupId>org.mockito</groupId>
  <artifactId>mockito-core</artifactId>
  <!-- <artifactId>mockito-inline</artifactId> -->
  <version>3.8.0</version>
  <scope>test</scope>
</dependency>

然后,需要在 BaseTest 上加一个注解 @TestExecutionListeners(..., MockitoTestExecutionListener.class) 即可,在上文中也提到过。

Mock 主要分为两类,下面通过几个例子和大家介绍一下。

第一类:使用 @MockBean 注解进行 Mock,该注解会创建一个所有方法都返回 NULL 的对象来 Mock 原来的对象,适合用来 Mock 外部依赖,然后配合方法打桩来改变原有方法的行为。

举个例子,要测试的服务是 ServiceA 依赖了 ThriftServiceB 的 methodB 方法,ThriftServiceB 是一个外部的 RPC 接口,此时需要 Mock 这个接口来保证单测是环境隔离的,代码如下

// ServiceA 代码片段
@Service
public class ServiceA {
    @Autowired
    private ThriftServiceB thriftServiceB;
  
  public Integer methodA(){
      Param param = new Param();
      Result result = thriftServiceB.methodB(param);
      return result.getData();
    }
}

// 测试类代码
@Import({ServiceA.class})  // 引入依赖到 Spring 上下文中的核心注解,使用该注解把所有需要加入到 Spring 上下文的 Bean 引入
public class ServiceATest extends BaseTest {
    @Autowired
    private ServiceA serviceA;
    // 当加上这段代码之后,当前启动的 Spring 容器中就生成了一个 name = thriftServiceB 的 Mock Bean,
    // 然后该容器中所有的依赖注入 ThriftServiceB 的 Bean 都注入了指定的这个 Mock Bean,此时就可以
    // 使用 Mockito 的打桩来任意修改该 Mock Bean 的方法的行为了,没有修改的行为默认返回 null
    @MockBean(name = "thriftServiceB")
    private ThriftServiceB thriftServiceB; 
  
    @Test
    public void testServiceA() {
        Result result = new Result();
        result.setData(1);
        // 这就是上文所说的打桩(stub),这段代码的意思就是改变 thriftServiceB 这个对象的 methodB 方法的行为,变成想要
        // 的样子,这样在测试 serviceA.methodA() 时,内部调用 thriftServiceB.methodB(param) 的时候就会按照期望的样子进行返回
        // 这个打桩函数的内容有很多,基本大家想用的都可以实现,此处就不一一介绍了,大家感兴趣可以自己查看 API
        Mockito.when(thriftServiceB.methodB(Mockito.any())).thenReturn(result);
      Integer resultData = serviceA.methodA();
      Assert.assertEquals(resultData, 1);
    }
}

第二类:使用 @SpyBean 注解进行 Mock,该注解会创建一个所有方法都调用原方法的 Mock 对象,适合用来 Mock 内部依赖,然后配合方法打桩来改变原有方法的行为。

举个例子,比如想要测试 ServiceA 的 methodA 的事务是否生效,就可以使用该注解来实现,因为想要某一个方法抛出异常,而其他的所有方法都保持原样正常运行,所以可以用 @SpyBean 注解来解决这个问题

被测试类 ServiceA 依赖 DaoA 与 DaoB,DaoA 的 insertA 方法与 DaoB 的 insertB 方法在 ServiceA 的 methodA 方法中,并在一个事务下,代码如下

// ServiceA 代码片段
@Service
public class ServiceA {
    @Autowired
    private DaoA daoA;
    @Autowired
    private DaoB daoB;
  
    @Transaction(rollbackFor = Exception.class)
  public void methodA(){
      A a = new A();
      daoA.insertA(a);
      B b = new B();
      daoB.insertB(b);
    }
}

// 测试类代码
@Import({ServiceA.class})  // 引入依赖到 Spring 上下文中的核心注解,使用该注解把所有需要加入到 Spring 上下文的 Bean 引入
public class ServiceATest extends BaseTest {
    @Autowired
    private ServiceA serviceA;
    // 当加上这段代码之后,当前启动的 Spring 容器中就生成了一个 name = daoB 的 Spy Bean,
    // 然后该容器中所有的依赖注入 daoB 的 Bean 都注入了指定的这个 Spy Bean,此时就可以
    // 使用 Mockito 的打桩来任意修改该 Spy Bean 的方法的行为了,没有修改的行为默认调用原对象的方法
  	// 特别注意一点,动态代理生成的 DaoB 的实现类会默认加上 final 关键字,所以需要引入 mockito-inline 才能实现对 DAO 接口的 mock
    @SpyBean(name = "daoB")
    private DaoB daoB; 
  
    @Test
    public void testServiceA() {
        Result result = new Result();
        result.setData(1);
        // 这里使用 do.when 的方式进行打桩,在上一个例子里用了另一种打桩方式,可以称其为 when.then 的打桩方式,
        // 两种方式的 API 基本一样,但是使用效果有两点区别,下面会详细介绍
        Mockito.doThrow(new RuntimeException("transaction rollback")).when(daoB).insert(Mockito.any());
      try{
          serviceA.methodA();
        } catch (RuntimeException e){
          if (!e.getClass().equals(RuntimeException.class) || Objects.equals(e.getMessage(), "transaction rollback")){
                throw e;
            }
        }
      A a = serviceA.queryAById(1);
      Assert.assertNull(a);
    }
}

在上面的两个例子中使用了两种打桩方式,第一种称之为 when.then 的方式,第二种称之为 do.when 的方式,这两种方式的核心区别在于两点

do.when 不是类型安全的(不会进行编译期返回类型校验,比如使用 doReturn 的时候),这可能带来意想不到的失败

when.then 的方式打桩时会调用一次原方法(在使用 @SpyBean 注解 mock 的对象在打桩时会先执行一次并造成影响,使用 @MockBean 的方式由于没有真实的原方法所以不会造成影响),do.when 的方式打桩的话不会调用原方法

举个例子:上面使用 @SpyBean 来 mock 的 daoB,如果使用 when.then 的方式打桩的话,在执行打桩代码时 daoB.insert() 方法还是会被真实的调用一次,所以可能会产生意想不到的错误,大家可以根据实际情况来选择 Mock 的方式。

由于篇幅有限,本文不再赘述 Mockito 更多的功能,大家可以参考 Mockito官网SpringTest文档 学习更多的 Mock 方法。
同时再简单说一下 Mock 工具的选型,是选择 Jmockit 还是 Mockito 还是其他 Mock 框架?本文推荐使用 Mockito,原因有两点:
①Spring 官方推荐使用的 Mock 框架是 Mockito,同时 Spring 官方仅提供了 Mockito 的 Mock 支持(截稿时最新的 spring-boot-test 版本为2.6.7),所以我们可以非常简单的只用 @MockBean 和 @SpyBean 注解就可以解决非常复杂的 Spring 上下文自动注入 Mock 对象的问题,如果要使用 Jmockit 或其他 Mock 框架那就得自己来实现这个能力。
②Mockito 的社区活跃度远超 Jmockit 等其他 Mock 框架,开源项目一个重要的指标就是社区活跃度,社区活跃说明关注的人多,随之带来的就是有问题能够更快速的响应和修复,这对使用方的选型来说是一个非常关键的点

4.5 常用中间件在单测中的处理方案

上文介绍了如何最小化启动 Spring 环境,引入 H2 对 SQL 进行测试,以及如何使用 Mock 框架来对单测进行优化,有的同学就有疑问了,那代码中依赖的其他组件怎么办呢?其实在上文在探索解决方案部分就进行了简单的介绍了,其他部分需要根据实际情况进行 Mock 或者忽略,核心思路为需要进行测试的部分引入内嵌版本替代(不能依赖外部组件)、不需要测试但是单测代码依赖的组件进行 Mock,不相关部分忽略。下表中我对常见的组件的处理方案进行了总结。

组件

方案

说明

注册中心

不加载

单测不会真正进行 RPC 调用,所以注册中心对于单测也就没有什么意义了。

配置中心

Mock

由于配置中心中的值可能因为环境的不同而不同,还可能随时被人修改,通常也是通过 API 的方式来调用,所以推荐使用 Mock 进行替代。

Redis

Mock

Redis 通常的使用方案为 Java Client API 的方式,由于 API 的正确性是不需要单测代码来验证的,所以完全可以使用 Mock 来替代。

当然也存在部分 Lua 脚本的使用形式,这种情况可以使用内嵌 Redis 来解决,类似于 H2 的形式,但是由于当前没有成熟的内嵌 Redis 可用,所以不太推荐使用这种方案。

MQ

不加载/Mock

MQ消息是否能接收到,或者消息是否能发出去,这都数据集成测试的范畴,单元测试只关注生产者和消费者代码的逻辑正确性。

定时任务

不加载

定时任务是否能够触发执行,同样是属于集成测试的范畴,单元测试只关注被触发的代码的正确性。

Zookeeper

Mock

与 Redis 类似,完全可以使用 Mock 替代。

分布式锁

Mock

分布式锁是否可用,同样属于集成测试范畴,可以使用 Mock 进行模拟。

限流降级

不加载/Mock

属于集成测试范畴,可以不进行加载,或者使用 Mock 进行模拟。

还有很多常用工具或者组件,就不在这里进行一一罗列了,大家可以根据实际情况进行不加载或者 Mock 模拟的抉择。

4.6 历史工程单测迁移至新方案

如果是一个全新的工程的话那肯定不用多说了,强烈推荐使用这种方案进行单元测试,一定可以刷新对 Java Spring 环境单元测试的认识,同时大幅提升开发效率、稳定性与准确性。

如果是历史项目呢?那其实是有一定的改造成本的,因为需要为每个单元测试划清边界,要找到他的依赖树然后将待测试依赖部分使用 @Import 引入,依赖但非测试部分使用 @MockBean 进行 Mock,所以我推荐大家慢慢的迭代迁移。比如做某个项目的时候要修改或者新增某个 Service 的单测,这时候就可以使用上文讲到的方案对该测试对象进行改造,可以增加一个新的和上面 BaseTest 代码一样的单测基类,然后逐步改造,这样成本最低,做起来也更容易完成。

五、优化提效

上文中的单元测试方案在本团队内部推广后大家纷纷表示在稳定性和测试效率上得到了大幅的提升,但是仍然存在编写效率较低的问题,主要问题在使用 @Import 注解需要人为梳理依赖树,稍微复杂一些的 Service 可能需要在注解中引入十几个类,既不美观效率又十分低下,这成为了大家使用这种单测方案的一大阻碍,针对该问题进行分析后发现这个编写成本是完全可以优化的,但是在现有的测试框架和 Spring 框架都没有针对这个问题的解决方案,所以为了扫除大家的使用障碍,持续提高单测效率,开发了一个名为 easy-spring-test 的工具,通过使用 @AutoImport 注解来替代 @Import,该注解会自动索引待测试类的 Spring Bean 依赖树,然后自动将对应的 Bean 注册到当前的 Spring 容器中。使用方式也十分简单:

首先,引入依赖包

<dependency>
  <groupId>io.github.bigwg</groupId>
  <artifactId>easy-spring-test</artifactId>
  <version>1.2.3</version>
  <scope>test</scope>
</dependency>

然后使用 @AutoImport 注解替代 @Import 注解即可,举个例子

/**
* 待测试的 service 类是 XxxService 但是由于该类依赖或间接依赖了很多其他 service,所以需要手动梳理依赖的 Spring Bean 并引入上下文中,流程比较繁琐,导致易用性降低
**/
@Import({XxxService.class, XxxAService.class, XxxBService.class, XxxCService.class, XxxDService.class, XxxEService.class})
public class XxxServiceTest extends BaseTest {
  // 注入待测试的 service
    @Autowired
    private XxxService xxxService;
}

/**
* 使用方式(1):普通 Spring Bean 注入
* 使用 @AutoImport 替代后,仅需要 XxxService 即可,@AutoImport 注解会自动检索依赖树,然后将依赖的 Spring Bean 引入上下文中
**/
@AutoImport({XxxService.class})
public class XxxServiceTest extends BaseTest {
    // 注入待测试的 service
    @Autowired
    private XxxService xxxService;
}

/**
* 使用方式(2):集合 Spring Bean 注入
* 工程中常有使用 @Autowired 注解注入 Spring Bean 集合的情况,这种情况需要配合扫包使用,使用方式如下
**/
package com.xxx.xx1;
public class XxxServiceImpl implements ServiceI {
		@Override
  	public String hello(){
    		return "Hello World";
    }
}
public class XxxService {
		@Autowired
  	private List<ServiceI> services;
  	@Autowired
  	private Map<String, ServiceI> serviceMap;
}  
@AutoImport(value = {XxxService.class}, scanBasePackages = {"com.xxx.xx1", "com.xxx.xx2"})
public class XxxServiceTest extends BaseTest {
    // 注入待测试的 service,同时 ServiceI 的所有实现类都在 com.xxx.xx1 和 com.xxx.xx2 包下
    @Autowired
    private XxxService xxxService;
}

/**
* 使用方式(3):接口 Spring Bean 注入
* 工程中常有使用 @Autowired 注解注入 Spring Bean 对应的接口的情况,这种情况需要配合扫包使用,使用方式如下
**/
package com.xxx.xx1;
public class XxxServiceImpl implements ServiceI {
		@Override
  	public String hello(){
    		return "Hello World";
    }
}  
@AutoImport(value = {ServiceI.class}, scanBasePackages = {"com.xxx.xx1", "com.xxx.xx2"})
public class XxxServiceTest extends BaseTest {
    // 注入待测试的 service 接口,需要保证 ServiceI 的所有实现类都在 com.xxx.xx1 和 com.xxx.xx2 包下
  	// 有多个实现类时可以使用 @Resource 或 @Autowired 搭配 @Qualifier 进行注入
    @Autowired
    private ServiceI xxxService;
}

六、总结

业务系统在依赖 Spring 这种工业级框架的情况下写好真正的“单元测试”是非常困难的,但也不是没有解决方案,只要把握住在 Spring 环境下写好单元测试的几点要素即可:

(1)遵循单元测试环境无关、测试单元最小化原则

(2)使用 H2 和 Database-rider 替代数据库进行 SQL 测试

(3)对本单元测试无关的功能禁止加载到 Spring 上下文中

(4)Spring 上下文中只包含待测试且依赖的部分内容

(5)对本单元测试依赖的但是属于不需要测试的部分进行 Mock

单元测试是软件开发生命周期中非常重要的一环,如果能够写出高效且稳定的单元测试,那无疑是对软件质量保障的一大利器,同时写好单元测试也是开发人员必须掌握的基本功。希望我们研发团队在如何提高基于 Spring 环境单元测试的效率、稳定性与准确率的探索与实践,能够在构建高效稳定的单元测试上为大家提供帮助。

七、参考资料

[1]Mockito 官网

[2]H2DB Github

[3]Database-rider Github

[4]Spring Boot Test官方文档

[5]Maven Surefire 插件官方文档

[6]Mockito: doReturn vs thenReturn

[7]Springboot单元测试:SpyBean vs MockBean

[8]Github issue: AttachNotSupportedException: no providers installed