最佳单元测试实践

title: 最佳单元测试实践
date: 2021/09/08 15:11

注：本文使用的是 SpringBootTest2.x + Junit4 + Mockito，本文的前提是你已经会使用这些工具了。

引言：常见单元测试方法

@RunWith(SpringRunner.class)    
@SpringBootTest(classes = Application.class)    // 1
@Transactional  // 2
@Rollback
public class HelloServiceTest {

    @Autowired
    private HelloService helloService;

    @Test
    public void sayHello() {
        helloService.sayHello("zhangsan");  // 3
    }
}

这样的写法不符合规范的地方如下：

使用 @SpringBootTest注解将主启动类 Application 的 BeanDefintion 加入到了 Spring 容器中，从而加载了所有的 Bean，导致大量的时间耗费在于容器启动上。而且，如果被 @Component 注解的类里有多线程方法，那么在你执行单元测试的时候，由于多线程任务的影响，就可能对你的数据库造成了数据修改，即使你使用了事务回滚注解 @Transactional。

eg. 在我运行单元测试的时候，代码里的其他类的多线程中不停接收activeMQ消息，然后更新数据库中对应的数据。跟单元测试的执行过程交叉重叠，导致单元测试失败。其他组员在操作数据库的时候，也因为我无意中带起的多线程更改了数据库，造成了开发上的困难。

单元测试应与数据库完全隔离（不应受到外界环境的影响，违反了可重复的原则），数据库相关操作应使用 mock 代替。

没有使用断言（assert），无法实现自动化判断。

一、单元测试的原则

1.1 AIR 原则

Automatic（自动化的）：自动通过一系列的断言给出执行结果，而不需要人为去判断，在几十上百的测试用例下很难人为的去判断。
Independent（独立的）：测试用例之间不能相互依赖影响，是独立的
Repeatable（可重复的）：单元测试是可以重复执行的，不能受到外界环境的影响，如数据库、远程调用、中间件等外部依赖不能影响测试用例的执行。

1.2 BCDE 原则

保证被测试模块的交付质量。

B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。
C：Correct，正确的输入，并得到预期的结果。
D：Design，与设计文档相结合，来编写单元测试。
E：Error，强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。

1.3 使用 Mock 对象

Mock 可以用来解除外部服务依赖，从而保证了测试用例的独立性
Mock 可以减少全链路测试数据准备，从而提高了编写测试用例的速度

传统的集成测试，需要准备全链路的测试数据，可能某些环节并不是你所熟悉的。最后，耗费了大量的时间和经历，并不一定得到你想要的结果。现在的单元测试，只需要模拟上游的输入数据，并验证给下游的输出数据，编写测试用例并进行测试的速度可以提高很多倍。
Mock可以模拟一些非正常的流程，从而保证了测试用例的代码覆盖率

根据单元测试的BCDE原则，需要进行边界值测试（Border）和强制错误信息输入（Error），这样有助于覆盖整个代码逻辑。在实际系统中，很难去构造这些边界值，也能难去触发这些错误信息。而 Mock 从根本上解决了这个问题：想要什么样的边界值，只需要进行Mock；想要什么样的错误信息，也只需要进行Mock。
Mock可以不用加载项目环境配置，从而保证了测试用例的执行速度
在进行集成测试时，我们需要加载项目的所有环境配置，启动项目依赖的所有服务接口。往往执行一个测试用例，需要几分钟乃至几十分钟。采用Mock实现的测试用例，不用加载项目环境配置，也不依赖其它服务接口，执行速度往往在几秒之内，大大地提高了单元测试的执行速度。

什么是集成测试？

集成测试是指在单元测试的基础上，将所有模块（或单元）按照设计要求（如根据结构图）组装成为子系统或系统，进行集成测试。

实践表明，一些模块虽然能够单独地工作，但并不能保证连接起来也能正常的工作。一些局部反映不出来的问题，在全局上很可能暴露出来。

由于集成测试的单位是一整个系统，一般有专业的测试人员来进行，本文只做简单介绍，不继续探讨。

二、最佳实践

写好单元测试，以下两点尤为重要：

使用 Mock 脱离数据库
不使用@SpringBootTest注解加载全部 BeanDefinition，转而使用@ContextConfiguration注解加载需要的配置类

2.1 使用 Mock 代替数据库

mockito 为 Junit 提供了MockitoJUnitRunner用于解析单元类中 mockito 相关注解。当然使用 SpringRunner 也行，因为他内置了 MockitoTestExecutionListener 来处理 mockito 的注解。

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;

import java.util.Arrays;
import java.util.List;

@RunWith(MockitoJUnitRunner.class)
// 使用 SpringRunner 也行，因为他内置了 MockitoTestExecutionListener 来处理 mockito 的注解
// @RunWith(SpringRunner.class)
public class MockitoTest {

    /**
     * 如 UserService 是接口，则需 new 出他的实现类，如下：
     *
     * <pre> {@code
     * @InjectMocks
     * private UserService userService = new UserServiceImpl();
     * }</pre>
     * 
     * 否则使用 @InjectMocks 注解无法注入
     */
    @InjectMocks
    private UserService userService;

    @Mock
    private UserRepository userRepository;

    @Test
    public void test() {

        // 模拟依赖方法
        Mockito.when(userRepository.findAll())
                .thenReturn(Arrays.asList(new User(1, "zs"), new User(2, "ls")));

        // 调用被测方法
        List<User> users = userService.listAll();

        // 断言方法结果
        Assert.assertEquals(2, users.size());

        // 验证依赖方法
        // 是否只调用了一次 findAll() 方法
        Mockito.verify(userRepository).findAll();
        // 是否与 userRepository 对象再无交互
        Mockito.verifyNoMoreInteractions(userRepository);
    }
}

注：如对象较大，则可在类路径下存放 json 文件，通过 Json 工具将其序列化成对象。

Junit5 版，注意 Test 注解的包名与上面不同

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.jupiter.MockitoExtension;

import java.util.Arrays;
import java.util.List;

@ExtendWith(MockitoExtension.class)
//@ExtendWith(SpringExtension.class)
public class MockitoTest {

    @InjectMocks
    private UserService userService;

    @Mock
    private UserRepository userRepository;

    @Test
    public void test() {
        
        // 模拟依赖方法
        Mockito.when(userRepository.findAll())
                .thenReturn(Arrays.asList(new User(1, "zs"), new User(2, "ls")));

        // 调用被测方法
        List<User> users = userService.listAll();
        
        // 断言方法结果
        Assertions.assertEquals(2, users.size());

        // 验证依赖方法
        // 是否只调用了一次 findAll() 方法
        Mockito.verify(userRepository).findAll();
        // 是否与 userRepository 对象再无交互
        Mockito.verifyNoMoreInteractions(userRepository);
    }
}

如果一个方法的调用链路如下：Controller -> Service -> Repo，那么应该将其拆分成两个单元来测试：

TestController + mockService

TestService -> mockRepo

如果在测试Controller 的时 mock 了Repo（TestController + @Autowired Service + mockRepo），这样这就不能叫做单元测试了。

单元测试只保证每个单元能够单独地工作，但并不能保证连接起来也能正常的工作；上面这种多个跨了多个单元的应该使用集成测试。

2.2 只加载需要的 Bean

上面的写法只适用于不使用 Spring 给我们提供的功能情况下，但往往有的时候我们需要他们给我们提供的功能，就比如通过@Async注解启动异步任务。那么这种情况我们要怎样做单元测试呢？让我们回到没有 SpringBoot 的时代，看看 Spring Test 是怎样进行单元测试的。

Spring Test 为我们提供了@ContextConfiguration注解，该注解可以加载 Spring 的 xml 配置文件和配置类，使用方式如下：

被测试 bean：

@Component
public class AsyncService {

    private static final Logger log = LoggerFactory.getLogger(AsyncService.class);

    @Autowired
    private FeginClient feginClient;

    @Async
    public Future<Integer> startTask(String taskInstanceId) {
        log.info("taskInstanceId：「{}」", taskInstanceId);
        return new AsyncResult<>(feginClient.calc(taskInstanceId));
    }
}

单元测试：

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.concurrent.ExecutionException;

@RunWith(SpringRunner.class)
// 只引入需要的 bean
@ContextConfiguration(classes = {
        // 被测 bean
        AsyncService.class,
        // 开启异步注解解析
        SpringTest2.AsyncTestConfig.class,
        // 线程池默认的自动配置类，如果自定义了则替换成自定义的配置类
        TaskExecutionAutoConfiguration.class
})
public class SpringTest2 {

    /**
     * 由于需要使用 Spring 提供的异步功能，故需要使用 Spring 提供的 Mock 注解
     */
    @MockBean
    private FeginClient feginClient;

    /**
     * AsyncService 中依赖了 FeginClient，会将上面 mock 的对象进行 DI
     */
    @Autowired
    private AsyncService asyncService;

    @Test
    public void testCalc() throws ExecutionException, InterruptedException {
        // 模拟依赖方法
        Mockito.when(feginClient.calc(ArgumentMatchers.anyString())).thenReturn(1);

        // 调用被测方法
        Integer result = asyncService.startTask("1").get();

        // 断言方法结果
        Assert.assertEquals(1, result.intValue());

        // 验证依赖方法
        Mockito.verify(feginClient).calc(ArgumentMatchers.anyString());
        Mockito.verifyNoMoreInteractions(feginClient);
    }

    @EnableAsync
    @Configuration
    public static class AsyncTestConfig {
    }
}

都写的挺好的，按照顺序看一下：
https://www.cnblogs.com/myitnews/p/12330297.html
https://fanlychie.github.io/post/spring-boot-testing.html
https://blog.51cto.com/codewalker/4375122

单元测试：

spring test & junit
@ContextConfiguration、@RunWith(SpringRunner.class)、@Test

切面测试（启动一部分组件）：

spring-boot-test-autoconfig
@* Test 系列注解

@DataRedisTest：该注解用于测试对Redis操作，自动扫描被@RedisHash描述的类，并配置Spring Data Redis的库。该注解会启动一个内存中的Redis服务器，并使用随机端口进行监听，同时自动配置RedisTemplate和StringRedisTemplate等bean，以便我们可以轻松地执行Redis操作。

@DataJpaTest：该注解用于测试基于JPA的数据库操作，同时提供了TestEntityManager替代JPA的EntityManager。该注解会用嵌入式的数据库（例如H2）创建一个测试环境，同时自动配置EntityManagerFactory、DataSource、TransactionManager等bean，以便我们可以轻松地测试JPA实体和Repository层代码。

@DataJdbcTest：该注解用于测试基于Spring Data JDBC的数据库操作。该注解会用嵌入式的数据库（例如H2）创建一个测试环境，并自动配置JdbcTemplate、NamedParameterJdbcTemplate等bean，以便我们可以轻松地测试JDBC操作。

@JsonTest：该注解用于测试JSON的序列化和反序列化。该注解会自动配置Jackson ObjectMapper bean，并提供了一些辅助方法，方便我们进行JSON序列化和反序列化操作。

@WebMvcTest：该注解用于测试Spring MVC中的controllers。该注解会自动配置MockMvc bean，并提供了一些辅助方法，方便我们进行controller层的测试操作。

@WebFluxTest：该注解用于测试Spring WebFlux中的controllers。该注解会自动配置WebTestClient bean，并提供了一些辅助方法，方便我们进行WebFlux相关的测试操作。

@RestClientTest：该注解用于测试对REST客户端的操作。该注解会自动配置RestTemplate bean，并提供了一些辅助方法，方便我们进行REST客户端相关的测试操作。

@DataLdapTest：该注解用于测试对LDAP的操作。该注解会使用嵌入式的LDAP服务器创建一个测试环境，并自动配置LdapTemplate bean和EmbeddedLdap bean，以便我们可以轻松地测试LDAP操作。

@DataMongoTest：该注解用于测试对MongoDB的操作。该注解会用嵌入式的MongoDB服务器创建一个测试环境，并自动配置MongoTemplate、MongoClient等bean，以便我们可以轻松地测试MongoDB操作。

@DataNeo4jTest：该注解用于测试对Neo4j的操作。该注解会使用嵌入式的Neo4j服务器创建一个测试环境，并自动配置Neo4jTemplate、Neo4jClient等bean，以便我们可以轻松地测试Neo4j操作。

功能测试（启动全部容器）：@SpringBootTest

契约测试：todo

import com.dist.xdata.dgpm.dao.TopicCatalogRepo;
import com.dist.xdata.dgpm.entity.TopicCatalog;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import javax.persistence.EntityManager;
import java.util.List;

/**
 * @author yujx
 * @since 2023/6/13 4:53 PM
 */
@DataJpaTest
@ExtendWith(SpringExtension.class)
public class TestDataJpa {

    @Autowired
    private EntityManager entityManager;

    @Autowired
    private TestEntityManager testEntityManager;

    @Autowired
    private TopicCatalogRepo repo;

    @Test
    public void test() {
        System.out.println("entityManager = " + entityManager);
        System.out.println("testEntityManager = " + testEntityManager);
        
        TopicCatalog save = repo.save(RandomUtil.nextObject(TopicCatalog.class));
        System.out.println("save = " + save);
        List<TopicCatalog> all = repo.findAll();
        System.out.println("all = " + all);
    }
}

https://raw.githubusercontent.com/x54256/pic_home/master/img/202306131738520.png

最后编辑于：2023.06.13 17:40:38

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 212,718评论 6赞 492
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,683评论 3赞 385
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 158,207评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,755评论 1赞 284
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 65,862评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,050评论 1赞 291
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,136评论 3赞 410
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,882评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,330评论 1赞 303
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,651评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,789评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,477评论 4赞 333
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,135评论 3赞 317
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,864评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,099评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,598评论 2赞 362
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,697评论 2赞 351