基於AbstractProcessor擴展MapStruct自動生成實體映射工具類

来源:https://www.cnblogs.com/Jcloud/archive/2023/01/28/17069764.html
-Advertisement-
Play Games

作者：京東物流 王北永 姚再毅 1 背景 日常開發過程中，尤其在 DDD 過程中，經常遇到 VO/MODEL/PO 等領域模型的相互轉換。此時我們會一個欄位一個欄位進行 set|get 設置。要麼使用工具類進行暴力的屬性拷貝，在這個暴力屬性拷貝過程中好的工具更能提高程式的運行效率，反之引起性能低下、 ...


作者：京東物流 王北永 姚再毅

1 背景

日常開發過程中，尤其在 DDD 過程中，經常遇到 VO/MODEL/PO 等領域模型的相互轉換。此時我們會一個欄位一個欄位進行 set|get 設置。要麼使用工具類進行暴力的屬性拷貝，在這個暴力屬性拷貝過程中好的工具更能提高程式的運行效率，反之引起性能低下、隱藏細節設置 OOM 等極端情況出現。

2 現有技術

  1. 直接 set|get 方法：欄位少時還好，當欄位非常大時工作量巨大，重覆操作，費時費力。
  1. 通過反射 + 內省的方式實現值映射實現：比如許多開源的 apache-common、spring、hutool 工具類都提供了此種實現工具。這種方法的缺點就是性能低、黑盒屬性拷貝。不同工具類的處理又有區別：spring 的屬性拷貝會忽略類型轉換但不報錯、hutool 會自動進行類型轉、有些工具設置拋出異常等等。出現生產問題，定位比較困難。
  1. mapstruct：使用前需要手動定義轉換器介面，根據介面類註解和方法註解自動生成實現類，屬性轉換邏輯清晰，但是不同的領域對象轉換還需要單獨寫一層轉換介面或者添加一個轉換方法。

3 擴展設計

3.1 mapstruct 介紹

本擴展組件基於 mapstruct 進行擴展，簡單介紹 mapstruct 實現原理。

mapstruct 是基於 JSR 269 實現的，JSR 269 是 JDK 引進的一種規範。有了它，能夠實現在編譯期處理註解，並且讀取、修改和添加抽象語法樹中的內容。JSR 269 使用 Annotation Processor 在編譯期間處理註解，Annotation Processor 相當於編譯器的一種插件，因此又稱為插入式註解處理。

我們知道，java 的類載入機制是需要通過編譯期運行期。如下圖所示

mapstruct 正是在上面的編譯期編譯源碼的過程中，通過修改語法樹二次生成位元組碼，如下圖所示

以上大概可以概括如下幾個步驟：

1、生成抽象語法樹。Java 編譯器對 Java 源碼進行編譯，生成抽象語法樹（Abstract Syntax Tree，AST）。

2、調用實現了 JSR 269 API 的程式。只要程式實現了 JSR 269 API，就會在編譯期間調用實現的註解處理器。

3、修改抽象語法樹。在實現 JSR 269 API 的程式中，可以修改抽象語法樹，插入自己的實現邏輯。

4、生成位元組碼。修改完抽象語法樹後，Java 編譯器會生成修改後的抽象語法樹對應的位元組碼文件件。

從 mapstruct 實現原理來看，我們發現 mapstruct 屬性轉換邏輯清晰，具備良好的擴展性，問題是需要單獨寫一層轉換介面或者添加一個轉換方法。能否將轉換介面或者方法做到自動擴展呢？

3.2 改進方案

上面所說 mapstruct 方案，有個弊端。就是如果有新的領域模型轉換，我們不得不手動寫一層轉換介面，如果出現 A/B 兩個模型互轉，一般需定義四個方法：

image.png

鑒於此，本方案通過將原 mapstruct 定義在轉換介面類註解和轉換方法的註解，通過映射，形成新包裝註解。將此註解直接定義在模型的類或者欄位上，然後根據模型上的自定義註解直接編譯期生成轉換介面，然後 mapstruct 根據自動生成的介面再次生成具體的轉換實現類。

註意：自動生成的介面中類和方法的註解為原 mapstruct 的註解，所以 mapstruct 原有功能上沒有丟失。詳細調整如下圖：

4 實現

4.1 技術依賴

  1. 編譯期註解處理器 AbstractProcessor：Annotation Processor 相當於編譯器的一種插件，因此又稱為插入式註解處理。想要實現 JSR 269，主要有以下幾個步驟。

1）繼承 AbstractProcessor 類，並且重寫 process 方法，在 process 方法中實現自己的註解處理邏輯。

2）在 META-INF/services 目錄下創建 javax.annotation.processing.Processor 文件註冊自己實現的

  1. 谷歌 AutoService：AutoService 是 Google 開源的用來方便生成符合 ServiceLoader 規範的開源庫，使用非常的簡單。只需要增加註解，便可自動生成規範約束文件。

知識點： 使用 AutoService 的好處是幫助我們不需要手動維護 Annotation Processor 所需要的 META-INF 文件目錄和文件內容。它會自動幫我們生產，使用方法也很簡單，只需要在自定義的 Annotation Processor 類上加上以下註解即可 @AutoService (Processor.class)

  1. mapstruct：幫助實現自定義插件自動生成的轉換介面，並註入到 spring 容器中 (現有方案中已做說明)。
  2. javapoet：JavaPoet 是一個動態生成代碼的開源庫。幫助我們簡單快速的生成 java 類文件，期主要特點如下：

  1. JavaPoet 是一款可以自動生成 Java 文件的第三方依賴。

  2. 簡潔易懂的 API，上手快。

  3. 讓繁雜、重覆的 Java 文件，自動化生成，提高工作效率，簡化流程。

4.2 實現步驟

  • 第一步：自動生成轉換介面類所需的枚舉，分別為類註解 AlpacaMap 和欄位註解 AlpacaMapField。

1） AlpacaMap：定義在類上，屬性 target 指定所轉換目標模型；屬性 uses 指定雷專轉換過程中所依賴的外部對象。

2）AlpacaMapField：原始 mapstruct 所支持的所有註解做一次別名包裝，使用 spring 提供的 AliasFor 註解。

知識點： @AliasFor 是 Spring 框架的一個註解，用於聲明註解屬性的別名。它有兩種不同的應用場景：

註解內的別名

元數據的別名

兩者主要的區別在於是否在同一個註解內。

  • 第二步：AlpacaMapMapperDescriptor 實現。此類主要功能是載入使用第一步定義枚舉的所有模型類，然後將類的信息和類 Field 信息保存起來方便後面直接使用，片段邏輯如下：
AutoMapFieldDescriptor descriptor = new AutoMapFieldDescriptor();
            descriptor.target = fillString(alpacaMapField.target());
            descriptor.dateFormat = fillString(alpacaMapField.dateFormat());
            descriptor.numberFormat = fillString(alpacaMapField.numberFormat());
            descriptor.constant = fillString(alpacaMapField.constant());
            descriptor.expression = fillString(alpacaMapField.expression());
            descriptor.defaultExpression = fillString(alpacaMapField.defaultExpression());
            descriptor.ignore = alpacaMapField.ignore();
             ..........

  • 第三步：AlpacaMapMapperGenerator 類主要是通過 JavaPoet 生成對應的類信息、類註解、類方法以及方法上的註解信息
生成類信息：TypeSpec createTypeSpec(AlpacaMapMapperDescriptor descriptor)
生成類註解信息 AnnotationSpec buildGeneratedMapperConfigAnnotationSpec(AlpacaMapMapperDescriptor descriptor) {
生成類方法信息： MethodSpec buildMappingMethods(AlpacaMapMapperDescriptor descriptor)
生成方法註解信息：List<AnnotationSpec> buildMethodMappingAnnotations(AlpacaMapMapperDescriptor descriptor){

在實現生成類信息過程中，需要指定生成類的介面類 AlpacaBaseAutoAssembler，此類主要定義四個方法如下：

public interface AlpacaBaseAutoAssembler<S,T>{
    T copy(S source);

    default List<T> copyL(List<S> sources){
        return sources.stream().map(c->copy(c)).collect(Collectors.toList());
    }

    @InheritInverseConfiguration(name = "copy")
    S reverseCopy(T source);

    default List<S> reverseCopyL(List<T> sources){
        return sources.stream().map(c->reverseCopy(c)).collect(Collectors.toList());
    }
}
  • 第四步：因為生成的類轉換器是註入 spring 容器的。所以需要頂一個專門生成 mapstruct 註入 spring 容器的註解，此註解通過類 AlpacaMapSpringConfigGenerator 自動生成，核心代碼如下
private AnnotationSpec buildGeneratedMapperConfigAnnotationSpec() {
        return AnnotationSpec.builder(ClassName.get("org.mapstruct", "MapperConfig"))
                .addMember("componentModel", "$S", "spring")
                .build();
    }
  • 第五步：通過以上步驟，我們定義好了相關類、相關類的方法、相關類的註解、相關類方法的註解。此時將他們串起來通過 Annotation Processor 生成類文件輸出，核心方法如下
private void writeAutoMapperClassFile(AlpacaMapMapperDescriptor descriptor){
        System.out.println("開始生成介面："+descriptor.sourcePackageName() + "."+ descriptor.mapperName());
        try (final Writer outputWriter =
                     processingEnv
                             .getFiler()
                             .createSourceFile(  descriptor.sourcePackageName() + "."+ descriptor.mapperName())
                             .openWriter()) {
            alpacaMapMapperGenerator.write(descriptor, outputWriter);
        } catch (IOException e) {
            processingEnv
                    .getMessager()
                    .printMessage( ERROR,   "Error while opening "+ descriptor.mapperName()  + " output file: " + e.getMessage());
        }
    }

知識點： 在 javapoet 中核心類第一大概有一下幾個類，可參考如下：

JavaFile 用於構造輸出包含一個頂級類的 Java 文件，是對.java 文件的抽象定義

TypeSpec TypeSpec 是類 / 介面 / 枚舉的抽象類型

MethodSpec MethodSpec 是方法 / 構造函數的抽象定義

FieldSpec FieldSpec 是成員變數 / 欄位的抽象定義

ParameterSpec ParameterSpec 用於創建方法參數

AnnotationSpec AnnotationSpec 用於創建標記註解

5 實踐

下麵舉例說明如何使用，在這裡我們定義一個模型 Person 和模型 Student，其中涉及欄位轉換的普通字元串、枚舉、時間格式化和複雜的類型換磚，具體運用如下步驟。

5.1 引入依賴

代碼已上傳代碼庫，如需特定需求可重新拉去分支打包使用

<dependency>
            <groupId>com.jdl</groupId>
            <artifactId>alpaca-mapstruct-processor</artifactId>
            <version>1.1-SNAPSHOT</version>
        </dependency>

5.2 對象定義

uses 方法必須為正常的 spring 容器中的 bean，此 bean 提供 @Named 註解的方法可供類欄位註解 AlpacaMapField 中的 qualifiedByName 屬性以字元串的方式指定，如下圖所示

@Data
@AlpacaMap(targetType = Student.class,uses = {Person.class})
@Service
public class Person {
    private String make;
    private SexType type;

    @AlpacaMapField(target = "age")
    private Integer sax;

    @AlpacaMapField(target="dateStr" ,dateFormat = "yyyy-MM-dd")
    private Date date;

    @AlpacaMapField(target = "brandTypeName",qualifiedByName ="convertBrandTypeName")
    private Integer brandType;

    @Named("convertBrandTypeName")
    public  String convertBrandTypeName(Integer brandType){
        return BrandTypeEnum.getDescByValue(brandType);
    }

    @Named("convertBrandTypeName")
    public  Integer convertBrandType(String brandTypeName){
        return BrandTypeEnum.getValueByDesc(brandTypeName);
    }
}

5.3 生成結果

使用 maven 打包或者編譯後觀察，此時在 target/generated-source/annotatins 目錄中生成兩個文件 PersonToStudentAssembler 和 PersonToStudentAssemblerImpl

類文件 PersonToStudentAssembler 是由自定義註解器自動生成，內容如下

@Mapper(
    config = AutoMapSpringConfig.class,
    uses = {Person.class}
)
public interface PersonToStudentAssembler extends AlpacaBaseAutoAssembler<Person, Student> {
  @Override
  @Mapping(
      target = "age",
      source = "sax",
      ignore = false
  )
  @Mapping(
      target = "dateStr",
      dateFormat = "yyyy-MM-dd",
      source = "date",
      ignore = false
  )
  @Mapping(
      target = "brandTypeName",
      source = "brandType",
      ignore = false,
      qualifiedByName = "convertBrandTypeName"
  )
  Student copy(final Person source);
}

PersonToStudentAssemblerImpl 是 mapstruct 根據 PersonToStudentAssembler 介面註解器自動生成，內容如下

@Component
public class PersonToStudentAssemblerImpl implements PersonToStudentAssembler {

    @Autowired
    private Person person;

    @Override
    public Person reverseCopy(Student arg0) {
        if ( arg0 == null ) {
            return null;
        }
        Person person = new Person();
        person.setSax( arg0.getAge() );
        try {
            if ( arg0.getDateStr() != null ) {
                person.setDate( new SimpleDateFormat( "yyyy-MM-dd" ).parse( arg0.getDateStr() ) );
            }
        } catch ( ParseException e ) {
            throw new RuntimeException( e );
        }
        person.setBrandType( person.convertBrandType( arg0.getBrandTypeName() ) );
        person.setMake( arg0.getMake() );
        person.setType( arg0.getType() );
        return person;
    }

    @Override
    public Student copy(Person source) {
        if ( source == null ) {
            return null;
        }
        Student student = new Student();
        student.setAge( source.getSax() );
        if ( source.getDate() != null ) {
            student.setDateStr( new SimpleDateFormat( "yyyy-MM-dd" ).format( source.getDate() ) );
        }
        student.setBrandTypeName( person.convertBrandTypeName( source.getBrandType() ) );
        student.setMake( source.getMake() );
        student.setType( source.getType() );
        return student;
    }
}

5.4 Spring 容器引用

此時在我們的 spring 容器中可直接 @Autowired 引入介面 PersonToStudentAssembler 實例進行四種維護數據相互轉換

AnnotationConfigApplicationContext applicationContext = new  AnnotationConfigApplicationContext();
        applicationContext.scan("com.jdl.alpaca.mapstruct");
        applicationContext.refresh();
        PersonToStudentAssembler personToStudentAssembler = applicationContext.getBean(PersonToStudentAssembler.class);
        Person person = new Person();
        person.setMake("make");
        person.setType(SexType.BOY);
        person.setSax(100);
        person.setDate(new Date());
        person.setBrandType(1);
        Student student = personToStudentAssembler.copy(person);
        System.out.println(student);
        System.out.println(personToStudentAssembler.reverseCopy(student));
        List<Person> personList = Lists.newArrayList();
        personList.add(person);
        System.out.println(personToStudentAssembler.copyL(personList));
        System.out.println(personToStudentAssembler.reverseCopyL(personToStudentAssembler.copyL(personList)));

控制台列印：

personToStudentStudent(make=make, type=BOY, age=100, dateStr=2022-11-09, brandTypeName=集團KA)
studentToPersonPerson(make=make, type=BOY, sax=100, date=Wed Nov 09 00:00:00 CST 2022, brandType=1)
personListToStudentList[Student(make=make, type=BOY, age=100, dateStr=2022-11-09, brandTypeName=集團KA)]
studentListToPersonList[Person(make=make, type=BOY, sax=100, date=Wed Nov 09 00:00:00 CST 2022, brandType=1)]

註意：

  • qualifiedByName 註解屬性使用不太友好，如果使用到此屬性時，需要定義反轉類型轉換函數。因為在前面我們定義的抽象介面 AlpacaBaseAutoAssembler 有如下圖一個註解，從目的對象到源對象的反轉映射，因為 java 的重載性，同名不同參非同一個方法，所以在 S 轉 T 的時候回找不到此方法。故需要自行定義好轉換函數
@InheritInverseConfiguration(name = "copy")

比如從 S 轉換 T 會使用第一個方法，從 T 轉 S 的時候必須定義一個同名 Named 註解的方法，方法參數和前面方法是入參變出參、出參變入參。

@Named("convertBrandTypeName")
    public  String convertBrandTypeName(Integer brandType){
        return BrandTypeEnum.getDescByValue(brandType);
    }

    @Named("convertBrandTypeName")
    public  Integer convertBrandType(String brandTypeName){
        return BrandTypeEnum.getValueByDesc(brandTypeName);
    }
  • 在使用 qualifiedByName 註解時，指定的 Named 註解方法必須定義為 spring 容器可管理的對象，並需要通過模型類註解屬性 used 引入此對象 Class

知識點：

InheritInverseConfiguration 功能很強大，可以逆向映射，從上面 PersonToStudentAssemblerImpl 看到上面屬性 sax 可以正映射到 sex，逆映射可自動從 sex 映射到 sax。但是正映射的 @Mapping#expression、#defaultExpression、#defaultValue 和 #constant 會被逆映射忽略。此外某個欄位的逆映射可以被 ignore，expression 或 constant 覆蓋

6 結束語

參考文檔：

https://github.com/google/auto/tree/master/service

https://mapstruct.org/

https://github.com/square/javapoet


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • C 語言輸出100至200之間的質數（素數）
    題目描述 運行 C 程式，輸出 100 至 200 之間的質數。 輸入描述 無 輸出描述 輸出 100 至 200 之間的質數，每行輸出一個質數，每個質數前面需要帶有序號。 輸出樣例 解題思路 在《一文解決如何使用 C 語言判斷質數（素數）》一文中，我詳細講解了質數以及如何使用 C 語言判斷質數，本 ...
  • day12-實現Spring底層機制-02
    實現Spring底層機制-02 3.實現任務階段1 3.1知識拓展-類載入器 Java的類載入器有三種： Bootstrap類載入器 對應路徑 jre/lib Ext類載入器 對應路徑 jre/lib/ext App類載入器 對應路徑 classpath classpath 類路徑，就是java.e ...
  • 《RPC實戰與核心原理》學習筆記Day11
    這篇文章主要討論在RPC框架下如何優雅關閉和啟動服務，包括服務提供方如何通知調用方服務關閉重啟信息，服務提供方如何在關閉後處理現有請求和心情求；服務啟動時，如何實現啟動預熱和延遲暴露。 ...
  • Collection常用方法【彙總】
    Collection常用方法彙總 Collection公共的方法 Collection是單列結合的祖宗介面，它的方法是所有單列集合都可以繼承使用的。 //把給定元素添加到集合中 public boolean add(E e) //把給定元素從集合中刪除 public boolean remove(E ...
  • 對於Java平臺的理解
    談談你對 Java 平臺的理解？“Java 是解釋執行”，這句話正確嗎？ Java 本身是一種面向對象的語言，最顯著的特性有兩個方面，一是所謂的“一處編譯，處處運行”（Write once,run anywhere）,能夠非常容易地獲得跨平臺能力；另外就是垃圾收集（GC,Garbage Collec ...
  • python圖片拼接
    首先我們來嘗試將分片的圖片複原為正常的圖片 這裡是六張切成小細條的圖片，原本是一張大圖的，現在我們用python將他們合併到一塊，題外話圖片來源於中華連環畫，*http://www.zhlhh.com/* 這個網站內有很多優秀的連環畫，而且大部分都是免費，推薦給大家 我的思路是用matlib讀圖片， ...
  • 引子 - 實現輕量的 ioc 容器
    IoC 反轉控制原則也被叫做依賴註入 DI, 容器按照配置註入實例化的對象. 本文將實現一個輕量化的 IoC 容器, 完成對象的實例化和註入, 基於註解不依賴於任何庫. (註解參考 JSR-330) ...
  • 04HDFS簡介
    隨著業務的發展，系統會越來越龐大，原本簡單穩定的功能，可能在不斷迭代後複雜度上升，潛在的風險也隨之暴露，導致最終服務不穩定，造成業務價值的損失。而為了減少這種情況，其中一種比較好的方式就是提高代碼質量，比如通過代碼審查，從而降低錯誤風險，但是，代碼審查難度大，代碼缺陷、漏洞不易發現，且審查工作隨著代 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類