1 MapStruct 是什么？

1.1 JavaBean 的困擾

對於代碼中 JavaBean之間的轉換，一直是困擾我很久的事情。

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

第一種通過反射的方法確實比較方便，但是現在無論是 BeanUtils, BeanCopier 等在使用反射的時候都會影響到性能。雖然我們可以進行反射信息的緩存來提高性能。

但是像這種的話，需要類型和名稱都一樣才會進行映射，有很多時候，由於不同的團隊之間使用的名詞不一樣，還是需要很多的手動 set/get 等功能。

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

1.2 `MapStruct` 帶來的改變

MapSturct 是一個生成類型安全，高性能且無依賴的 JavaBean 映射代碼的注解處理器（annotation processor）。

抓一下重點：

注解處理器
可以生成 JavaBean 之間那的映射代碼
類型安全，高性能，無依賴性

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

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

2 `MapStruct` 入門

入門很簡單。我是基於 Maven 來進行項目 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 創建entity和dto對象

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

@Data
public class Order {

    /**
     *訂單id
     */
    private Long id;

    /**
     * 訂單編號
     */
    private String orderSn;

    /**
     * 收貨人姓名/號碼
     */
    private String receiverKeyword;

    /**
     * 訂單狀態：0->待付款；1->待發貨；2->已發貨；3->已完成；4->已關閉；5->無效訂單
     */
    private Integer status;

    /**
     * 訂單類型：0->正常訂單；1->秒殺訂單
     */
    private Integer orderType;

    /**
     * 訂單來源：0->PC訂單；1->app訂單
     */
    private Integer sourceType;
}

對應的查詢參數

@Data
public class OrderQueryParam {
    /**
     * 訂單編號
     */
    private String orderSn;

    /**
     * 收貨人姓名/號碼
     */
    private String receiverKeyword;

    /**
     * 訂單狀態：0->待付款；1->待發貨；2->已發貨；3->已完成；4->已關閉；5->無效訂單
     */
    private Integer status;

    /**
     * 訂單類型：0->正常訂單；1->秒殺訂單
     */
    private Integer orderType;

    /**
     * 訂單來源：0->PC訂單；1->app訂單
     */
    private Integer sourceType;

}

2.3 寫 Mapper

Mapper 即映射器，一般來說就是寫 xxxMapper 接口。

當然，不一定是以 Mapper 結尾的。只是官方是這么寫的。在本入門例子中，對應的接口如下

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);

}

簡單的映射（字段和類型都匹配），只有一個要求，在接口上寫 @Mapper 注解即可。

然后方法上，入參對應要被轉化的對象，返回值對應轉化后的對象，方法名稱可任意。

2.4 測試

寫一個測試類測試一下。

@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());

}

測試通過，沒有任何的問題。

3 MapStruct 分析

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

那么，作為一個注解處理器，通過MapStruct 生成的代碼具有怎么樣的優勢呢？

3.1 高性能

這是相對反射來說的，反射需要去讀取字節碼的內容，花銷會比較大。學反射看《Java反射看這篇絕對會了》這篇夠了！關注公眾號Java技術棧可以閱讀更多Java技術干貨教程。

而通過 MapStruct 來生成的代碼，其類似於人手寫。速度上可以得到保證。

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

生成的代碼

對應的代碼

@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;
    }
}

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