腳本之家服務器常用軟件

快捷導航

SpringBoot2零基礎到精通之JUnit 5與指標監(jiān)控

更新時間：2022年03月22日 15:14:37 作者：扎哇太棗糕

SpringBoot是一種整合Spring技術棧的方式(或者說是框架)，同時也是簡化Spring的一種快速開發(fā)的腳手架，本篇讓我們一起學習JUnit 5與指標監(jiān)控

1 單元測試JUnit 5

1.1JUnit 5簡介以及使用

??JUnit5作為最新版本的JUnit框架與之前版本的Junit框架有很大的不同。JUnit5主要由三個不同子項目的幾個不同模塊組成：JUnit Platform、JUnit Jupiter、JUnit Vintage。

JUnit Platform: 它是在JVM上啟動測試框架的基礎，不僅支持Junit自制的測試引擎，其他測試引擎也都可以接入。
JUnit Jupiter: 提供了JUnit5的新的編程模型，是JUnit5新特性的核心。內(nèi)部包含了一個測試引擎，用于在Junit Platform上運行。
JUnit Vintage: 由于JUint已經(jīng)發(fā)展多年，為了照顧老的項目，JUnit Vintage提供了兼容JUnit4.x,Junit3.x的測試引擎。

??在這里我們需要了解的是：SpringBoot 2.4 以上版本移除了默認對JUnit Vintage的依賴。如果需要兼容junit4需要自行引入，不引入的話就不能使用junit4的功能@Test，但是JUnit5也有一個@Test注解能夠完成同樣的功能

使用：由上面的JUnit5分析可知：要想使用JUnit5并兼容JUnit以前的版本的話，必須引用以下兩個依賴

<!--測試的啟動器依賴-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<!--兼容JUnit4版本的單元測試-->
<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>

然后使用@SpringBootTest注解標注測試類，使用@Test標注測試方法

1.2 常用的測試注解

??官方文檔中已經(jīng)定義并解釋了所有的注解，可以通過這個鏈接進行查看官方文檔的鏈接地址接下來會選取常用的幾個注解進行講解學習

@SpringBootTest和@Test不再贅述
@DisplayName注解：控制臺磚展示名

@BeforeEach注解：每個方法執(zhí)行之前執(zhí)行@AfterEach注解：每個方法執(zhí)行之后執(zhí)行

@BeforeAll注解：所有方法執(zhí)行之前執(zhí)行@AfterAll注解：所有方法執(zhí)行之后執(zhí)行值得注意的是，這兩個注解的修飾的方法都必須使用static修飾

@Disable注解：在運行測試類的時候禁用這個方法，可以單獨執(zhí)行@Timeout注解：設置測試方法的執(zhí)行時間，超過這個時間則拋異常

@ExtendWith注解：設置測試類的測試驅(qū)動，@SpringBootTest注解是個復合注解，其中底層就有
@ExtendWith注解指定了測試類使用的是SpringBoot的測試驅(qū)動
@RepeatedTest注解：指定方法重復次數(shù)

1.3 斷言(assertions)

??斷言是測試方法中的核心部分，用來對測試需要滿足的條件進行驗證。所謂斷言就是檢查業(yè)務邏輯返回的數(shù)據(jù)是否合理，在所有的測試運行結束以后，會產(chǎn)生一個詳細的測試報告。值得注意的是：當出現(xiàn)一個斷言失敗之后，從那個斷言開始后面的所有代碼都不會執(zhí)行 JUnit 5 內(nèi)置的斷言可以分成如下幾個類別：

簡單斷言

以上方法的用法如下(以assertEquals方法為例)：

數(shù)組斷言

組合斷言組合斷言需要所有的參數(shù)都滿足的情況下才會通過，否則會返回出錯的斷言，可以以用來一個方法進行多個簡單斷言

異常斷言當結果不拋出定義的異常時斷言失敗

超時斷言當超出定義的超時時間就會返回斷言

快速斷言當符合邏輯的時候就會返回斷言

??使用斷言的好處就是：可以使用以下圖片中的方法將測試類的所有方法跑一遍，如果斷言都通過則正常運行。否則就會返回所有的斷言失敗的信息

1.4 前置條件（assumptions）

??JUnit 5 中的前置條件(又叫假設)類似于斷言，不同之處在于不滿足的斷言會使得測試方法失敗，而不滿足的前置條件只會使得測試方法的執(zhí)行終止。前置條件可以看成是測試方法執(zhí)行的前提，當該前提不滿足時，就沒有繼續(xù)執(zhí)行的必要。

由上圖可知，前置條件與斷言最大的區(qū)別就是前置條件不滿足的情況下，跳過該方法繼續(xù)執(zhí)行別的方法，而不滿足斷言的話后面的代碼都將不會執(zhí)行

1.5 嵌套測試

??嵌套測試即是測試類中還有測試類，在這種情況下，外層的test不能驅(qū)動內(nèi)層的Before(After)All(Each)方法，但是內(nèi)層的test可以驅(qū)動外層的Before(After)All(Each)方法。

1.6 參數(shù)化測試

@ValueSource: 為參數(shù)化測試指定入?yún)碓?，支持八大基礎類以及String類型,Class類型

@NullSource: 為測試方法提供參數(shù)為null
@EnumSource: 為測試方法提供枚舉參數(shù)
@CsvFileSource：讀取指定CSV文件內(nèi)容作為參數(shù)化測試入?yún)?/li>
@MethodSource：讀取指定方法的返回值作為參數(shù)化測試入?yún)?但是該方法的返回必須是一個Stream流)

2 指標監(jiān)控

2.1 使用url實現(xiàn)監(jiān)控

引用Actuator啟動器

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

使用配置文件開啟想要的端點

management:
endpoints:
enabled-by-default: false # 默認開啟所有的監(jiān)控端點，定制化的話就需要關閉
web:
exposure:
include: '*' # 以web的方式暴露所有的端點
endpoint:
beans:
enabled: true
health:
enabled: true
show-details: always
info:
enabled: true
metrics:
enabled: true

使用url查看監(jiān)控信息

2.2 可視化的監(jiān)控平臺

使用Spring Initializr快速創(chuàng)建一個SpringBoot項目，項目的pom文件加入服務監(jiān)控平臺的依賴，并在該項目的主程序類上加入@EnableAdminServer注解

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-server</artifactId>
    <version>2.3.1</version>
</dependency>

為了防止與需要監(jiān)控的服務產(chǎn)生端口沖突，需要在配置文件中修改監(jiān)控的端口號

server:
port: 8888

將其他的服務注冊進監(jiān)控

第一步：被監(jiān)控的服務中導入依賴

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-client</artifactId>
    <version>2.3.1</version>
</dependency>

第二步：被監(jiān)控的服務中配置文件配置監(jiān)控項目的url