12.10 優雅的對象轉換解決方案-MapStructshiyon

1 MapStruct 是什麼?

1.1 JavaBean 的困擾

對於代碼中 JavaBean之間的轉換, 一直是困擾我很久的事情。 在開發的時候我看到業務代碼之間有很多的 JavaBean 之間的相互轉化, 非常的影響觀感, 卻又不得不存在。 我後來想的一個辦法就是通過反射, 或者自己寫很多的轉換器。

第一種通過反射的方法確實比較方便, 但是現在無論是 BeanUtils, BeanCopier 等在使用反射的時候都會影響到性能。 雖然我們可以進行反射信息的緩存來提高性能。 但是像這種的話, 需要類型和名稱都一樣才會進行映射, 有很多時候, 由於不同的團隊之間使用的名詞不一樣, 還是需要很多的手動 set/get 等功能。

第二種的話就是會很浪費時間, 而且在添加新的字段的時候也要進行方法的修改。 不過, 由於不需要進行反射, 其性能是很高的。

1.2 MapStruct 帶來的改變

MapSturct 是一個生成類型安全, 高性能且無依賴的 JavaBean 映射代碼的註解處理器(annotation processor)。

抓一下重點:

  1. 註解處理器
  2. 可以生成 JavaBean 之間那的映射代碼
  3. 類型安全, 高性能, 無依賴性

從字面的理解, 我們可以知道, 該工具可以幫我們實現 JavaBean 之間的轉換, 通過註解的方式。

同時, 作為一個工具類,相比於手寫, 其應該具有便捷, 不容易出錯的特點。

2 MapStruct 入門

入門很簡單。 我是基於 Maven 來進行項目 jar 包管理的。

2.1 引入依賴


優雅的對象轉換解決方案-MapStructshiyon

2.2 創建entity和dto對象

該類是從 github 某個訂單系統裡面拿下來的部分。


優雅的對象轉換解決方案-MapStructshiyon

對應的查詢參數


優雅的對象轉換解決方案-MapStructshiyon

2.3 寫 Mapper

Mapper 即映射器, 一般來說就是寫 xxxMapper 接口。 當然, 不一定是以 Mapper 結尾的。 只是官方是這麼寫的。 在本入門例子中,對應的接口如下


優雅的對象轉換解決方案-MapStructshiyon

簡單的映射(字段和類型都匹配), 只有一個要求, 在接口上寫 @Mapper 註解即可。 然後方法上, 入參對應要被轉化的對象, 返回值對應轉化後的對象, 方法名稱可任意。

2.4 測試

寫一個測試類測試一下。

優雅的對象轉換解決方案-MapStructshiyon

3 MapStruct 分析

上面中, 我寫了3個步驟來實現了從 Order 到 OrderQueryParam 的轉換。

那麼, 作為一個註解處理器, 通過MapStruct 生成的代碼具有怎麼樣的優勢呢?

3.1 高性能

這是相對反射來說的, 反射需要去讀取字節碼的內容, 花銷會比較大。 而通過 MapStruct 來生成的代碼, 其類似於人手寫。 速度上可以得到保證。

前面例子中生成的代碼可以在編譯後看到。 在 target/generated-sources/annotations 裡可以看到。

優雅的對象轉換解決方案-MapStructshiyon

對應的代碼

優雅的對象轉換解決方案-MapStructshiyon

可以看到其生成了一個實現類, 而代碼也類似於我們手寫, 通俗易懂。

3.2 易於 debug

在我們生成的代碼中, 我們可以輕易的進行 debug。

優雅的對象轉換解決方案-MapStructshiyon

在使用反射的時候, 如果出現了問題, 很多時候是很難找到是什麼原因的。

3.3 使用相對簡單

如果是完全映射的, 使用起來肯定沒有反射簡單。 用類似 BeanUtils 這些工具一條語句就搞定了。 但是,如果需要進行特殊的匹配(特殊類型轉換, 多對一轉換等), 其相對來說也是比較簡單的。

基本上, 使用的時候, 我們只需要聲明一個接口, 接口下寫對應的方法, 就可以使用了。 當然, 如果有特殊情況, 是需要額外處理的。

3.4 代碼獨立

生成的代碼是對立的, 沒有運行時的依賴。


分享到:


相關文章: