2. 程式人生 > 其它 >Java物件轉換與mapstruct實踐

Java物件轉換與mapstruct實踐

阿新 • • 發佈：2022-05-15

1 前言

在日常開發中，我們經常需要給物件進行賦值，通常會呼叫其set/get方法，有些時候，如果我們要轉換的兩個物件之間屬性大致相同，會考慮使用屬性拷貝工具進行。
如我們經常在程式碼中會對一個數據結構封裝成 DO、PO、DTO、VO等，而這些Bean中的大部分屬性都是一樣的，所以使用屬性拷貝類工具可以幫助我們節省大量的set和get操作。

2 常用工具類

市面上有很多類似的工具類，比較常用的有如下圖：

 那麼，我們到底應該選擇哪種工具類更加合適呢？為什麼阿里巴巴Java開發手冊中提到禁止使用Apache BeanUtils呢？

 3 效能測試對比

在 Java 系統工程開發過程中，都會有各個層之間的物件轉換，比如 VO、DTO、PO、VO 等，而如果都是手動get、set

又太浪費時間，還可能操作錯誤，所以選擇一個自動化工具會更加方便。

目前整理出用於物件屬性轉換有12種，包括：普通的getset、json2Json、Apache屬性拷貝、Spring屬性拷貝、bean-mapping、bean-mapping-asm、BeanCopier、Orika、Dozer、ModelMapper、JMapper、MapStruct 接下來我們分別測試這11種屬性轉換操作分別在一百次、一千次、一萬次、十萬次、一百萬次時候的效能時間對比。

  • BeanUtils.copyProperties 是大家程式碼裡最常出現的工具類，但只要你不把它用錯成 Apache 包下的，而是使用 Spring 提供的，就基本還不會對效能造成多大影響。
  • 但如果說效能更好，可替代手動get、set的，還是 MapStruct 更好用，因為它本身就是在編譯期生成get、set程式碼，和我們寫get、set一樣。
  • 其他一些元件包主要基於 AOP、ASM、CGlib，的技術手段實現的，所以也會有相應的效能損耗。

4 案例介紹

4.1 get\set

@Component
public class GetSetAssembler implements IAssembler<UserVO, UserDTO> {

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        UserDTO userDTO 
 
= new UserDTO();
        userDTO.setUserId(var.getUserId());
        userDTO.setUserNickName(var.getUserNickName());
        userDTO.setCreateTime(var.getCreateTime());
        return userDTO;
    }

}
  • 推薦：★★★☆☆
  • 效能：★★★★★
  • 手段：手寫
  • 點評：其實這種方式也是日常使用的最多的，效能肯定是槓槓的，就是操作起來有點麻煩。尤其是一大堆屬性的 VO 物件轉換為 DTO 物件時候。但其實也有一些快捷的操作方式，比如你可以通過 Shift+Alt 選中所有屬性，Shift+Tab 歸併到一列，接下來在使用 Alt 選中這一列，批量操作貼上 userDTO.set 以及快捷鍵大寫屬性首字母，最後切換到結尾補充括號和分號，最終格式化一下就搞定了

4.2. fastjson

這種方案因為通過生成中間json格式字串，然後再轉化成目標物件，效能非常差，同時因為中間會生成json格式字串，如果轉化過多，gc會非常頻繁，同時針對複雜場景支援能力不足，基本很少用。

@Component
public class Json2JsonAssembler implements IAssembler<UserVO, UserDTO> {

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        String strJson = JSON.toJSONString(var);
        return JSON.parseObject(strJson, UserDTO.class);
    }

}
  • 推薦：☆☆☆☆☆
  • 效能：★☆☆☆☆
  • 手段：把物件轉JSON串，再把JSON轉另外一個物件
  • 點評：這麼寫多半有點燒！

4.3 Apache copyProperties

BeanUtil.copyProperties()結合手寫get、set，對於簡單的轉換直接使用BeanUtil，複雜的轉換自己手工寫get、set。該方案的痛點就在於程式碼編寫效率低、冗餘繁雜還略顯醜陋，並且BeanUtil因為使用了反射invoke去賦值效能不高。只能適合bean數量較少、內容不多、轉換不頻繁的場景。

@Component
public class ApacheCopyPropertiesAssembler implements IAssembler<UserVO, UserDTO> {

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        UserDTO userDTO = new UserDTO();
        try {
            BeanUtils.copyProperties(userDTO, var);
        } catch (IllegalAccessException | InvocationTargetException e) {
            e.printStackTrace();
        }
        return userDTO;
    }

}
  • 推薦：☆☆☆☆☆
  • 效能：★☆☆☆☆
  • 手段：Introspector 機制獲取到類的屬性來進行賦值操作
  • 點評：有坑，相容性交差，不建議使用

4.4 Spring copyProperties

這種方案針對apache的BeanUtils做了很多優化，整體效能提升不少，不過還是使用反射實現比不上原生程式碼處理，其次針對複雜場景支援能力不足。

@Component
public class SpringCopyPropertiesAssembler implements IAssembler<UserVO, UserDTO> {

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        UserDTO userDTO = new UserDTO();
        BeanUtils.copyProperties(var, userDTO);
        return userDTO;
    }

}
  • 推薦：★★★☆☆
  • 效能：★★★★☆
  • 手段：Introspector機制獲取到類的屬性來進行賦值操作
  • 點評：同樣是反射的屬性拷貝，Spring 提供的 copyProperties 要比 Apache 好用的多，只要你不用錯，基本不會有啥問題。

4.5  Bean Mapping

@Component
public class BeanMappingAssembler implements IAssembler<UserVO, UserDTO> {

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        UserDTO userDTO = new UserDTO();
        BeanUtil.copyProperties(var, userDTO);
        return userDTO;
    }

}
  • 推薦：★★☆☆☆
  • 效能：★★★☆☆
  • 手段：屬性拷貝
  • 點評：效能一般

4.6  Bean Mapping ASM

@Component
public class BeanMappingAssembler implements IAssembler<UserVO, UserDTO> {

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        UserDTO userDTO = new UserDTO();
        BeanUtil.copyProperties(var, userDTO);
        return userDTO;
    }

}
  • 推薦：★★★☆☆
  • 效能：★★★★☆
  • 手段：基於ASM位元組碼框架實現
  • 點評：與普通的 Bean Mapping 相比，效能有所提升，可以使用。

4.7  BeanCopier

這種方案動態生成一個要代理類的子類,其實就是通過位元組碼方式轉換成效能最好的get和set方式,重要的開銷在建立BeanCopier，整體效能接近原生程式碼處理，比BeanUtils要好很多，尤其在資料量很大時，但是針對複雜場景支援能力不足。

@Component
public class BeanCopierAssembler implements IAssembler<UserVO, UserDTO> {

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        UserDTO userDTO = new UserDTO();
        BeanCopier beanCopier = BeanCopier.create(var.getClass(), userDTO.getClass(), false);
        beanCopier.copy(var, userDTO, null);
        return userDTO;
    }

}
  • 推薦：★★★☆☆
  • 效能：★★★★☆
  • 手段：基於CGlib位元組碼操作生成get、set方法
  • 點評：整體效能很不錯，使用也不復雜，可以使用

4.8  Orika

@Component
public class OrikaAssembler implements IAssembler<UserVO, UserDTO> {

    /**
     * 構造一個MapperFactory
     */
    private static MapperFactory mapperFactory = new DefaultMapperFactory.Builder().build();

    static {
        mapperFactory.classMap(UserDTO.class, UserVO.class)
                .field("userId", "userId")  // 欄位不一致時可以指定
                .byDefault()
                .register();
    }

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        return mapperFactory.getMapperFacade().map(var, UserDTO.class);
    }

}
  • 官網：https://orika-mapper.github.io/orika-docs/
  • 推薦：★★☆☆☆
  • 效能：★★★☆☆
  • 手段：基於位元組碼生成對映物件
  • 點評：測試效能不是太突出，如果使用的話需要把 MapperFactory 的構建優化成 Bean 物件

4.9 Dozer

@Component
public class DozerAssembler implements IAssembler<UserVO, UserDTO> {

    private static DozerBeanMapper mapper = new DozerBeanMapper();

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        return mapper.map(var, UserDTO.class);
    }

}

4.10  ModelMapper

@Component
public class ModelMapperAssembler implements IAssembler<UserVO, UserDTO> {

    private static ModelMapper modelMapper = new ModelMapper();

    static {
        modelMapper.addMappings(new PropertyMap<UserVO, UserDTO>() {
            @Override
            protected void configure() {
                // 屬性值不一樣可以自己操作
                map().setUserId(source.getUserId());
            }
        });
    }

    @Override
    public UserDTO sourceToTarget(UserVO var) {
        return modelMapper.map(var, UserDTO.class);
    }

}
  • 官網：http://modelmapper.org
  • 推薦：★★★☆☆
  • 效能：★★★☆☆
  • 手段：基於ASM位元組碼實現
  • 點評：轉換物件數量較少時效能不錯，如果同時大批量轉換物件，效能有所下降

4.11 JMapper

JMapper<UserDTO, UserVO> jMapper = new JMapper<>(UserDTO.class, UserVO.class, new JMapperAPI()
        .add(JMapperAPI.mappedClass(UserDTO.class)
                .add(JMapperAPI.attribute("userId")
                        .value("userId"))
                .add(JMapperAPI.attribute("userNickName")
                        .value("userNickName"))
                .add(JMapperAPI.attribute("createTime")
                        .value("createTime"))
        ));
  • 官網：https://github.com/jmapper-framework/jmapper-core/wiki
  • 推薦：★★★★☆
  • 效能：★★★★★
  • 手段：Elegance, high performance and robustness all in one java bean mapper
  • 點評：速度真心可以，不過結合 SpringBoot 感覺有的一點點麻煩，可能姿勢不對

4.12 MapStruct

maven依賴：

<properties>
 <org.mapstruct.version>1.3.1.Final</org.mapstruct.version>
</properties>

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

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.projectlombok</groupId>
                        <artifactId>lombok</artifactId>
                        <version>${lombok.version}</version>
                    </path>
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

注意這裡配置一下lombok, 否則啟動會衝突。

程式碼實現：

@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE, unmappedSourcePolicy = ReportingPolicy.IGNORE)
public interface UserDTOMapping extends IMapping<UserVO, UserDTO> {

    /** 用於測試的單例 */
    IMapping<UserVO, UserDTO> INSTANCE = Mappers.getMapper(UserDTOMapping.class);

    @Mapping(target = "userId", source = "userId")
    @Mapping(target = "createTime", dateFormat = "yyyy-MM-dd HH:mm:ss")
    @Override
    UserDTO sourceToTarget(UserVO var1);

    @Mapping(target = "userId", source = "userId")
    @Mapping(target = "createTime", dateFormat = "yyyy-MM-dd HH:mm:ss")
    @Override
    UserVO targetToSource(UserDTO var1);

}

注意：

1：可以在Mapping類上加@Mapper(componentModel = "spring"), 通過注入的方式引入Mapper介面

2：可以通過Mappers.getMapper(UserDTOMapping.class) 的方式獲取Mapper介面

5 總結

  • 其實物件屬性轉換的操作無非是基於反射、AOP、CGlib、ASM、Javassist 在編譯時和執行期進行處理，再有好的思路就是在編譯前生成出對應的get、set，就像手寫出來的一樣。
  • 所以我更推薦我喜歡的 MapStruct，用起來還是比較舒服的，一種是來自於功能上的拓展性，易用性和相容性。

參考：

12種 vo2dto 方法 (qq.com)

Java物件轉換方案分析與mapstruct實踐-阿里雲開發者社群 (aliyun.com)

MapStruct 1.4.2.Final Reference Guide

mapstruct/mapstruct-examples: Examples for using MapStruct (github.com)

為什麼阿里巴巴禁止使用Apache Beanutils進行屬性的copy？ (qq.com)

幹掉 BeanUtils！試試這款 Bean 自動對映工具，真心強大！ - SegmentFault 思否

相關推薦

Java物件轉換與mapstruct實踐

1 前言 在日常開發中，我們經常需要給物件進行賦值，通常會呼叫其set/get方法，有些時候，如果我們要轉換的兩個物件之間屬性大致相同，會考慮使用屬性拷貝工具進行。如我們經常在程式碼中會對一個數據結構封裝成 DO、

mapstruct解放Java物件轉換

摘要 當前web後端開發，都是使用多層工程結構，需要在VO,BO,DTO,DO等各種資料結構中相互轉換。這些轉換程式碼都是些比較簡單的欄位對映，型別轉換，重複性工作比較高，可以使用一些工具解放我們的雙手

xml與java物件轉換

jackson-dataformat-xml工具包xml與java物件轉換說明 1、引入依賴包 <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId>

詳解java 物件鎖與類鎖

一.什麼是物件鎖 物件鎖也叫方法鎖，是針對一個物件例項的，它只在該物件的某個記憶體位置宣告一個標識該物件是否擁有鎖，所有它只會鎖住當前的物件，而並不會對其他物件例項的鎖產生任何影響，不同物件訪問同一個被

Java物件轉換的思考

物件轉換 本文將介紹物件轉換, 在 JavaWeb 開發中我們經常需要對各類物件進行轉換(DB物件,DTO,VO等等).

物件轉換工具 MapStruct 介紹

前言 在我們日常開發的分層結構的應用程式中，為了各層之間互相解耦，一般都會定義不同的物件用來在不同層之間傳遞資料，因此，就有了各種 XXXDTO、XXXVO、XXXBO 等基於資料庫物件派生出來的物件，當在不同層之間傳

解析Java物件引用與JVM自動記憶體管理

物件引用應用程式設計介面是JDKTM1.2中新定義的。該應用程式設計介面允許應用程式以物件引用的方式與JVM的記憶體管理器進行互動。當應用程式需管理大量記憶體物件或者在新的Java物件建立之前需刪除原有物件時，Java

JSONUtil(JAVA物件/List與json互轉，xml與json互轉)

1 package com.chauvet.utils.json; 2 3 import java.io.BufferedReader; 4 import java.io.File; 5 import java.io.FileInputStream;

如何將java物件轉換成json資料

package cn.hopetesting.com.test;import cn.hopetesting.com.domain.User;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import org.junit.Test

Java物件與Json字串的轉換

Java物件與Json字串的轉換 JSON是一種輕量級的資料交換格式，常用於前後端的資料交流

【JSON】java物件、JSON物件與JSON字串之間的轉換

JSON：java物件--->JSON物件--->JavaScript物件 （1）簡介 型別：資料傳輸的角度：字串型別

JAXB 實現java物件與xml之間互相轉換

首先熟悉一下JAXB實現物件與xml互轉時常用的一些註解使用： 1.@XmlRootElement，用於類級別的註解，對應xml的跟元素。通過name屬性定義這個根節點的名稱。

java物件與json格式相互轉換的工具類

1. 內容 1 public class PfJacksonUtils { 2private PfJacksonUtils() { 3 4} 5 6public static String beanToJson(Object obj) throws JsonProcessingException {

Json物件與Json字串的轉化、JSON字串與Java物件的轉換

相關：Json物件與Json字串的轉化、JSON字串與Java物件的轉換 　　本文的目的是把json串轉成map鍵值對儲存，而且只儲存葉節點的資料

物件（java bean）與xml之間的轉換（Xstream）

技術標籤：java 一、前言 之前在做一個微信公眾號的專案，專案中有用到一種技術，將呼叫介面後返回的xml字串轉換為物件（java bean），個人覺得這種方式還是蠻好用的，所以在這裡分享下。

使用JAXB將Java物件與XML相互轉換

XML繫結的Java體系結構（JAXB）是將Java物件對映到XML以及從XML對映Java物件的流行選擇。它提供了易於使用的程式設計介面，用於將Java物件讀取和寫入XML，反之亦然。

java實現RSA公私鑰PKCS#1與PKCS#8之間的相互轉換（java rsa pkcs8轉pkcs1，rsa pkcs1轉pkcs8），PKCS8和PKCS1公私鑰byte陣列還原為java物件

技術標籤：數字簽名pkcspkirsa加密解密演算法 目錄 前言引入依賴一、公鑰轉換公鑰PKCS1轉PKCS8公鑰PKCS8轉PKCS1

Json字串與Java物件的相互轉換

JavaObject轉Json字串 fastJson的教程 gson的教程 fastJson String jsonStr = JSONObject.toJSONString(obj);

java中json與物件的轉換

JSON在javascript中與字串轉換 字串轉json物件 JSON.parse(str) json物件轉字串JSON.stringify(jsonobj);

java中json字串與物件轉換

常見的轉換工具有： Jackson：SpringMVC內建的轉換工具 jsonlib：Java提供的轉換工具(一般不用)