SpringBoot2核心功能 --- 单元测试

Posted 2023-04-08 乌云不要说话

一、JUnit5 的变化

Spring Boot 2.2.0 版本开始引入 JUnit 5 作为单元测试默认库

作为最新版本的JUnit框架，JUnit5与之前版本的Junit框架有很大的不同。由三个不同子项目的几个不同模块组成。

JUnit 5 = JUnit Platform + JUnit Jupiter + JUnit Vintage

JUnit Platform: Junit Platform是在JVM上启动测试框架的基础，不仅支持Junit自制的测试引擎，其他测试引擎也都可以接入。

JUnit Jupiter: JUnit Jupiter提供了JUnit5的新的编程模型，是JUnit5新特性的核心。内部 包含了一个测试引擎，用于在Junit Platform上运行。

JUnit Vintage: 由于JUint已经发展多年，为了照顾老的项目，JUnit Vintage提供了兼容JUnit4.x,Junit3.x的测试引擎。

注意：

SpringBoot 2.4 以上版本移除了默认对 Vintage 的依赖。如果需要兼容junit4需要自行引入（不能使用junit4的功能 @Test）

JUnit 5’s Vintage Engine Removed from spring-boot-starter-test,如果需要继续兼容junit4需要自行引入vintage

<dependency>
    <groupId>org.junit.vintage</groupId>
    <artifactId>junit-vintage-engine</artifactId>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>

 SpringBoot 2.4以上直接引入：

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

现在版本：

@SpringBootTest
class Boot05WebAdminApplicationTests 


    @Test
    void contextLoads() 

    

以前：

@SpringBootTest + @RunWith(SpringTest.class)

SpringBoot整合Junit以后。

• 编写测试方法：@Test标注（注意需要使用junit5版本的注解）
• Junit类具有Spring的功能，@Autowired、比如 @Transactional 标注测试方法，测试完成后自动回滚

 

 

二、JUnit5常用注解

JUnit5的注解与JUnit4的注解有所变化

官网：JUnit 5 User Guide

• @Test :表示方法是测试方法。但是与JUnit4的@Test不同，他的职责非常单一不能声明任何属性，拓展的测试将会由Jupiter提供额外测试
• @ParameterizedTest :表示方法是参数化测试，下方会有详细介绍
• @RepeatedTest :表示方法可重复执行，下方会有详细介绍
• @DisplayName :为测试类或者测试方法设置展示名称
• @BeforeEach :表示在每个单元测试之前执行
• @AfterEach :表示在每个单元测试之后执行
• @BeforeAll :表示在所有单元测试之前执行
• @AfterAll :表示在所有单元测试之后执行
• @Tag :表示单元测试类别，类似于JUnit4中的@Categories
• @Disabled :表示测试类或测试方法不执行，类似于JUnit4中的@Ignore
• @Timeout :表示测试方法运行如果超过了指定时间将会返回错误
• @ExtendWith :为测试类或测试方法提供扩展类引用

​import org.junit.jupiter.api.Test; //注意这里使用的是jupiter的Test注解！！

public class TestDemo 

  @DisplayName("测试DisplayName注解")
    @Test
    void testDisplayName() 
        System.out.println(1);
        //1
    

    @Disabled
    @DisplayName("测试方法2")
    @Test
    void test2() 
        System.out.println(2);
        //2
    

    @BeforeEach
    void testBeforeEach() 
        System.out.println("测试开始...");
        //测试开始...
        //1
    

    @AfterEach
    void testAfterEach() 
        System.out.println("测试结束！");
        //测试开始...
        //1
        //测试结束！
    

    @BeforeAll
    static void testBeforeAll() 
        System.out.println("所有单元测试开始...");
        //所有单元测试开始...
        //测试开始...
        //2
        //测试结束！
        //测试开始...
        //1
        //测试结束！
    
    
    @AfterAll
    static void testAfterAll () 
        System.out.println("所有单元测试结束！");
        //所有单元测试开始...
        //测试开始...
        //2
        //测试结束！
        //测试开始...
        //1
        //测试结束！
        //所有单元测试结束！
    

 

 

三、断言（assertions）

断言（assertions）是测试方法中的核心部分，用来对测试需要满足的条件进行验证。这些断言方法都是 org.junit.jupiter.api.Assertions 的静态方法。JUnit 5 内置的断言可以分成如下几个类别：

检查业务逻辑返回的数据是否合理。

所有的测试运行结束以后，会有一个详细的测试报告；

 

3.1、简单断言

用来对单个值进行简单的验证。如：

方法	说明
assertEquals	判断两个对象或两个原始类型是否相等
assertNotEquals	判断两个对象或两个原始类型是否不相等
assertSame	判断两个对象引用是否指向同一个对象
assertNotSame	判断两个对象引用是否指向不同的对象
assertTrue	判断给定的布尔值是否为 true
assertFalse	判断给定的布尔值是否为 false
assertNull	判断给定的对象引用是否为 null
assertNotNull	判断给定的对象引用是否不为 null

@Test
@DisplayName("simple assertion")
public void simple() 
     assertEquals(3, 1 + 2, "simple math");
     assertNotEquals(3, 1 + 1);

     assertNotSame(new Object(), new Object());
     Object obj = new Object();
     assertSame(obj, obj);

     assertFalse(1 > 2);
     assertTrue(1 < 2);

     assertNull(null);
     assertNotNull(new Object());

 

3.2、数组断言

通过 assertArrayEquals 方法来判断两个对象或原始类型的数组是否相等

@Test
@DisplayName("array assertion")
public void array() 
    assertArrayEquals(new int[]1, 2, new int[] 1, 2);

 

3.3、组合断言

assertAll 方法接受多个 org.junit.jupiter.api.Executable 函数式接口的实例作为要验证的断言，可以通过 lambda 表达式很容易的提供这些断言

@Test
@DisplayName("assert all")
public void all() 
 assertAll("Math",
    () -> assertEquals(2, 1 + 1),
    () -> assertTrue(1 > 0)
 );

 

3.4、异常断言

在JUnit4时期，想要测试方法的异常情况时，需要用@Rule注解的ExpectedException变量还是比较麻烦的。而JUnit5提供了一种新的断言方式Assertions.assertThrows() ,配合函数式编程就可以进行使用。

@Test
@DisplayName("异常测试")
public void exceptionTest() 
    ArithmeticException exception = Assertions.assertThrows(
           //扔出断言异常
            ArithmeticException.class, () -> System.out.println(1 % 0));

 

3.5、超时断言

Junit5还提供了Assertions.assertTimeout() 为测试方法设置了超时时间

@Test
@DisplayName("超时测试")
public void timeoutTest() 
    //如果测试方法时间超过1s将会异常
    Assertions.assertTimeout(Duration.ofMillis(1000), () -> Thread.sleep(500));

 

3.6、快速失败

通过 fail 方法直接使得测试失败

@Test
@DisplayName("fail")
public void shouldFail() 
    fail("This should fail");

 

 

四、前置条件（assumptions）

JUnit 5 中的前置条件（assumptions【假设】）类似于断言，不同之处在于不满足的断言会使得测试方法失败，而不满足的前置条件只会使得测试方法的执行终止。前置条件可以看成是测试方法执行的前提，当该前提不满足时，就没有继续执行的必要。

@DisplayName("前置条件")
public class AssumptionsTest 
 private final String environment = "DEV";
 
 @Test
 @DisplayName("simple")
 public void simpleAssume() 
    assumeTrue(Objects.equals(this.environment, "DEV"));
    assumeFalse(() -> Objects.equals(this.environment, "PROD"));
 
 
 @Test
 @DisplayName("assume then do")
 public void assumeThenDo() 
    assumingThat(
       Objects.equals(this.environment, "DEV"),
       () -> System.out.println("In DEV")
    );
 

assumeTrue 和 assumFalse 确保给定的条件为 true 或 false，不满足条件会使得测试执行终止。assumingThat 的参数是表示条件的布尔值和对应的 Executable 接口的实现对象。只有条件满足时，Executable 对象才会被执行；当条件不满足时，测试执行并不会终止。

 

 

五、嵌套测试

JUnit 5 可以通过 Java 中的内部类和@Nested 注解实现嵌套测试，从而可以更好的把相关的测试方法组织在一起。在内部类中可以使用@BeforeEach 和@AfterEach 注解，而且嵌套的层次没有限制。

@DisplayName("A stack")
class TestingAStackDemo 

    Stack<Object> stack;

    @Test
    @DisplayName("is instantiated with new Stack()")
    void isInstantiatedWithNew() 
        new Stack<>();
    

    @Nested
    @DisplayName("when new")
    class WhenNew 

        @BeforeEach
        void createNewStack() 
            stack = new Stack<>();
        

        @Test
        @DisplayName("is empty")
        void isEmpty() 
            assertTrue(stack.isEmpty());
        

        @Test
        @DisplayName("throws EmptyStackException when popped")
        void throwsExceptionWhenPopped() 
            assertThrows(EmptyStackException.class, stack::pop);
        

        @Test
        @DisplayName("throws EmptyStackException when peeked")
        void throwsExceptionWhenPeeked() 
            assertThrows(EmptyStackException.class, stack::peek);
        

        @Nested
        @DisplayName("after pushing an element")
        class AfterPushing 

            String anElement = "an element";

            @BeforeEach
            void pushAnElement() 
                stack.push(anElement);
            

            @Test
            @DisplayName("it is no longer empty")
            void isNotEmpty() 
                assertFalse(stack.isEmpty());
            

            @Test
            @DisplayName("returns the element when popped and is empty")
            void returnElementWhenPopped() 
                assertEquals(anElement, stack.pop());
                assertTrue(stack.isEmpty());
            

            @Test
            @DisplayName("returns the element when peeked but remains not empty")
            void returnElementWhenPeeked() 
                assertEquals(anElement, stack.peek());
                assertFalse(stack.isEmpty());
            
        
    

 

 

六、参数化测试

参数化测试是JUnit5很重要的一个新特性，它使得用不同的参数多次运行测试成为了可能，也为我们的单元测试带来许多便利。

利用@ValueSource等注解，指定入参，我们将可以使用不同的参数进行多次单元测试，而不需要每新增一个参数就新增一个单元测试，省去了很多冗余代码。

@ValueSource: 为参数化测试指定入参来源，支持八大基础类以及String类型,Class类型

@NullSource: 表示为参数化测试提供一个null的入参

@EnumSource: 表示为参数化测试提供一个枚举入参

@CsvFileSource：表示读取指定CSV文件内容作为参数化测试入参

@MethodSource：表示读取指定方法的返回值作为参数化测试入参(注意方法返回需要是一个流)

当然如果参数化测试仅仅只能做到指定普通的入参还达不到让我觉得惊艳的地步。让我真正感到他的强大之处的地方在于他可以支持外部的各类入参。如:CSV,YML,JSON 文件甚至方法的返回值也可以作为入参。只需要去实现ArgumentsProvider接口，任何外部文件都可以作为它的入参。

@ParameterizedTest
@ValueSource(strings = "one", "two", "three")
@DisplayName("参数化测试1")
public void parameterizedTest1(String string) 
    System.out.println(string);
    Assertions.assertTrue(StringUtils.isNotBlank(string));



@ParameterizedTest
@MethodSource("method")    //指定方法名
@DisplayName("方法来源参数")
public void testWithExplicitLocalMethodSource(String name) 
    System.out.println(name);
    Assertions.assertNotNull(name);


static Stream<String> method() 
    return Stream.of("apple", "banana");

  

  

七、迁移指南

在进行迁移的时候需要注意如下的变化：

• 注解在 org.junit.jupiter.api 包中，断言在 org.junit.jupiter.api.Assertions 类中，前置条件在 org.junit.jupiter.api.Assumptions 类中。
• 把@Before 和@After 替换成@BeforeEach 和@AfterEach。
• 把@BeforeClass 和@AfterClass 替换成@BeforeAll 和@AfterAll。
• 把@Ignore 替换成@Disabled。
• 把@Category 替换成@Tag。
• 把@RunWith、@Rule 和@ClassRule 替换成@ExtendWith。

SpringBoot与单元测试JUnit的结合

有些人认为，写单元测试就是在浪费时间 ，写完代码，依然还是能够进行测试的。但是，还是建议写单元测试的，可以让你的条理更加清晰，而且当某个功能出现问题时，可能通过单元测试很容易的定位和解决问题。本文主要总结下在Spring及SpringBoot项目中，使用单元测试时的方法。将JUnit4和JUnit5对比着来写，因为我发现我身边的同事经常搞不明白要怎么用。

Juint版本说明

这里主要说明下它们在Maven下的依赖包

Junit4

<dependency>
	<groupId>junit</groupId>
	<artifactId>junit</artifactId>
	<version>4.13</version>
  <!--请注意这个scope的用法-->
  <scope>test</scope>
</dependency>

Junit5

<dependency>
  <groupId>org.junit.jupiter</groupId>
  <artifactId>junit-jupiter</artifactId>
  <version>5.6.2</version>
  <!--请注意这个scope的用法-->
  <scope>test</scope>
</dependency>

在上边的依赖中，两个依赖分别写了scope属性，这里做一个讲解：

一个标准的maven项目结构如下图：

写Java代码的地方有两个src/main/java和src/test/java。如果我们不在上边依赖中添加scope为test属性，就可以在这两个地方任意地方写@Test测试方法，但是，如果添加了这个属性，就只能在src/test/java下写单元测试代码，这个就是maven所谓的test域。从上图也可以看出，test域可以有自己的配置文件，如果没有的话就会去加载main下的resources的配置文件，如果有，则以自己的为优先。

Junit5常见注解及其用法

不管使用哪一种方法，一个标准的单元测试方法如下：

public class TestDemo {
		
    @Test
    void fun1(){
        System.out.println("欢迎关注我的微信公众号——小鱼与Java");
    }
}

但是对于Junit4而言，所有的测试方法应当是public声明的，而Junit5不用。只不过不同的版本，这个@Test的类是不同的：

Junit4: org.junit.Test
Junit5: org.junit.jupiter.api.Test

相比Junit4而言，5添加了新的一些注解，但是常用的注解还是相同的，主要有以下：

注解	Description
@Test	写在一个测试类中的测试方法中的元注解，也就是说，在每一个单元测试方法上都应加上它才会生效
@ParameterizedTest	参数化测试，就是在你的测试方法执行时，自动添加一些参数
@RepeatedTest	重复此测试方法
@TestFactory	动态测试的工厂方法
@TestTemplate	测试模板
@TestMethodOrder	测试方法的执行顺序，默认是按照代码的前后顺序执行的
@DisplayName	自定义测试方法的名称显示
@DisplayNameGeneration	自定义名称生成器
@BeforeEach	在Junit4中，这个注解叫@Before。就是会在每一个测试方法执行前都会执行的方法，包括@Test, @RepeatedTest, @ParameterizedTest,或者 @TestFactory注解的方法
@AfterEach	和上边很相似，在Junit4中，这个注解叫@After。就是会在每一个测试方法执行之后都会执行的方法，包括@Test, @RepeatedTest, @ParameterizedTest, 或者@TestFactory注解的方法.
@BeforeAll	在当前测试类中的方法执行前执行，只会执行一次，在Junit4中是@BeforeClass
@AfterAll	在当前测试类中的所有测试方法执行完之后执行，只会执行一次，在Junit4中是@AfterClass
@Nested	表示一个非静态的测试方法，也就是说@BeforeAll和@AfterAll对此方法无效，如果单纯地执行此方法，并不会触发这个类中的@BeforeAll和@AfterAll方法
@Tag	自定义tag，就是可以自定义一个属于自己的@Test一样功能的注解
@Disabled	表明此方法不可用，并不会执行，在JUnit4中的@Ignore
@Timeout	设定方法执行的超时时间，如果超过，就会抛出异常

以上是在JUnit5中最常用的注解，可以自己挨个试下，一下子就会明白其用法。关注我，后续为您递上具体用法。

在普通Maven项目中使用Junit

引入相关依赖后，然后在对应的位置进行测试就可以了，这里不做演示，可以自行下载代码查看

在Spring项目中使用Junit

这里的Spring和SpringBoot项目也是基于Maven构建的，和普通Maven项目的最大区别就是加载Sprign容器而已，一般来说，使用Spring提供的上下文ApplicationContext就可以从配置文件件或者配置类加载Spring容器。如下代码：

/**
 * 使用普通的Spring上下文来加载Spring容器
 * 
 * @auther 微信公众号：小鱼与Java
 * 2020/4/23
 */
public class MyMain {
    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("application.xml");
        Teacher teacher = (Teacher) ctx.getBean("teacher");
        System.out.println(teacher.getName());
    }
}

但是，我们可以通过引入Spring相关的test依赖来让其自动加载Spring上下文，这样我们就能利用如@Autowired这样的自动注入方式来获取bean了

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-test</artifactId>
  <version>5.2.5.RELEASE</version>
</dependency>

但是这里对于JUnit4和JUnit5写测试方法时有一点儿不同之处，如下：

Junit4

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:application.xml"})
public class TestDemo {
    @Resource
    private Teacher teacher;

    @Test
    public void fun(){
        System.out.println(teacher.getName());
    }
}

Junit5

@SpringJUnitConfig
//指定配置文件路径，会先从test域中找
@ContextConfiguration("classpath:application.xml")
public class SpringTest {

    @Resource
    private Teacher teacher;

    @Test
    void fun(){
        System.out.println(teacher.getName());
    }
}

它们都加了额外的注解来加载Spring上下文的

在SpringBoot项目中使用Junit

在SpringBoot中，为我们提供了一个SpringBootTest的注解来加载Spring容器。在SpringBoot2.2.0以前是JUnit4，在SpringBoot之后是JUnit5。但是我建议最应该使用JUnit5。

Junit4

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>2.1.6.RELEASE</version>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <version>2.1.6.RELEASE</version>
    <!--表示只能在maven的测试域中使用-->
    <scope>test</scope>
  </dependency>
</dependencies>

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestDemo {

   @Resource
   private Student student;

   @Test
   public void fun1(){
        System.out.println(student.getName());
    }
}

Junit5

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>2.2.6.RELEASE</version>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <version>2.2.6.RELEASE</version>
    <!--表示只能在maven的测试域中使用-->
    <scope>test</scope>
    <exclusions>
      <!--这个是JUnit5中为了支持使用JUint4所做的一个过度
       也就是说，你只需要在你的JUnit4旧项目中添加这个依赖，
       就能完美过渡，而不用修改之前代码
       这里用不到，自然也就排除了。当然，这里，它无关紧要
			-->
      <exclusion>
        <groupId>org.junit.vintage</groupId>
        <artifactId>junit-vintage-engine</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
</dependencies>

@SpringBootTest //它默认会为我们加载Spring容器，
public class TestDemo {

    @Resource
    private Student student;

    @Test
    void fun1(){
        System.out.println(student.getName());
    }
}

为什么在SpringBoot中不用指定Spring容器的配置文件？

? 其实他是会自动加载类路径下的那个SpringBoot的启动类的，就算指定配置文件，也是指定那个启动类为配置类。如果你写的包结构不符合它的要求，就需要自己使用@ContextConfiguration注解来指定Spring的配置类了