JUnit5學習之一：基本操做

時間  2021-02-19
標籤 java git 程序員 github web spring 數據庫 apache 編程 api 欄目 Java 简体版
原文   原文鏈接

歡迎訪問個人GitHub

https://github.com/zq2599/blog_demosjava

內容：全部原創文章分類彙總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；git

關於《JUnit5學習》系列

《JUnit5學習》系列旨在經過實戰提高SpringBoot環境下的單元測試技能，一共八篇文章，連接以下：程序員

  1. 基本操做
  2. Assumptions類
  3. Assertions類
  4. 按條件執行
  5. 標籤(Tag)和自定義註解
  6. 參數化測試(Parameterized Tests)基礎
  7. 參數化測試(Parameterized Tests)進階
  8. 綜合進階（終篇）

本篇概覽

本文是《JUnit5學習》系列的第一篇，經過實戰學習在SpringBoot框架下JUnit5的基本功能，全篇章節以下：github

  1. JUnit5簡介
  2. SpringBoot對JUnit5的依賴
  3. 經常使用註解簡介
  4. 5版本已廢棄的註解介紹
  5. 進入實戰環節，先介紹版本和環境信息
  6. 建立《JUnit5學習》系列源碼的父工程
  7. 建立子工程，編碼體驗經常使用註解

關於JUnit5

  1. JUnit是經常使用的java單元測試框架，5是當前最新版本，其總體架構以下(圖片來自網絡)：

在這裏插入圖片描述
2. 從上圖可見，整個JUnit5能夠劃分紅三層：頂層框架(Framework)、中間的引擎（Engine），底層的平臺（Platform）；
3. 官方定義JUnit5由三部分組成：Platform、Jupiter、Vintage，功能以下；
4. Platform：位於架構的最底層，是JVM上執行單元測試的基礎平臺，還對接了各類IDE（例如IDEA、eclipse），而且還與引擎層對接，定義了引擎層對接的API；
5. Jupiter：位於引擎層，支持5版本的編程模型、擴展模型；
6. Vintage：位於引擎層，用於執行低版本的測試用例；web

  • 可見整個Junit Platform是開放的，經過引擎API各類測試框架均可以接入；

SpringBoot對JUnit5的依賴

  1. 這裏使用SpringBoot版本爲2.3.4.RELEASE，在項目的pom.xml中依賴JUnit5的方法以下：
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
  1. 以下圖紅框，可見JUnit5的jar都被spring-boot-starter-test間接依賴進來了：

在這裏插入圖片描述

曾經的RunWith註解

  1. 在使用JUnit4的時候，我們常常這麼寫單元測試類：
@RunWith(SpringRunner.class)
@SpringBootTest
public class XXXTest {
  1. 對於上面的RunWith註解，JUnit5官方文檔的說法以下圖紅框所示，已經被ExtendWith取代：

在這裏插入圖片描述
3. 我們再來看看SpringBootTest註解，以下圖，可見已經包含了ExtendWith：spring

在這裏插入圖片描述
4. 綜上所述，SpringBoot+JUnit5時，RunWith註解已經不須要了，正常狀況下僅SpringBootTest註解便可，若是對擴展性有更多需求，能夠添加ExtendWith註解，以下圖：數據庫

在這裏插入圖片描述

經常使用的JUnit5註解(SpringBoot環境)

注意，接下來提到的測試方法，是指當前class中全部被@Test、@RepeatedTest、@ParameterizedTest、@TestFactory修飾的方法；apache

  1. ExtendWith：這是用來取代舊版本中的RunWith註解，不過在SpringBoot環境若是沒有特別要求無需額外配置，由於SpringBootTest中已經有了；
  2. Test：被該註解修飾的就是測試方法；
  3. BeforeAll：被該註解修飾的必須是靜態方法，會在全部測試方法以前執行，會被子類繼承，取代低版本的BeforeClass；
  4. AfterAll：被該註解修飾的必須是靜態方法，會在全部測試方法執行以後才被執行，會被子類繼承，取代低版本的AfterClass；
  5. BeforeEach：被該註解修飾的方法會在每一個測試方法執行前被執行一次，會被子類繼承，取代低版本的Before；
  6. AfterEach：被該註解修飾的方法會在每一個測試方法執行後被執行一次，會被子類繼承，取代低版本的Before；
  7. DisplayName：測試方法的展示名稱，在測試框架中展現，支持emoji；
  8. Timeout：超時時長，被修飾的方法若是超時則會致使測試不經過；
  9. Disabled：不執行的測試方法；

5版本已廢棄的註解

如下的註解都是在5以前的版本使用的，如今已經被廢棄：編程

被廢棄的註解 新的繼任者
Before BeforeEach
After AfterEach
BeforeClass BeforeAll
AfterClass AfterAll
Category Tag
RunWith ExtendWith
Rule ExtendWith
ClassRule RegisterExtension

版本和環境信息

整個系列的編碼和執行在如下環境進行，供您參考：api

  1. 硬件配置：處理器i5-8400，內存32G，硬盤128G SSD + 500G HDD
  2. 操做系統：Windows10家庭中文版
  3. IDEA：2020.2.2 (Ultimate Edition)
  4. JDK：1.8.0_181
  5. SpringBoot：2.3.4.RELEASE
  6. JUnit Jupiter：5.6.2
    接下來開始實戰，我們先建好SpringBoot項目；

關於lombok

爲了簡化代碼，項目中使用了lombok，請您在IDEA中安裝lombok插件；

源碼下載

  1. 若是您不想編碼，能夠在GitHub下載全部源碼，地址和連接信息以下表所示(https://github.com/zq2599/blog_demos)：
名稱 連接 備註
項目主頁 https://github.com/zq2599/blog_demos 該項目在GitHub上的主頁
git倉庫地址(https) https://github.com/zq2599/blog_demos.git 該項目源碼的倉庫地址，https協議
git倉庫地址(ssh) git@github.com:zq2599/blog_demos.git 該項目源碼的倉庫地址，ssh協議
  1. 這個git項目中有多個文件夾，本章的應用在junitpractice文件夾下，以下圖紅框所示：

在這裏插入圖片描述

  1. junitpractice是父子結構的工程，本篇的代碼在junit5experience子工程中，以下圖：

在這裏插入圖片描述

建立Maven父工程

  1. 爲了便於管理整個系列的源碼，在此創建名爲junitpractice的maven工程，後續全部實戰的源碼都做爲junitpractice的子工程；
  2. junitpractice的pom.xml以下，可見是以SpringBoot的2.3.4.RELEASE版本做爲其父工程：
<?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>
    <modules>
        <module>simplebean</module>
        <!--
        <module>testenvironment</module>
        -->
    </modules>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>junitpractice</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.16.16</version>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

本篇的源碼工程

接下來我們準備一個簡單的SpringBoot工程用於作單元測試，該工程有service和controller層，包含一些簡單的接口和類；

  1. 建立名爲junit5experience的子工程，pom.xml以下，注意單元測試要依賴spring-boot-starter-test：
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.bolingcavalry</groupId>
        <artifactId>junitpractice</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>junit5experience</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>junit5experience</name>
    <description>Demo project for simplebean in Spring Boot junit5</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>
  1. 寫一些最簡單的業務代碼，首先是service層的接口HelloService.java：
package com.bolingcavalry.junit5experience.service;

public interface HelloService {
    String hello(String name);
    int increase(int value);
    /**
     * 該方法會等待1秒後返回true，這是在模擬一個耗時的遠程調用
     * @return
     */
    boolean remoteRequest();
}
  1. 上述接口對應的實現類以下，hello和increase方法分別返回String型和int型，remoteRequest故意sleep了1秒鐘，用來測試Timeout註解的效果：
package com.bolingcavalry.junit5experience.service.impl;

import com.bolingcavalry.junit5experience.service.HelloService;
import org.springframework.stereotype.Service;

@Service()
public class HelloServiceImpl implements HelloService {
    @Override
    public String hello(String name) {
        return "Hello " + name;
    }

    @Override
    public int increase(int value) {
        return value + 1;
    }

    @Override
    public boolean remoteRequest() {
        try {
            Thread.sleep(1000);
        } catch (InterruptedException interruptedException) {
            interruptedException.printStackTrace();
        }

        return true;
    }
}
  1. 添加一個簡單的controller：
package com.bolingcavalry.junit5experience.controller;

import com.bolingcavalry.junit5experience.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @Autowired
    private HelloService helloService;

    @RequestMapping(value = "/{name}", method = RequestMethod.GET)
    public String hello(@PathVariable String name){
        return helloService.hello(name);
    }
}
  1. 啓動類：
package com.bolingcavalry.junit5experience;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Junit5ExperienceApplication {

    public static void main(String[] args) {
        SpringApplication.run(Junit5ExperienceApplication.class, args);
    }
}
  • 以上就是一個典型的web工程，接下來一塊兒爲該工程編寫單元測試用例；

編寫測試代碼

  1. 在下圖紅框位置新增單元測試類：

在這裏插入圖片描述
2. 測試類的內容以下，涵蓋了剛纔提到的經常使用註解，請注意每一個方法的註釋說明：

package com.bolingcavalry.junit5experience.service.impl;

import com.bolingcavalry.junit5experience.service.HelloService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.*;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.concurrent.TimeUnit;
import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest
@Slf4j
class HelloServiceImplTest {

    private static final String NAME = "Tom";

    @Autowired
    HelloService helloService;

    /**
     * 在全部測試方法執行前被執行
     */
    @BeforeAll
    static void beforeAll() {
        log.info("execute beforeAll");
    }

    /**
     * 在全部測試方法執行後被執行
     */
    @AfterAll
    static void afterAll() {
        log.info("execute afterAll");
    }

    /**
     * 每一個測試方法執行前都會執行一次
     */
    @BeforeEach
    void beforeEach() {
        log.info("execute beforeEach");
    }

    /**
     * 每一個測試方法執行後都會執行一次
     */
    @AfterEach
    void afterEach() {
        log.info("execute afterEach");
    }

    @Test
    @DisplayName("測試service層的hello方法")
    void hello() {
        log.info("execute hello");
        assertThat(helloService.hello(NAME)).isEqualTo("Hello " + NAME);
    }

    /**
     * DisplayName中帶有emoji，在測試框架中可以展現
     */
    @Test
    @DisplayName("測試service層的increase方法\uD83D\uDE31")
    void increase() {
        log.info("execute increase");
        assertThat(helloService.increase(1)).isEqualByComparingTo(2);
    }

    /**
     * 不會被執行的測試方法
     */
    @Test
    @Disabled
    void neverExecute() {
        log.info("execute neverExecute");
    }

    /**
     * 調用一個耗時1秒的方法，用Timeout設置超時時間是500毫秒，
     * 所以該用例會測試失敗
     */
    @Test
    @Timeout(unit = TimeUnit.MILLISECONDS, value = 500)
    @Disabled
    void remoteRequest() {
        assertThat(helloService.remoteRequest()).isEqualTo(true);
    }
}
  1. 接下來執行測試用例試試，點擊下圖紅框中的按鈕：

在這裏插入圖片描述
4. 以下圖，在彈出的菜單中，點擊紅框位置：

在這裏插入圖片描述

  1. 執行結果以下，可見Displayname註解的值做爲測試結果的方法名展現，超時的方法會被斷定爲測試不經過，Disable註解修飾的方法則被標記爲跳過不執行：

在這裏插入圖片描述

  1. 在父工程junitpractice的pom.xml文件所在目錄，執行mvn test命令，能夠看到maven執行單元測試的效果：

在這裏插入圖片描述

  • 至此，我們對SpringBoot環境下的JUnit5有了最基本的瞭解，接下來的章節會展開更多知識點和細節，對單元測試作更深刻的學習。

你不孤單，欣宸原創一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 數據庫+中間件系列
  6. DevOps系列

歡迎關注公衆號：程序員欣宸

微信搜索「程序員欣宸」，我是欣宸，期待與您一同暢遊Java世界...
https://github.com/zq2599/blog_demos

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程