歡迎訪問(wèn)我的GitHub

https://github.com/zq2599/blog_demos

內(nèi)容：所有原創(chuàng)文章分類匯總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；

關(guān)于《JUnit5學(xué)習(xí)》系列

《JUnit5學(xué)習(xí)》系列旨在通過(guò)實(shí)戰(zhàn)提升SpringBoot環(huán)境下的單元測(cè)試技能，一共八篇文章，鏈接如下：

1. 基本操作
2. Assumptions類
3. Assertions類
4. 按條件執(zhí)行
5. 標(biāo)簽(Tag)和自定義注解
6. 參數(shù)化測(cè)試(Parameterized Tests)基礎(chǔ)
7. 參數(shù)化測(cè)試(Parameterized Tests)進(jìn)階
8. 綜合進(jìn)階（終篇）

本篇概覽

• 本文是《JUnit5學(xué)習(xí)》系列的第七篇，前文咱們對(duì)JUnit5的參數(shù)化測(cè)試(Parameterized Tests)有了基本了解，可以使用各種數(shù)據(jù)源控制測(cè)試方法多次執(zhí)行，今天要在此基礎(chǔ)上更加深入，掌握參數(shù)化測(cè)試的一些高級(jí)功能，解決實(shí)際問(wèn)題；
• 本文由以下章節(jié)組成：

1. 自定義數(shù)據(jù)源
2. 參數(shù)轉(zhuǎn)換
3. 多字段聚合
4. 多字段轉(zhuǎn)對(duì)象
5. 測(cè)試執(zhí)行名稱自定義

源碼下載

1. 如果您不想編碼，可以在GitHub下載所有源碼，地址和鏈接信息如下表所示：

2. 這個(gè)git項(xiàng)目中有多個(gè)文件夾，本章的應(yīng)用在<font color="blue">junitpractice</font>文件夾下，如下圖紅框所示：

在這里插入圖片描述

3. <font color="blue">junitpractice</font>是父子結(jié)構(gòu)的工程，本篇的代碼在<font color="red">parameterized</font>子工程中，如下圖：

在這里插入圖片描述

自定義數(shù)據(jù)源

1. 前文使用了很多種數(shù)據(jù)源，如果您對(duì)它們的各種限制不滿意，想要做更徹底的個(gè)性化定制，可以開發(fā)<font color="blue">ArgumentsProvider</font>接口的實(shí)現(xiàn)類，并使用<font color="blue">@ArgumentsSource</font>指定；
2. 舉個(gè)例子，先開發(fā)ArgumentsProvider的實(shí)現(xiàn)類<font color="blue">MyArgumentsProvider.java</font>：

package com.bolingcavalry.parameterized.service.impl;

import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.ArgumentsProvider;
import java.util.stream.Stream;

public class MyArgumentsProvider implements ArgumentsProvider {

    @Override
    public Stream<? extends Arguments> provideArguments(ExtensionContext context) throws Exception {
        return Stream.of("apple4", "banana4").map(Arguments::of);
    }
}

3. 再給測(cè)試方法添加<font color="blue">@ArgumentsSource</font>，并指定<font color="red">MyArgumentsProvider</font>：

    @Order(15)
    @DisplayName("ArgumentsProvider接口的實(shí)現(xiàn)類提供的數(shù)據(jù)作為入?yún)?)
    @ParameterizedTest
    @ArgumentsSource(MyArgumentsProvider.class)
    void argumentsSourceTest(String candidate) {
        log.info("argumentsSourceTest [{}]", candidate);
    }

4. 執(zhí)行結(jié)果如下：

在這里插入圖片描述

參數(shù)轉(zhuǎn)換

1. 參數(shù)化測(cè)試的數(shù)據(jù)源和測(cè)試方法入?yún)⒌臄?shù)據(jù)類型必須要保持一致嗎？其實(shí)JUnit5并沒(méi)有嚴(yán)格要求，而事實(shí)上JUnit5是可以做一些自動(dòng)或手動(dòng)的類型轉(zhuǎn)換的；
2. 如下代碼，數(shù)據(jù)源是int型數(shù)組，但測(cè)試方法的入?yún)s是double：

    @Order(16)
    @DisplayName("int型自動(dòng)轉(zhuǎn)為double型入?yún)?)
    @ParameterizedTest
    @ValueSource(ints = { 1,2,3 })
    void argumentConversionTest(double candidate) {
        log.info("argumentConversionTest [{}]", candidate);
    }

3. 執(zhí)行結(jié)果如下，可見int型被轉(zhuǎn)為double型傳給測(cè)試方法（Widening Conversion）：

在這里插入圖片描述

4. 還可以指定轉(zhuǎn)換器，以轉(zhuǎn)換器的邏輯進(jìn)行轉(zhuǎn)換，下面這個(gè)例子就是將字符串轉(zhuǎn)為L(zhǎng)ocalDate類型，關(guān)鍵是<font color="blue">@JavaTimeConversionPattern</font>：

    @Order(17)
    @DisplayName("string型，指定轉(zhuǎn)換器，轉(zhuǎn)為L(zhǎng)ocalDate型入?yún)?)
    @ParameterizedTest
    @ValueSource(strings = { "01.01.2017", "31.12.2017" })
    void argumentConversionWithConverterTest(
            @JavaTimeConversionPattern("dd.MM.yyyy") LocalDate candidate) {
        log.info("argumentConversionWithConverterTest [{}]", candidate);
    }

5. 執(zhí)行結(jié)果如下：

在這里插入圖片描述

字段聚合(Argument Aggregation)

1. 來(lái)思考一個(gè)問(wèn)題：如果數(shù)據(jù)源的每條記錄有多個(gè)字段，測(cè)試方法如何才能使用這些字段呢？
2. 回顧剛才的@CsvSource示例，如下圖，可見測(cè)試方法用兩個(gè)入?yún)?duì)應(yīng)CSV每條記錄的兩個(gè)字段，如下所示：

在這里插入圖片描述

3. 上述方式應(yīng)對(duì)少量字段還可以，但如果CSV每條記錄有很多字段，那測(cè)試方法豈不是要定義大量入?yún)?？這顯然不合適，此時(shí)可以考慮JUnit5提供的字段聚合功能<font color="blue">(Argument Aggregation)</font>，也就是將CSV每條記錄的所有字段都放入一個(gè)<font color="blue">ArgumentsAccessor</font>類型的對(duì)象中，測(cè)試方法只要聲明ArgumentsAccessor類型作為入?yún)?，就能在方法?nèi)部取得CSV記錄的所有字段，效果如下圖，可見CSV字段實(shí)際上是保存在ArgumentsAccessor實(shí)例內(nèi)部的一個(gè)Object數(shù)組中：

在這里插入圖片描述

4. 如下圖，為了方便從ArgumentsAccessor實(shí)例獲取數(shù)據(jù)，ArgumentsAccessor提供了獲取各種類型的方法，您可以按實(shí)際情況選用：

在這里插入圖片描述

5. 下面的示例代碼中，CSV數(shù)據(jù)源的每條記錄有三個(gè)字段，而測(cè)試方法只有一個(gè)入?yún)?，類型是ArgumentsAccessor，在測(cè)試方法內(nèi)部，可以用ArgumentsAccessor的getString、get等方法獲取CSV記錄的不同字段，例如<font color="blue">arguments.getString(0)</font>就是獲取第一個(gè)字段，得到的結(jié)果是字符串類型，而<font color="blue">arguments.get(2, Types.class)</font>的意思是獲取第二個(gè)字段，并且轉(zhuǎn)成了Type.class類型：

    @Order(18)
    @DisplayName("CsvSource的多個(gè)字段聚合到ArgumentsAccessor實(shí)例")
    @ParameterizedTest
    @CsvSource({
            "Jane1, Doe1, BIG",
            "John1, Doe1, SMALL"
    })
    void argumentsAccessorTest(ArgumentsAccessor arguments) {
        Person person = new Person();
        person.setFirstName(arguments.getString(0));
        person.setLastName(arguments.getString(1));
        person.setType(arguments.get(2, Types.class));

        log.info("argumentsAccessorTest [{}]", person);
    }

6. 上述代碼執(zhí)行結(jié)果如下圖，可見通過(guò)<font color="blue">ArgumentsAccessor</font>能夠取得CSV數(shù)據(jù)的所有字段：

在這里插入圖片描述

更優(yōu)雅的聚合

1. 前面的聚合解決了獲取CSV數(shù)據(jù)多個(gè)字段的問(wèn)題，但依然有瑕疵：從ArgumentsAccessor獲取數(shù)據(jù)生成Person實(shí)例的代碼寫在了測(cè)試方法中，如下圖紅框所示，測(cè)試方法中應(yīng)該只有單元測(cè)試的邏輯，而創(chuàng)建Person實(shí)例的代碼放在這里顯然并不合適：

在這里插入圖片描述

2. 針對(duì)上面的問(wèn)題，JUnit5也給出了方案：通過(guò)注解的方式，指定一個(gè)從ArgumentsAccessor到Person的轉(zhuǎn)換器，示例如下，可見測(cè)試方法的入?yún)⒂袀€(gè)注解<font color="blue">@AggregateWith</font>，其值PersonAggregator.class就是從ArgumentsAccessor到Person的轉(zhuǎn)換器，而入?yún)⒁呀?jīng)從前面的<font color="blue">ArgumentsAccessor</font>變成了<font color="red">Person</font>：

    @Order(19)
    @DisplayName("CsvSource的多個(gè)字段，通過(guò)指定聚合類轉(zhuǎn)為Person實(shí)例")
    @ParameterizedTest
    @CsvSource({
            "Jane2, Doe2, SMALL",
            "John2, Doe2, UNKNOWN"
    })
    void customAggregatorTest(@AggregateWith(PersonAggregator.class) Person person) {
        log.info("customAggregatorTest [{}]", person);
    }

3. <font color="blue">PersonAggregator</font>是轉(zhuǎn)換器類，需要實(shí)現(xiàn)ArgumentsAggregator接口，具體的實(shí)現(xiàn)代碼很簡(jiǎn)單，也就是從ArgumentsAccessor示例獲取字段創(chuàng)建Person對(duì)象的操作：

package com.bolingcavalry.parameterized.service.impl;

import org.junit.jupiter.api.extension.ParameterContext;
import org.junit.jupiter.params.aggregator.ArgumentsAccessor;
import org.junit.jupiter.params.aggregator.ArgumentsAggregationException;
import org.junit.jupiter.params.aggregator.ArgumentsAggregator;

public class PersonAggregator implements ArgumentsAggregator {

    @Override
    public Object aggregateArguments(ArgumentsAccessor arguments, ParameterContext context) throws ArgumentsAggregationException {

        Person person = new Person();
        person.setFirstName(arguments.getString(0));
        person.setLastName(arguments.getString(1));
        person.setType(arguments.get(2, Types.class));

        return person;
    }
}

4. 上述測(cè)試方法的執(zhí)行結(jié)果如下：

在這里插入圖片描述

進(jìn)一步簡(jiǎn)化

1. 回顧一下剛才用注解指定轉(zhuǎn)換器的代碼，如下圖紅框所示，您是否回憶起JUnit5支持自定義注解這一茬，咱們來(lái)把紅框部分的代碼再簡(jiǎn)化一下：

在這里插入圖片描述

2. 新建注解類<font color="blue">CsvToPerson.java</font>，代碼如下，非常簡(jiǎn)單，就是把上圖紅框中的<font color="blue">@AggregateWith(PersonAggregator.class)</font>搬過(guò)來(lái)了：

package com.bolingcavalry.parameterized.service.impl;

import org.junit.jupiter.params.aggregator.AggregateWith;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
@AggregateWith(PersonAggregator.class)
public @interface CsvToPerson {
}

3. 再來(lái)看看上圖紅框中的代碼可以簡(jiǎn)化成什么樣子，直接用@CsvToPerson就可以將ArgumentsAccessor轉(zhuǎn)為Person對(duì)象了：

    @Order(20)
    @DisplayName("CsvSource的多個(gè)字段，通過(guò)指定聚合類轉(zhuǎn)為Person實(shí)例(自定義注解)")
    @ParameterizedTest
    @CsvSource({
            "Jane3, Doe3, BIG",
            "John3, Doe3, UNKNOWN"
    })
    void customAggregatorAnnotationTest(@CsvToPerson Person person) {
        log.info("customAggregatorAnnotationTest [{}]", person);
    }

4. 執(zhí)行結(jié)果如下，可見和<font color="blue">@AggregateWith(PersonAggregator.class)</font>效果一致：

在這里插入圖片描述

測(cè)試執(zhí)行名稱自定義

1. 文章最后，咱們來(lái)看個(gè)輕松的知識(shí)點(diǎn)吧，如下圖紅框所示，每次執(zhí)行測(cè)試方法，IDEA都會(huì)展示這次執(zhí)行的序號(hào)和參數(shù)值：

在這里插入圖片描述

2. 其實(shí)上述紅框中的內(nèi)容格式也可以定制，格式模板就是<font color="blue">@ParameterizedTest</font>的<font color="red">name</font>屬性，修改后的測(cè)試方法完整代碼如下，可見這里改成了中文描述信息：

    @Order(21)
    @DisplayName("CSV格式多條記錄入?yún)?自定義展示名稱)")
    @ParameterizedTest(name = "序號(hào) [{index}]，fruit參數(shù) [{0}]，rank參數(shù) [{1}]")
    @CsvSource({
            "apple3, 31",
            "banana3, 32",
            "'lemon3, lime3', 0x3A"
    })
    void csvSourceWithCustomDisplayNameTest(String fruit, int rank) {
        log.info("csvSourceWithCustomDisplayNameTest, fruit [{}], rank [{}]", fruit, rank);
    }

3. 執(zhí)行結(jié)果如下：

在這里插入圖片描述

• 至此，JUnit5的參數(shù)化測(cè)試(Parameterized)相關(guān)的知識(shí)點(diǎn)已經(jīng)學(xué)習(xí)和實(shí)戰(zhàn)完成了，掌握了這么強(qiáng)大的參數(shù)輸入技術(shù)，咱們的單元測(cè)試的代碼覆蓋率和場(chǎng)景范圍又可以進(jìn)一步提升了；

你不孤單，欣宸原創(chuàng)一路相伴

1. Java系列
2. Spring系列
3. Docker系列
4. kubernetes系列
5. 數(shù)據(jù)庫(kù)+中間件系列
6. DevOps系列

歡迎關(guān)注公眾號(hào)：程序員欣宸

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