移形換影-MapStruct使用技巧

介紹

在我們開發(fā)中轻绞，涉及到對各種DO采记，VO，DTO之間的轉(zhuǎn)換政勃，如果你還在使用下面的工具類做這些工作

SuppliersDTO suppliersDTO = BeanUtils.copyProperties(suppliersDO, SuppliersDTO.class);

那么我覺得你很有必要了解下我即將介紹的這個(gè)框架

競品分析

在阿里編碼規(guī)范插件中有這么一條

下面我們就來分析下 Apache BeanUtils, Spring BeanUtils唧龄，Cglib BeanCopier和本文介紹的MapStruct的差別。

框架/工具類	原理	性能	功能豐富性
Apache BeanUtils	反射	差	一般
Spring BeanUtils	反射	差	弱
Cglib BeanCopier	字節(jié)碼生成	強(qiáng)	一般
MapStruct	字節(jié)碼生成	較強(qiáng)	強(qiáng)

為什么反射性能差奸远？簡單的講下既棺，你方法直接調(diào)用，在類加載(解析階段懒叛，符號引用替換為直接引用)的時(shí)候就知道調(diào)用的方法地址在哪里丸冕。而反射的話，運(yùn)行時(shí)獲取地址薛窥，如果一個(gè)類有10個(gè)方法胖烛，遍歷10個(gè)方法去計(jì)算出這個(gè)地址，肯定增加了耗時(shí)诅迷。

功能性的話佩番，我看除了MapStruct框架外，其他幾種都是讓你自己實(shí)現(xiàn)一些轉(zhuǎn)換器傳入罢杉，太雞肋了

以下是上面4中框架/工具類執(zhí)行100萬次對象拷貝的時(shí)間對比(單位納秒)

Cglib BeanCopier排名第一趟畏，MapStruct排名第二。

為啥同是字節(jié)碼滩租，Cglib BeanCopier比MapStruct強(qiáng)赋秀，因?yàn)槲业臏y試用例是太簡單了，那么比較下復(fù)雜的場景吧律想，不好意思猎莲，Cglib BeanCopier能夠支持的場景不夠復(fù)雜。

性能和Cglib BeanCopier上差距不大蜘欲，但是MapStruct使用起來太方便簡潔了益眉，所以我還是推薦使用MapStruct。

對比代碼見https://github.com/shengchaojie/java_framework_contrast
下面的demo代碼也在這個(gè)github項(xiàng)目中

如何使用

配置

...
<properties>
    <org.mapstruct.version>1.3.0.Final</org.mapstruct.version>
    <org.projectlombok.version>1.18.0</org.projectlombok.version>
</properties>
...
<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>

    <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${org.projectlombok.version}</version>
            <scope>provided</scope>
        </dependency>
</dependencies>
...
<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.6.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <annotationProcessorPaths>
                        <path>
                            <groupId>org.mapstruct</groupId>
                            <artifactId>mapstruct-processor</artifactId>
                            <version>${org.mapstruct.version}</version>
                        </path>
                        <path>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                            <version>${org.projectlombok.version}</version>
                        </path>
                    </annotationProcessorPaths>
                </configuration>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
...

上面的配置是和lombok集成的配置方式姥份，單不僅限以上一種配置方式

使用方式

比如我有以下兩個(gè)模型需要轉(zhuǎn)換

@Data
public class OrderDO {

    private String orderCode;

    private String address;

}

@Data
public class OrderDTO {

    private String orderCode;

    private String address;

    private List<OrderWareDetailDTO> orderWareDetailDTOS;

}

我只需要?jiǎng)?chuàng)建一個(gè)ConvertUtil郭脂，并且加上@Mapper注解即可

@Mapper
public interface ConvertUtil {

    ConvertUtil INSTANCE = Mappers.getMapper(ConvertUtil.class);

    OrderDTO map(OrderDO orderDO);

}

通過mvn命令編譯后，在target的classes目錄ConvertUtil統(tǒng)計(jì)目錄下會(huì)生成一個(gè)ConvertUtilImpl類澈歉，里面包括模型拷貝的邏輯展鸡。

上面map方法對應(yīng)生成的代碼如下

    public OrderDTO map(OrderDO orderDO) {
        if (orderDO == null) {
            return null;
        } else {
            OrderDTO orderDTO = new OrderDTO();
            orderDTO.setOrderCode(orderDO.getOrderCode());
            orderDTO.setAddress(orderDO.getAddress());
            return orderDTO;
        }
    }

MapStruct最基礎(chǔ)的功能講解完畢，下面介紹MapStruct一系列遍歷的功能

更多功能

名稱映射

有時(shí)候2個(gè)實(shí)體之間的名字不完全統(tǒng)一埃难，但是可能代表的是一個(gè)含義莹弊，我們可以在方法上面加上@Mapping注解來實(shí)現(xiàn)不同名稱屬性的賦值

將上面OrderDTO的address改為receiverAddress，然后在對應(yīng)map上增加@Mapping注解

    @Mapping(source = "address",target = "receiverAddress")
    OrderDTO map(OrderDO orderDO);

生成字節(jié)碼如下

    @Override
    public OrderDTO map(OrderDO orderDO) {
        if ( orderDO == null ) {
            return null;
        }

        OrderDTO orderDTO = new OrderDTO();

        orderDTO.setReceiverAddress( orderDO.getAddress() );
        orderDTO.setOrderCode( orderDO.getOrderCode() );

        return orderDTO;
    }

傳入返回

上面的基礎(chǔ)功能涡尘，轉(zhuǎn)換后的模型是通過方法結(jié)果返回的忍弛，MapStruct也支持對傳入對象的賦值

    @Mapping(source = "address",target = "receiverAddress")
    void map(OrderDO orderDO,@MappingTarget OrderDTO orderDTO);

對應(yīng)字節(jié)碼如下

    @Override
    public void map(OrderDO orderDO, OrderDTO orderDTO) {
        if ( orderDO == null ) {
            return;
        }

        orderDTO.setReceiverAddress( orderDO.getAddress() );
        orderDTO.setOrderCode( orderDO.getOrderCode() );
    }

多合一

上面可以看到，OrderDO轉(zhuǎn)換成OrderDTO的時(shí)候考抄，我沒有處理orderWareDetailDTOS细疚，MapStruct支持多個(gè)對象轉(zhuǎn)換為一個(gè)對象。

    @Mapping(source = "orderDO.address",target = "receiverAddress")
    @Mapping(source = "orderWareDetailDTOList",target = "orderWareDetailDTOS")
    OrderDTO map(OrderDO orderDO,List<OrderWareDetailDTO> orderWareDetailDTOList);

對應(yīng)字節(jié)碼如下

    @Override
    public OrderDTO map(OrderDO orderDO, List<OrderWareDetailDTO> orderWareDetailDTOList) {
        if ( orderDO == null && orderWareDetailDTOList == null ) {
            return null;
        }

        OrderDTO orderDTO = new OrderDTO();

        if ( orderDO != null ) {
            orderDTO.setReceiverAddress( orderDO.getAddress() );
            orderDTO.setOrderCode( orderDO.getOrderCode() );
        }
        if ( orderWareDetailDTOList != null ) {
            List<OrderWareDetailDTO> list = orderWareDetailDTOList;
            if ( list != null ) {
                orderDTO.setOrderWareDetailDTOS( new ArrayList<OrderWareDetailDTO>( list ) );
            }
        }

        return orderDTO;
    }

嵌套轉(zhuǎn)換

可以注意到我上面的OrderDTO有orderWareDetailDTOS這個(gè)屬性川梅，并且是一個(gè)List疯兼，然后我有下面對應(yīng)的OrderVO需要進(jìn)行轉(zhuǎn)換。

@Data
public class OrderVO {

    private String orderCode;

    private String address;

    private List<OrderWareDetailVO> orderWareDetailVOList;

}

可以看到對應(yīng)2個(gè)模型內(nèi)的list屬性類型是不一樣的贫途，其他3中轉(zhuǎn)換框架做不到這個(gè)吧彪，或者做起來挺麻煩。但是在MapStruct只要加一下2個(gè)接口方法即可丢早。

    @Mapping(target = "orderWareDetailVOList",source = "orderWareDetailDTOS")
    @Mapping(target = "address",source = "receiverAddress")
    OrderVO map(OrderDTO orderDTO);

    OrderWareDetailVO map(OrderWareDetailDTO orderWareDetailDTO);

生成的字節(jié)碼如下

    @Override
    public OrderVO map(OrderDTO orderDTO) {
        if ( orderDTO == null ) {
            return null;
        }

        OrderVO orderVO = new OrderVO();

        orderVO.setOrderWareDetailVOList( orderWareDetailDTOListToOrderWareDetailVOList( orderDTO.getOrderWareDetailDTOS() ) );
        orderVO.setAddress( orderDTO.getReceiverAddress() );
        orderVO.setOrderCode( orderDTO.getOrderCode() );

        return orderVO;
    }

    @Override
    public OrderWareDetailVO map(OrderWareDetailDTO orderWareDetailDTO) {
        if ( orderWareDetailDTO == null ) {
            return null;
        }

        OrderWareDetailVO orderWareDetailVO = new OrderWareDetailVO();

        orderWareDetailVO.setWareCode( orderWareDetailDTO.getWareCode() );

        return orderWareDetailVO;
    }

    protected List<OrderWareDetailVO> orderWareDetailDTOListToOrderWareDetailVOList(List<OrderWareDetailDTO> list) {
        if ( list == null ) {
            return null;
        }

        List<OrderWareDetailVO> list1 = new ArrayList<OrderWareDetailVO>( list.size() );
        for ( OrderWareDetailDTO orderWareDetailDTO : list ) {
            list1.add( map( orderWareDetailDTO ) );
        }

        return list1;
    }

可以看出來這個(gè)框架不是簡單的生成對應(yīng)賦值的字節(jié)碼姨裸，如果它遇到不能解析的轉(zhuǎn)換，它會(huì)從所在接口的方法中去檢查是否有對應(yīng)轉(zhuǎn)換邏輯怨酝。

其他

其他還有很多特性傀缩，比如對于數(shù)字類型，只要屬性名一樣凫碌，它會(huì)自動(dòng)轉(zhuǎn)換扑毡，當(dāng)然高精度轉(zhuǎn)低精度可能會(huì)損失精度。也包括對各種時(shí)間盛险，以及string和int之間的互轉(zhuǎn)瞄摊。我上面的舉的例子是我在開發(fā)中比較常見的一些點(diǎn)，你有更加復(fù)雜的場景推薦閱讀官方文檔苦掘。

原理

別看MapStruct和lombok都是通過注解來做文章换帜，但是他們的原理是不同的。lombok是修改原有類的字節(jié)碼鹤啡，用的是jvm提供的Instrument機(jī)制惯驼。
看它的META-INF/MANIFEST.MF文件就知道了

Manifest-Version: 1.0
Ant-Version: Apache Ant 1.7.1
Created-By: 14.3-b01-101 (Apple Inc.)
Premain-Class: lombok.launch.Agent
Agent-Class: lombok.launch.Agent
Can-Redefine-Classes: true
Main-Class: lombok.launch.Main
Lombok-Version: 1.18.0

而MapStruct用到了APT（Annotation Processing Tool 簡稱，即注解處理器）這個(gè)技術(shù)，通過spi提供實(shí)現(xiàn)類祟牲，會(huì)在編譯階段處理特定注解隙畜。

我們上面的配置方式?jīng)]有看不到注解解析器的依賴，maven幫我們做了這個(gè)事说贝，通過下面依賴把MapStruct APT的jar包引入項(xiàng)目

        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>${org.mapstruct.version}</version>
            <scope>provided</scope>
        </dependency>

在jar包的services目錄下可以看到j(luò)avax.annotation.processing.Processor文件,內(nèi)容為

org.mapstruct.ap.MappingProcessor

具體怎么處理大家自己研究议惰。

寫這些框架的人，可見對java每個(gè)版本的特性有多了解乡恕。

參考

Java反射到底慢在哪
 官方文檔多多了解
 Java中的APT的工作過程