SpringBoot下测试框架的入门总结

最新推荐文章于 2025-02-03 22:26:00 发布

TimeMagician

最新推荐文章于 2025-02-03 22:26:00 发布

阅读量528

点赞数

CC 4.0 BY-SA版权

分类专栏： Spring 文章标签：单元测试

本文链接：https://blog.csdn.net/TimeMagician/article/details/108154488

Spring 专栏收录该内容

3 篇文章

订阅专栏

本文详细介绍了JUnit测试框架，包括JUnitCore、Assert、TestCase等核心概念，并深入讲解了Spring Boot 2.x之前的JUnit 4框架，如@RunWith、@Test系列注解以及@ContextConfiguration等。同时，文章探讨了Spring Boot 2.x后JUnit 5的变化，并讨论了Mock机制及其在测试中的应用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

测试框架JUnit

JUnit 是一个 Java 编程语言的单元测试框架。JUnit 在测试驱动的开发方面有很重要的发展，是起源于 JUnit 的一个统称为 xUnit 的单元测试框架之一。

JUnit框架下的常用类有：JUnitCore,Assert,TestCase,TestResult,TestSuite，@Test

本节参考

jUnit 教程

JUnitCore

用于运行测试代码，类似main函数。Result result = JUnitCore.runClasses(TestJunit.class);

Assert

断言，用于做条件判断，内含大量的静态方法可以使用，如：assertEquals(message,messageUtil.printMessage());

TestCase

一个定义了运行多重测试的固定装置

类似Spring的XXXAware接口，通过继承的方式，可以获取的一些测试当中的信息。

TestResult

TestResult 集合了执行测试样例的所有结果

通过继承该类，可以修改测试结果。

TestSuite

TestSuite 是测试的集合

可以提供打包各个test类的能力？

@Test

标记需要执行的测试方法

Spring Boot下的JUnit使用

Spring Boot 2.x之前的JUnit 4 框架

在spring中，可以通过注解来驱动测试。其支持的测试类型大致分为3类：

类别	描述	涉及注解
单元测试	一般面向方法，编写一般业务代码时，测试成本较大	@Test，@Before/After/等
切片测试	一般面向难于测试的边界功能，介于单元测试和功能测试之间	@RunWith @WebMvcTest等
功能测试	一般面向某个完整的业务功能，同时也可以使用切面测试中的mock能力，推荐使用	@RunWith @SpringBootTest等

其中，功能测试涉及的要素和对应的实现方案如下：

要素	实现方案
测试的程序环境，包括各种业务ServiceBean和环境版本（dev/test等）	通过@RunWith 和 @SpringBootTest启动spring容器
mock能力，如模拟外部依赖（Redis）	Mockito提供了强大mock功能
断言能力	AssertJ、Hamcrest、JsonPath提供了强大的断言能力

本节参考

Spring整合Junit4进行单元测试

Spring Boot Test

@RunWith

用于指定junit运行环境，是junit提供给其他框架测试环境接口扩展，为了便于使用spring的依赖注入，spring提供了org.springframework.test.context.junit4.SpringJUnit4ClassRunner作为Junit测试环境

@Test系列注解

@Test：测试方法
@Ignore：被忽略的测试方法：加上之后，暂时不运行此段代码
@Before：每一个测试方法之前运行
@After：每一个测试方法之后运行
@BeforeClass：方法必须必须要是静态方法（static 声明），所有测试开始之前运行，注意区分 @Before
@AfterClass：方法必须要是静态方法（static 声明），所有测试结束之后运行，注意区分 @After

@ContextConfiguration

导入配置文件，如果有多个模块就引入多个

在SpringBoot中已由@SpringBootTest替代其功能。

@Transactional+@RollBack

利用spring的事务控制机制，将测试用例中产生的脏数据进行回滚，保证不会数据污染

@SpringBootTest

一般情况下，使用@SpringBootTest后，Spring将加载所有被管理的bean，基本等同于启动了整个服务，此时便可以开始功能测试。

由于web服务是最常见的服务，且我们对于web服务的测试有一些特殊的期望，所以@SpringBootTest注解中，给出了webEnvironment参数指定了web的environment，该参数的值一共有四个可选值：

MOCK：此值为默认值，该类型提供一个mock环境，可以和@AutoConfigureMockMvc或@AutoConfigureWebTestClient搭配使用，开启Mock相关的功能。注意此时内嵌的服务（servlet容器）并没有真正启动，也不会监听web服务端口。
RANDOM_PORT：启动一个真实的web服务，监听一个随机端口。
DEFINED_PORT：启动一个真实的web服务，监听一个定义好的端口（从application.properties读取）。
NONE：启动一个非web的ApplicationContext，既不提供mock环境，也不提供真实的web服务。

注：如果当前服务的classpath中没有包含web相关的依赖，spring将启动一个非web的ApplicationContext，此时的webEnvironment就没有什么意义了。

@xxTest（如@WebMvcTest）

@SpringBootTest注解标注后，会启动整个Spring环境，但有时候仅仅想增对单层服务进行测试，如对Controller层的代码进行校验，这个时候可能并不需要完整的启动整个环境，因此可以采用 切片测试 的方法进行。具体的就是将原来@SpringBootTest注解的位置替换为@xxTest切片形式的注解。

所有的@*Test注解都被@BootstrapWith注解，它们可以启动ApplicationContext，是测试的入口，所有的测试类必须声明一个@*Test注解。

除了@SpringBootTest之外的注解都是用来进行切面测试的，他们会默认导入一些自动配置，点击官方docs查看详情。

自动配置类型的注解（@AutoConfigure*）

这些注解可以搭配@\*Test使用，用于开启在@\*Test中未自动配置的功能。例如@SpringBootTest和@AutoConfigureMockMvc组合后，就可以注入org.springframework.test.web.servlet.MockMvc。

自动配置类型有两种方式：

功能测试（即使用@SpringBootTest）时显示添加。
一般在切片测试中被隐式使用，例如@WebMvcTest注解时，隐式添加了@AutoConfigureCache、@AutoConfigureWebMvc、@AutoConfigureMockMvc。

@Rule

Rule是JUnit4中的新特性，它让我们可以扩展JUnit的功能，灵活地改变测试方法的行为。JUnit中用@Rule和@ClassRule两个注解来实现Rule扩展，这两个注解需要放在实现了TestRule借口的成员变量（@Rule）或者静态变量（@ClassRule）上。@Rule和@ClassRule的不同点是，@Rule是方法级别的，每个测试方法执行时都会调用被注解的Rule，而@ClassRule是类级别的，在执行一个测试类的时候只会调用一次被注解的Rule —— JUnit4教程（四）：利用Rule扩展JUnit

在需要针对每个测试方法都去执行一些自定义的规则的时候，就可以使用该注解，其机制是利用了责任链的模式，类似@Before和@After等注解的方法，不过更加灵活，比如可以让每个测试方法重复执行N次等。

Boot 2.x 后JUnit 5下的测试框架

在Spring Boot 2.x之后，测试框架有了较大改动。在2.x之前，使用的是JUnit 4 ，2.x之后，用的是JUnit5(Jupiter)。

JUnit 5 = JUnit Platform + JUnit Jupiter + JUnit Vintage

JUnit Platform：用于JVM上启动测试框架的基础服务，提供命令行，IDE和构建工具等方式执行测试的支持。
JUnit Jupiter：包含 JUnit 5 新的编程模型和扩展模型，主要就是用于编写测试代码和扩展代码。
JUnit Vintage：用于在JUnit 5 中兼容运行 JUnit3.x 和 JUnit4.x 的测试用例。

本节参考

Spring Boot 基于 JUnit 5 实现单元测试

Java单元测试之JUnit 5快速上手

JUnit 5 User Guide

1.相较于JUnit4，部分注解被替换如下：

BeforeEach 替换 @Before
@BeforeAll 替换 @BeforeClass
@AfterEach 替换 @After
@AfterAll 替换 @AfterClass

2.取消了@RunWith注解

@RunWith(SpringRunner.class)替换为@ExtendWith(SpringExtension.class)，并内置进@SpringBootTest中

3.支持了Java8的流式语法

Mock

在测试中，如果我们需要模拟一些外部依赖的话，我们可能会想到一些熟悉的词汇：mock，spy，stub。。。首先我们对这些词进行下简单的解析。

本节参考

测试中 Fakes、Mocks 以及 Stubs 概念明晰

Mocks Aren’t Stubs

使用 @MockBean 和 @SpyBean 解决 SpringBoot 单元测试中 Mock 类装配的问题

@InjectMocks

Getting Started with Mockito

首先要区分下方法类型，方法类型可以分为两种，一种是给定参数进行查询返回结果的方法，我们称之为Query，另一种是执行具体命令的方法，无返回结果，我们称之为Command。这两种类型方法的模拟方案是不一样的。

Fake 通常是一种目标对象的简单实现，如数据库连接，我们可以通过采用内存数据库去模拟数据库的功能。
Stubs 对于一般的查询方法，即给定参数返回特定结果的方法我们可以通过Stub的方式，来指定其返回值。从而不用真正执行查询方法。
Mocks 如果目标对象有执行型Command方法，则只用Stub就不行了，因此，此时需要Mock一个目标对象，该Mock对象能像目标对象一样执行同样方法，但是并不会采取真实的执行逻辑。另外，mock对象中的Query方法也会返回null，除非对该Query方法采用Stub。
Spies 如果我们想使用目标对象的部分真实方法逻辑，但是又想stub部分返回方法，则我们可以使用Spy，依据目标对象创建一个Spy对象，该Spy对象会执行真实的方法，除非该方法被Stub。

注解辨析

在boot中，提供了很多注解用于模拟，比如@MockBean，@Mock，@SpyBean，@Spy，@InjectMocks等。这些注解在使用上会又些区别。由于单元测试本身就有一套自己的Bean管理机制，这个和Spring的Bean管理机制存在冲突，而在测试时，如果我们在Spring管理Bean的情况下使用@Mock，@Spy，@InjectMocks，就需要在测试类中实现@BeforeAll去初始化Mock的bean的装配方案，这样才能把Mock的Bean注册进对应的@InjectMocks标注的Bean之中。具体使用代码如下：

//代码样例来源于：https://www.baeldung.com/mockito-annotations
@ExtendWith(MockitoExtension.class)//独立于Spring管理进行测试
public class MockitoAnnotationTest {

    @Mock//mock的bean
    private WordMap wordMap;

    @InjectMocks//会把当前测试用例下的用@Mock标注的Bean注册进dic之中
    private MyDictionary dic;

    @BeforeAll//测试开始前要初始化mock的bean，建立自动注入的依赖关系
    public static void init() {
        MockitoAnnotations.initMocks(MockitoAnnotationTest.class);
    }

    @Test
    public void whenUseInjectMocksAnnotation_thenCorrect() {
        //进行stub
        Mockito.when(wordMap.get("aWord")).thenReturn("aMeaning");

        assertEquals("aMeaning", dic.getMeaning("aWord"));
    }

}

//MyDictionary类结构
public class MyDictionary {

    private WordMap wordMap;

    public WordMap getWordMap() {
        return wordMap;
    }

    public void setWordMap(WordMap wordMap) {
        this.wordMap = wordMap;
    }

    public String getMeaning(final String word) {
        return wordMap.get(word);
    }

}


//WordMap类结构
public class WordMap {

    private Map<String, String> wordMap;

    public String get(String key){
        return wordMap.get(key);
    }

    public Map<String, String> getWordMap() {
        return wordMap;
    }

    public void setWordMap(Map<String, String> wordMap) {
        this.wordMap = wordMap;
    }
}

通过上面的代码可以发现，如果独立于Spring框架进行测试，需要进行Bean关系的组装，而我们经常都是在Spring框架下进行测试的，因此，我们可以使用@MockBean，@SpyBean来将mock的bean托管给spring进行依赖注入。从而避免了init方法。具体的使用方法如下：

//代码样例来源于：https://www.baeldung.com/mockito-annotations
@SpringBootTest//交由spring进行管理
public class MockitoAnnotationTest {
      
    @MockBean//mock的bean，交由Spring管理
    private WordMap wordMap;

    @Autowired//spring会自动将mock的bean注入，其实用@SpyBean也可以
    private MyDictionary dic;
  
  	/**
  	@BeforeAll//测试开始前要初始化mock的bean，建立自动注入的依赖关系
    public void init() {
        MockitoAnnotations.initMocks(this);
    }
    */

    @Test
    public void whenUseInjectMocksAnnotation_thenCorrect() {
        //进行stub
        Mockito.when(wordMap.get("aWord")).thenReturn("aMeaning");
        assertEquals("aMeaning", dic.getMeaning("aWord"));
    }
}

//MyDictionary类结构
@Component//交由spring管理
public class WordMap {
    
    private Map<String, String> wordMap;

    public String get(String key){
        return wordMap.get(key);
    }

    public Map<String, String> getWordMap() {
        return wordMap;
    }

    public void setWordMap(Map<String, String> wordMap) {
        this.wordMap = wordMap;
    }
}

@Component//交由spring管理
public class MyDictionary {
    @Autowired
    private WordMap wordMap;

    public WordMap getWordMap() {
        return wordMap;
    }

    public void setWordMap(WordMap wordMap) {
        this.wordMap = wordMap;
    }

    public String getMeaning(final String word) {
        return wordMap.get(word);
    }

}