第一次看到 MapStruct 的時(shí)候轧简， 我個(gè)人非常的開心吉懊。因?yàn)槠涓覂?nèi)心里面的想法不謀而合假勿。
1 MapStruct 是什么？
1.1 JavaBean 的困擾
對(duì)于代碼中 JavaBean之間的轉(zhuǎn)換恶导， 一直是困擾我很久的事情浸须。在開發(fā)的時(shí)候我看到業(yè)務(wù)代碼之間有很多的 JavaBean 之間的相互轉(zhuǎn)化， 非常的影響觀感裂垦， 卻又不得不存在蕉拢。我后來想的一個(gè)辦法就是通過反射， 或者自己寫很多的轉(zhuǎn)換器午乓。整理了一份Java面試寶典完整版PDF已整理成文檔
第一種通過反射的方法確實(shí)比較方便闸准， 但是現(xiàn)在無論是 BeanUtils, BeanCopier 等在使用反射的時(shí)候都會(huì)影響到性能夷家。雖然我們可以進(jìn)行反射信息的緩存來提高性能。但是像這種的話枣接， 需要類型和名稱都一樣才會(huì)進(jìn)行映射缺谴， 有很多時(shí)候湿蛔， 由于不同的團(tuán)隊(duì)之間使用的名詞不一樣县爬， 還是需要很多的手動(dòng) set/get 等功能。
第二種的話就是會(huì)很浪費(fèi)時(shí)間察迟， 而且在添加新的字段的時(shí)候也要進(jìn)行方法的修改扎瓶。不過泌枪， 由于不需要進(jìn)行反射， 其性能是很高的误证。
1.2 MapStruct 帶來的改變
MapSturct 是一個(gè)生成類型安全愈捅， 高性能且無依賴的 JavaBean 映射代碼的注解處理器（annotation processor）。
抓一下重點(diǎn)：
注解處理器
可以生成 JavaBean 之間那的映射代碼
類型安全灌具， 高性能像棘， 無依賴性
從字面的理解缕题， 我們可以知道， 該工具可以幫我們實(shí)現(xiàn) JavaBean 之間的轉(zhuǎn)換瘪松， 通過注解的方式锨阿。
同時(shí)， 作為一個(gè)工具類壳嚎，相比于手寫末早， 其應(yīng)該具有便捷然磷， 不容易出錯(cuò)的特點(diǎn)。
2 MapStruct 入門
入門很簡(jiǎn)單寡润。我是基于 Maven 來進(jìn)行項(xiàng)目 jar 包管理的梭纹。
2.1 引入依賴
<properties>
<org.mapstruct.version>1.3.0.Final</org.mapstruct.version>
</properties>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-jdk8</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
2.2 創(chuàng)建entity和dto對(duì)象
該類是從 github 某個(gè)訂單系統(tǒng)里面拿下來的部分栗柒。
@Data
public class Order {
/**
*訂單id
*/
private Long id;
/**
* 訂單編號(hào)
*/
private String orderSn;
/**
* 收貨人姓名/號(hào)碼
*/
private String receiverKeyword;
/**
* 訂單狀態(tài)：0->待付款；1->待發(fā)貨太伊；2->已發(fā)貨逛钻；3->已完成曙痘；4->已關(guān)閉；5->無效訂單
*/
private Integer status;
/**
* 訂單類型：0->正常訂單名扛；1->秒殺訂單
*/
private Integer orderType;
/**
* 訂單來源：0->PC訂單茧痒；1->app訂單
*/
private Integer sourceType;
}
對(duì)應(yīng)的查詢參數(shù)
@Data
public class OrderQueryParam {
/**
* 訂單編號(hào)
*/
private String orderSn;
/**
* 收貨人姓名/號(hào)碼
*/
private String receiverKeyword;
/**
* 訂單狀態(tài)：0->待付款旺订；1->待發(fā)貨；2->已發(fā)貨拘领；3->已完成约素；4->已關(guān)閉笆凌；5->無效訂單
*/
private Integer status;
/**
* 訂單類型：0->正常訂單菩颖；1->秒殺訂單
*/
private Integer orderType;
/**
* 訂單來源：0->PC訂單为障；1->app訂單
*/
private Integer sourceType;
}
2.3 寫 Mapper
Mapper 即映射器鳍怨， 一般來說就是寫 xxxMapper 接口。當(dāng)然声滥， 不一定是以 Mapper 結(jié)尾的。只是官方是這么寫的纽疟。在本入門例子中憾赁，對(duì)應(yīng)的接口如下
import com.homejim.mapstruct.dto.OrderQueryParam;
import com.homejim.mapstruct.entity.Order;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
@Mapper
public interface OrderMapper {
OrderQueryParam entity2queryParam(Order order);
}
簡(jiǎn)單的映射（字段和類型都匹配）龙考， 只有一個(gè)要求， 在接口上寫 @Mapper 注解即可炎功。然后方法上蛇损， 入?yún)?duì)應(yīng)要被轉(zhuǎn)化的對(duì)象肛宋， 返回值對(duì)應(yīng)轉(zhuǎn)化后的對(duì)象酝陈， 方法名稱可任意。
2.4 測(cè)試
寫一個(gè)測(cè)試類測(cè)試一下锈死。
@Test
public void entity2queryParam() {
Order order = new Order();
order.setId(12345L);
order.setOrderSn("orderSn");
order.setOrderType(0);
order.setReceiverKeyword("keyword");
order.setSourceType(1);
order.setStatus(2);
OrderMapper mapper = Mappers.getMapper(OrderMapper.class);
OrderQueryParam orderQueryParam = mapper.entity2queryParam(order);
assertEquals(orderQueryParam.getOrderSn(), order.getOrderSn());
assertEquals(orderQueryParam.getOrderType(), order.getOrderType());
assertEquals(orderQueryParam.getReceiverKeyword(), order.getReceiverKeyword());
assertEquals(orderQueryParam.getSourceType(), order.getSourceType());
assertEquals(orderQueryParam.getStatus(), order.getStatus());
}
測(cè)試通過， 沒有任何的問題穆壕。
3 MapStruct 分析
上面中待牵， 我寫了3個(gè)步驟來實(shí)現(xiàn)了從 Order 到 OrderQueryParam 的轉(zhuǎn)換。
那么喇勋， 作為一個(gè)注解處理器缨该， 通過MapStruct 生成的代碼具有怎么樣的優(yōu)勢(shì)呢？
3.1 高性能
這是相對(duì)反射來說的川背， 反射需要去讀取字節(jié)碼的內(nèi)容贰拿， 花銷會(huì)比較大。而通過 MapStruct 來生成的代碼熄云， 其類似于人手寫膨更。速度上可以得到保證缴允。
前面例子中生成的代碼可以在編譯后看到荚守。在 target/generated-sources/annotations 里可以看到。
生成的代碼
對(duì)應(yīng)的代碼
@Generated(
value = "org.mapstruct.ap.MappingProcessor",
date = "2019-08-02T00:29:49+0800",
comments = "version: 1.3.0.Final, compiler: javac, environment: Java 11.0.2 (Oracle Corporation)"
)
public class OrderMapperImpl implements OrderMapper {
@Override
public OrderQueryParam entity2queryParam(Order order) {
if ( order == null ) {
return null;
}
OrderQueryParam orderQueryParam = new OrderQueryParam();
orderQueryParam.setOrderSn( order.getOrderSn() );
orderQueryParam.setReceiverKeyword( order.getReceiverKeyword() );
orderQueryParam.setStatus( order.getStatus() );
orderQueryParam.setOrderType( order.getOrderType() );
orderQueryParam.setSourceType( order.getSourceType() );
return orderQueryParam;
}
}
可以看到其生成了一個(gè)實(shí)現(xiàn)類， 而代碼也類似于我們手寫矗漾， 通俗易懂锈候。
3.2 易于 debug
在我們生成的代碼中， 我們可以輕易的進(jìn)行 debug缩功。
易于 DEBUG
在使用反射的時(shí)候晴及， 如果出現(xiàn)了問題， 很多時(shí)候是很難找到是什么原因的嫡锌。
3.3 使用相對(duì)簡(jiǎn)單
如果是完全映射的虑稼， 使用起來肯定沒有反射簡(jiǎn)單。用類似 BeanUtils 這些工具一條語句就搞定了势木。但是蛛倦，如果需要進(jìn)行特殊的匹配（特殊類型轉(zhuǎn)換， 多對(duì)一轉(zhuǎn)換等）啦桌， 其相對(duì)來說也是比較簡(jiǎn)單的溯壶。整理了一份Java面試寶典完整版PDF已整理成文檔
基本上， 使用的時(shí)候甫男， 我們只需要聲明一個(gè)接口且改， 接口下寫對(duì)應(yīng)的方法， 就可以使用了板驳。當(dāng)然又跛， 如果有特殊情況， 是需要額外處理的若治。
3.4 代碼獨(dú)立
生成的代碼是對(duì)立的慨蓝， 沒有運(yùn)行時(shí)的依賴。
