JUnit5单元测试框架的使用教程与简单实例

桃扇骨 2021-08-26 11:45 413阅读 0赞

# 1、JUnit5的使用教程 #

## 1.1 简介 ##

JUnit是一个Java语言的单元测试框架。它由Kent Beck和Erich Gamma建立，逐渐成为源于Kent Beck的sUnit的xUnit家族中最为成功的一个。 JUnit有它自己的JUnit扩展生态圈。多数Java的开发环境都已经集成了JUnit作为单元测试的工具。

JUnit5旨在调整java8样式的编码，并且比JUnit4更强大和灵活。

> 什么是Junit5
> 
> JUnit 5 = JUnit Platform + JUnit Jupiter + JUnit Vintage

这看上去比Junit4 复杂，实际上在导入包时也会复杂一些。

JUnit Platform：是在JVM上启动测试框架的基础。

JUnit Jupiter：是JUnit5扩展的新的编程模型和扩展模型，用来编写测试用例。Jupiter子项目为在平台上运行Jupiter的测试提供了一个TestEngine （测试引擎）。

JUnit Vintage：提供了一个在平台上运行JUnit 3和JUnit 4的TestEngine 。

## 1.2 安装 ##

这里使用Maven进行安装，pom.xml配置文件如下：

<dependencies>
        
        <dependency>
            <groupId>org.junit.platform</groupId>
            <artifactId>junit-platform-launcher</artifactId>
            <version>1.6.0</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-engine</artifactId>
            <version>5.6.0</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.vintage</groupId>
            <artifactId>junit-vintage-engine</artifactId>
            <version>5.6.0</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

## 1.3 JUnit5注解 ##

所有支持的注解都在包 org.junit.jupiter.api 下;

使用@Test、@TestTemplate、@RepeatedTest、@BeforeAll、@AfterAll、@BeforeEach或@AfterEach注释的方法不能返回值。

<table> 
 <thead> 
  <tr> 
   <th style="width:183px;">注解</th> 
   <th style="width:616px;">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="width:183px;">@Test</td> 
   <td style="width:616px;">表示方法是测试方法。与JUnit 4的@Test注释不同，这个注释不声明任何属性，因为JUnit Jupiter中的测试扩展基于它们自己的专用注释进行操作。&nbsp;</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@ParameterizedTest</td> 
   <td style="width:616px;">表示方法是参数化测试。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@RepeatedTest</td> 
   <td style="width:616px;">表示方法是重复测试的测试模板。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@TestFactory</td> 
   <td style="width:616px;">表示方法是动态测试的测试工厂。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@TestInstance</td> 
   <td style="width:616px;">用于为带注释的测试类配置测试实例生命周期。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@TestTemplate</td> 
   <td style="width:616px;">表示方法是为测试用例设计的模板，根据注册提供程序返回的调用上下文的数量进行多次调用。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@DisplayName</td> 
   <td style="width:616px;">声明测试类或测试方法的自定义显示名称。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@BeforeEach</td> 
   <td style="width:616px;">表示在当前类中每个@Test、@RepeatedTest、@ParameterizedTest或@TestFactory方法之前执行注释的方法；类似于JUnit 4的@Before。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@AfterEach</td> 
   <td style="width:616px;">表示在当前类中的每个@Test、@RepeatedTest、@ParameterizedTest或@TestFactory方法之后，都应该执行带注释的方法；类似于JUnit 4的@After。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@BeforeAll</td> 
   <td style="width:616px;">表示应在当前类中的所有@Test、@RepeatedTest、@ParameterizedTest和@TestFactory方法之前执行带注释的方法；类似于JUnit 4的@BeforeClass。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@AfterAll</td> 
   <td style="width:616px;">表示在当前类中，所有@Test、@RepeatedTest、@ParameterizedTest和@TestFactory方法都应该执行注释的方法；类似于JUnit 4的@AfterClass。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@Nested</td> 
   <td style="width:616px;">表示带注释的类是一个嵌套的、非静态的测试类。@BeforeAll和@AfterAll方法不能直接在 @Nested 测试类中使用，除非使用“每个类”测试实例生命周期。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@Tag</td> 
   <td style="width:616px;">用于在类或方法级别声明过滤测试的标记；类似于TestNG中的测试组或JUnit 4中的类别。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@Disabled</td> 
   <td style="width:616px;">用于禁用测试类或测试方法；类似于JUnit 4的@Ignore。</td> 
  </tr> 
  <tr> 
   <td style="width:183px;">@ExtendWith</td> 
   <td style="width:616px;">用于注册自定义扩展。</td> 
  </tr> 
 </tbody> 
</table>

## 1.4 JUnit5与JUnit4注释的比较 ##

两个版本中的大多数注释都是相同的，但很少有区别。这是一个快速比较。

<table> 
 <tbody> 
  <tr> 
   <th>特征</th> 
   <th>JUNIT4</th> 
   <th>JUNIT5</th> 
  </tr> 
  <tr> 
   <td>声明一种测试方法。</td> 
   <td><code>@Test</code></td> 
   <td><code>@Test</code></td> 
  </tr> 
  <tr> 
   <td>在当前类中的所有测试方法之前执行。</td> 
   <td><code>@BeforeClass</code></td> 
   <td><code>@BeforeAll</code></td> 
  </tr> 
  <tr> 
   <td>在当前类中的所有测试方法之后执行。</td> 
   <td><code>@AfterClass</code></td> 
   <td><code>@AfterAll</code></td> 
  </tr> 
  <tr> 
   <td>在每个测试方法之前执行。</td> 
   <td><code>@Before</code></td> 
   <td><code>@BeforeEach</code></td> 
  </tr> 
  <tr> 
   <td>每种测试方法后执行。</td> 
   <td><code>@After</code></td> 
   <td><code>@AfterEach</code></td> 
  </tr> 
  <tr> 
   <td>禁用测试方法/类。</td> 
   <td><code>@Ignore</code></td> 
   <td><code>@Disabled</code></td> 
  </tr> 
  <tr> 
   <td>测试工厂进行动态测试。</td> 
   <td>NA</td> 
   <td><code>@TestFactory</code></td> 
  </tr> 
  <tr> 
   <td>嵌套测试。</td> 
   <td>NA</td> 
   <td><code>@Nested</code></td> 
  </tr> 
  <tr> 
   <td>标记和过滤。</td> 
   <td><code>@Category</code></td> 
   <td><code>@Tag</code></td> 
  </tr> 
  <tr> 
   <td>注册自定义扩展。</td> 
   <td>NA</td> 
   <td><code>@ExtendWith</code></td> 
  </tr> 
 </tbody> 
</table>

## 1.5 JUnit5断言（Assertions类） ##

JUnit Jupiter附带了许多JUnit 4拥有的断言方法，并添加了一些可以很好地用于Java 8 lambdas的断言方法。   
所有JUnit5断言都是 org.junit.jupiter.api.Assertions 中的静态方法断言类。

Asser类中主要方法如下：

<table> 
 <thead> 
  <tr> 
   <th>方法名称</th> 
   <th>方法描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>assertEquals</td> 
   <td>断言传入的预期值与实际值是相等的。</td> 
  </tr> 
  <tr> 
   <td>assertNotEquals</td> 
   <td>断言传入的预期值与实际值是不相等的。</td> 
  </tr> 
  <tr> 
   <td>assertArayEquals</td> 
   <td>断言传入的预期数组与实际数组是相等的。</td> 
  </tr> 
  <tr> 
   <td>assertNull</td> 
   <td>断言传入的对象是为空。</td> 
  </tr> 
  <tr> 
   <td>assertNotNull</td> 
   <td>断言传入的对象是不为空。</td> 
  </tr> 
  <tr> 
   <td>assertTrue</td> 
   <td>断言条件为真。</td> 
  </tr> 
  <tr> 
   <td>assertFalse</td> 
   <td>断言条件为假。</td> 
  </tr> 
  <tr> 
   <td>assertSame</td> 
   <td>断言两个对象引用同一个对象，相当于"==”。</td> 
  </tr> 
  <tr> 
   <td>assertNotSame</td> 
   <td>断言两个对象引用不同的对象，相当于"!=”。</td> 
  </tr> 
  <tr> 
   <td>assertThat</td> 
   <td>断言实际值是否满足指定的条件。</td> 
  </tr> 
 </tbody> 
</table>

注意：上面的每一 个方法， 都有对应的重载方法，可以在前面加一个String类型的参数，表示如果断言失败时的提示。

> **推荐教程：**
> 
> 推荐JUnit5使用教程：[《JUnit5入门系列教程》][JUnit5]（作者：叶止水）。

# 2、JUnit5的简单实例 #

**【实例】**在IDEA开发工具中，中使用JUnit5实现一个简单的测试实例。

IDEA开发工具默认已经安装好了JUnit插件，如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70][]

如果没有安装JUnit插件，请执行安装。

（1）编写pom.xml配置文件，引入JUnit5所需的jar包。

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.pjb.mvnbook</groupId>
        <artifactId>hello-world</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <dependencies>
            
            <dependency>
                <groupId>org.junit.platform</groupId>
                <artifactId>junit-platform-launcher</artifactId>
                <version>1.6.0</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-engine</artifactId>
                <version>5.6.0</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
                <version>5.6.0</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
    </project>

（2）创建HelloWorld.java类，该类是被测试的对象。

/**
     * 业务类
     * @author pan_junbiao
     **/
    public class HelloWorld
    {
        public String sayHello()
        {
            return "您好，欢迎访问 pan_junbiao的博客";
        }
    
        public static void main(String[] args)
        {
            System.out.println(new HelloWorld().sayHello());
        }
    }

（3）创建测试类。

**创建测试类的方法一：**

选择需要被测试的类，点击鼠标右键（弹出菜单）→ Go To → Test。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 1][]

**创建测试类的方法二：**

选择需要被测试的类，**使用快捷键： Ctrl + Shift + T**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 2][]

在弹出的Create Test窗口中，输入相关测试类信息，并勾选需要被测试的方法。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 3][]

编写测试代码：

import org.junit.jupiter.api.Test;
    import org.junit.jupiter.api.AfterEach;
    import org.junit.jupiter.api.BeforeEach;
    
    /**
     * 使用JUnit5进行测试类
     * @author pan_junbiao
     **/
    class HelloWorldTest
    {
        @BeforeEach
        void setUp()
        {
            System.out.println("@BeforeEach，测试开始");
        }
    
        @AfterEach
        void tearDown()
        {
            System.out.println("@AfterEach，测试结束");
        }
    
        @Test
        void sayHello()
        {
            HelloWorld helloWorld = new HelloWorld();
            String result = helloWorld.sayHello();
            System.out.println(result);
            assertEquals("您好，欢迎访问 pan_junbiao的博客",result);
        }
    }

**执行结果：**

![20200213173628963.jpg][]

[JUnit5]: https://blog.csdn.net/ryo1060732496/article/details/80792246
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70]: /images/20210724/18ee1fac1e674c1787f4e3f04c6c9dab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 1]: /images/20210724/9c92566af18243d381dd02c470e0eafd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 2]: /images/20210724/6446ce0b61de4935aeef9b3ab2466889.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 3]: /images/20210724/60a1bf4295794174bcafa0ca660832cf.png
[20200213173628963.jpg]: /images/20210724/f339d9e7842349678efc6c8e6c8ba281.png