实体类转换工具 MapStruct，不要再使用BeanUtils了

最新推荐文章于 2024-06-10 17:18:17 发布
最新推荐文章于 2024-06-10 17:18:17 发布
阅读量1.1k 收藏 3
点赞数
分类专栏： 架构总结 文章标签： spring java 架构 mapstruct
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yilishuku/article/details/120162253
版权

目录

1、性能分析

2、什么是Mapstruct

4、普通使用方法

4.1 创建DO

4.2创建DTO

4.3创建一个基础的Mapstruct类

4.4创建映射器接口

5、spring依赖注入使用方法

6、总结

7、源码和官网

1、性能分析

在我们平时开发过程中，往往会涉及到，对象和对象直接的转化，而看到这个需求时直接想到的就是反射和BeanUtils工具，但是这个之间的效率往往是非常低的。

/**
 * @author Bill
 * @date Created in 2021/9/28 15:59 <br>
 */
public class ReflectTest {

    /**
     * 实体转换次数
     */
    private static final int LIMIT_NUM = 1;

    /**
     * 反射性能分析
     */
    @Test
    public void beanUtil() {
        long start = System.currentTimeMillis();

        OrderDTO orderDto = new OrderDTO();
        orderDto.setName("mapstruct 测试");
        orderDto.setCost(12L);
        orderDto.setPrice("13");
        orderDto.setWeight(123L);
        orderDto.setIsDeleted(false);
        orderDto.setIsFinish(true);
        orderDto.setGmtCreat(LocalDateTime.now());
        orderDto.setGmtModified(LocalDateTime.now());

        ItemDTO itemDTO = new ItemDTO();
        itemDTO.setItemName("衬衫");
        itemDTO.setPrice(12L);
        orderDto.setItemList(Arrays.asList(itemDTO));


        for (int i = 0; i < LIMIT_NUM; i++) {
            final Order order = new Order();
            BeanUtils.copyProperties(orderDto, order);
        }

        long end = System.currentTimeMillis();
        System.out.println("BeanUtils耗时："+(end - start ) + "ms");

        mapstruct();
    }

    /**
     * 反射性能分析
     */
    @Test
    public void mapstruct() {
        long start = System.currentTimeMillis();

        OrderDTO orderDto = new OrderDTO();
        orderDto.setName("mapstruct 测试");
        orderDto.setCost(12L);
        orderDto.setPrice("13");
        orderDto.setWeight(123L);
        orderDto.setIsDeleted(false);
        orderDto.setIsFinish(true);
        orderDto.setGmtCreat(LocalDateTime.now());
        orderDto.setGmtModified(LocalDateTime.now());

        ItemDTO itemDTO = new ItemDTO();
        itemDTO.setItemName("衬衫");
        itemDTO.setPrice(12L);
        orderDto.setItemList(Arrays.asList(itemDTO));

        for (int i = 0; i < LIMIT_NUM; i++) {
            final Order order = new Order();
            OrderMapper.INSTANCE.updateOrder(orderDto, order);
        }

        long end = System.currentTimeMillis();
        System.out.println("mapstruct耗时："+(end - start ) + "ms");
    }
}



平均结果：

BeanUtils耗时：150ms
mapstruct耗时：10ms

从上面可以看出BeanUtils和Mapstruct的性能差距还是蛮大的。

当然很多人也会说放射如果通过缓存性能能极大的提升，但是问题是，大部分的情况下我们是无法满足缓存的条件，而且这种反射往往比较麻烦，所以今天来看看Mapstruct这个技术。

2、什么是Mapstruct

原文

MapStruct is a code generator that greatly simplifies the implementation of mappings between Java bean types based on a convention over configuration approach.

The generated mapping code uses plain method invocations and thus is fast, type-safe and easy to understand.

Mapsturct 是一个通过配置公约的一种代码生成器，它大大简化了Java Bean类型之间的映射的实现，而且类型安全，性能高，使用简单。

3、准备工作

引入依赖，java11环境时

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
        <mapstruct.version>1.3.1.Final</mapstruct.version>
        <maven.compiler.version>3.6.1</maven.compiler.version>
    </properties>        


        <dependency>
            <groupId>org.glassfish.jaxb</groupId>
            <artifactId>jaxb-runtime</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>${mapstruct.version}</version>
        </dependency>
        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct-processor</artifactId>
            <version>${mapstruct.version}</version>
            <scope>provided</scope>
        </dependency>

4、普通使用方法

4.1 创建DO

package com.eagle.example.mapstruct.dataobject;

import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.List;

/**
 * 订单实体类
 *
 * @author Bill
 * @date Created in 2021/9/23 14:35 <br>
 */
@Data
public class Order implements Serializable {
    /**
     * 商品标题
     */
    private String title;
    /**
     * 商品价格
     */
    private Long price;
    /**
     * 订单的重量
     */
    private Long weight;
    /**
     * 订单成本
     */
    private Long cost;
    /**
     * 宝贝列表
     */
    List<Item> itemList;
    /**
     * 是否被删除
     */
    private String isDeleted;
    /**
     * 是否完成订单
     */
    private Boolean isFinish;
    /**
     * 创建时间
     */
    private String gmtCreat;
    /**
     * 更新时间
     */
    private LocalDateTime gmtModified;
}

package com.eagle.example.mapstruct.dataobject;

import lombok.Data;

/**
 * 宝贝信息
 *
 * @author Bill
 * @date Created in 2021/9/26 15:28 <br>
 */
@Data
public class Item {
    private String itemName;
    private Long price;
}

4.2创建DTO

package com.eagle.example.mapstruct.dto;

import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.List;

/**
 * @author Bill
 * @date Created in 2021/9/23 14:40 <br>
 */
@Data
public class OrderDTO implements Serializable {
    /**
     * 商品标题
     */
    private String name;
    /**
     * 商品价格
     */
    private String price;
    /**
     * 订单的重量
     */
    private Long weight;
    /**
     * 订单成本
     */
    private Long cost;
    /**
     * 宝贝列表
     */
    private List<ItemDTO> itemList;
    /**
     * 是否被删除
     */
    private Boolean isDeleted;
    /**
     * 是否完成订单
     */
    private Boolean isFinish;
    /**
     * 创建时间
     */
    private LocalDateTime gmtCreat;
    /**
     * 更新时间
     */
    private LocalDateTime gmtModified;
}

package com.eagle.example.mapstruct.dto;

import lombok.Data;

/**
 * 宝贝信息do
 *
 * @author Bill
 * @date Created in 2021/9/26 15:29 <br>
 */
@Data
public class ItemDTO {
    private String itemName;
    private Long price;
}

package com.eagle.example.mapstruct.dto;

import lombok.Data;

import java.io.Serializable;

/**
 * @author Bill
 * @date Created in 2021/9/23 14:40 <br>
 */
@Data
public class OrderInfoDTO implements Serializable {

    /**
     * 商品标题
     */
    private String name;
    /**
     * 商品价格
     */
    private String price;

}

4.3创建一个基础的Mapstruct类

可以编写一些基础方法和通用功能，因为随着Localdate的引入DO也都使用了Localdate类型，但是Mapstruct对Localdate支持比较弱，所以引入

package com.eagle.example.mapstruct.convert;

/**
 * @author Bill
 * @date Created in 2021/9/26 17:39 <br>
 */

import org.mapstruct.Mapper;

import java.time.LocalDate;
import java.time.LocalDateTime;

@Mapper(imports = {LocalDateTime.class, LocalDate.class})
public interface BaseMapstruct {
}

4.4创建映射器接口

当前例子是比较全的一种形态，所以很多不需要使用的自己酌情删除

package com.eagle.example.mapstruct.convert;

/**
 * @author Bill
 * @date Created in 2021/9/26 17:08 <br>
 */
public class BooleanStrFormat {

    private static final String Y_CHAR = "Y";

    private static final String N_CHAR = "N";

    public String toStr(Boolean isDisable) {
        if (isDisable) {
            return Y_CHAR;
        } else {
            return N_CHAR;
        }
    }

    public Boolean toBoolean(String str) {
        if (str.equals(Y_CHAR)) {
            return true;
        } else {
            return false;
        }
    }
}

package com.eagle.example.mapstruct.convert;

import com.eagle.example.mapstruct.dataobject.Order;
import com.eagle.example.mapstruct.dto.OrderDTO;
import com.eagle.example.mapstruct.dto.OrderInfoDTO;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.MappingTarget;
import org.mapstruct.Mappings;
import org.mapstruct.ap.internal.util.Strings;
import org.mapstruct.factory.Mappers;

import java.util.List;

/**
 * @author Bill
 * @date Created in 2021/9/23 16:43 <br>
 */
@Mapper(uses = BooleanStrFormat.class)
public interface OrderMapper extends BaseMapstruct {

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

    String Y_CHAR = "Y";

    String N_CHAR = "N";

    /**
     * 1、属性名不一致转换
     * 2、LocalDateTime 转 string 
     * 3、qualifiedByName 方式Long 转String
     * 4、List 对象转换
     *
     * @param orderDTO
     * @return
     */
    @Mappings({
            @Mapping(source = "name", target = "title"),
            @Mapping(target = "gmtCreat", dateFormat = "yyyy-MM-dd HH:mm:ss"),
            @Mapping(target = "price", qualifiedByName = "toLong")
    })
    Order orderDto2Order(OrderDTO orderDTO);

    /**
     * Order to orderDto
     *
     * @param order
     * @return
     */
    @Mappings({
            @Mapping(source = "title", target = "name"),
            @Mapping(target = "gmtCreat", dateFormat = "yyyy-MM-dd HH:mm:ss"),
            @Mapping(target = "price", qualifiedByName = "toStr")
    })
    OrderDTO order2OrderDto(Order order);

    default Long toLong(String price) {
        if (Strings.isEmpty(price)) {
            return 0L;
        } else {
            return Long.parseLong(price);
        }
    }

    default String toStr(Long price) {
        if (price != null) {
            return price.toString();
        } else {
            return "0";
        }
    }


    /**
     * List对象转换方式
     *
     * @param orderDTOList
     * @return
     */
    List<Order> orderDto2Order(List<OrderDTO> orderDTOList);

    /**
     * 更新订单信息
     *
     * @param orderDTO
     * @return
     */
    @Mappings({
            @Mapping(source = "name", target = "title"),
            @Mapping(target = "gmtCreat", dateFormat = "yyyy-MM-dd HH:mm:ss"),
            @Mapping(target = "price", qualifiedByName = "toLong")
    })
    void updateOrder(OrderDTO orderDTO, @MappingTarget Order order);

    /**
     * 两个对象最终转化成一个对象
     *
     * @param orderDto
     * @param orderInfoDTO
     * @return
     */
    @Mappings({
            @Mapping(source = "orderInfoDTO.name", target = "title"),
            @Mapping(source = "orderDto.gmtCreat", target = "gmtCreat", dateFormat = "yyyy-MM-dd HH:mm:ss"),
            @Mapping(source = "orderInfoDTO.price", target = "price", qualifiedByName = "toLong")
    })
    Order getUserByOrderDTOAndOrderInfoDTO(OrderDTO orderDto, OrderInfoDTO orderInfoDTO);

    /**
     * 两个对象最终转化成一个对象
     *
     * @param orderDto
     * @param orderInfoDTO
     * @return
     */
    @Mappings({
            @Mapping(source = "orderInfoDTO.name", target = "title"),
            @Mapping(source = "orderDto.gmtCreat", target = "gmtCreat", dateFormat = "yyyy-MM-dd HH:mm:ss"),
            @Mapping(target = "price", source = "orderDto.price")
    })
    Order getUserByOrderDTOAndOrderInfoDTOChoicePrice(OrderDTO orderDto, OrderInfoDTO orderInfoDTO);
}

5、spring依赖注入使用方法

package com.eagle.example.mapstruct.convert;

import org.springframework.stereotype.Component;

/**
 * 有需要使用boolean转String方式的转化器
 * @author Bill
 * @date Created in 2021/9/26 17:08 <br>
 */
@Component
public class SpringBooleanStrFormat {

    private static final String Y_CHAR = "Y";

    private static final String N_CHAR = "N";

    public String toStr(Boolean isDisable) {
        if (isDisable) {
            return Y_CHAR;
        } else {
            return N_CHAR;
        }
    }

    public Boolean toBoolean(String str) {
        if (str.equals(Y_CHAR)) {
            return true;
        } else {
            return false;
        }
    }
}

package com.eagle.example.mapstruct.convert;

import com.eagle.example.mapstruct.dataobject.Order;
import com.eagle.example.mapstruct.dto.OrderDTO;
import org.mapstruct.InjectionStrategy;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.ap.internal.util.Strings;

import java.util.List;

/**
 * @author Bill
 * @date Created in 2021/9/23 16:43 <br>
 */
@Mapper(componentModel = "spring", injectionStrategy = InjectionStrategy.CONSTRUCTOR, uses = SpringBooleanStrFormat.class)
public interface SpringOrderMapper extends BaseMapstruct {

    /**
     * orderDto to Order
     *
     * @param orderDTO
     * @return
     */
    @Mappings({
            @Mapping(source = "name", target = "title"),
            @Mapping(target = "gmtCreat", dateFormat = "yyyy-MM-dd HH:mm:ss"),
            @Mapping(target = "price", qualifiedByName = "toLong")
    })
    Order orderDto2Order(OrderDTO orderDTO);

    /**
     * Order to orderDto
     *
     * @param order
     * @return
     */
    @Mappings({
            @Mapping(source = "title", target = "name"),
            @Mapping(target = "gmtCreat", dateFormat = "yyyy-MM-dd HH:mm:ss"),
            @Mapping(target = "price", qualifiedByName = "toStr")
    })
    OrderDTO order2OrderDto(Order order);

    default Long toLong(String price) {
        if (Strings.isEmpty(price)) {
            return 0L;
        } else {
            return Long.parseLong(price);
        }
    }

    default String toStr(Long price) {
        if (price != null) {
            return price.toString();
        } else {
            return "0";
        }
    }


    /**
     * orderDto to Order by list
     *
     * @param orderDTOList
     * @return
     */
    List<Order> orderDto2Order(List<OrderDTO> orderDTOList);

}

6、总结

7、源码和官网

github：eagle-example: 项目例子集合

官网：MapStruct – Java bean mappings, the easy way!

心之归处
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
为什么不推荐使用BeanUtils属性转换工具示例详解
08-18
主要介绍了为什么不推荐使用BeanUtils属性转换工具，本文通过示例代码给大家详细介绍，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
常见Bean拷贝框架使用姿势及性能对比
weixin_44882412的博客
05-25 1338
再实际的项目中，正好遇到了这个问题，不仅慢，还发现会有锁竞争，这特么就尼普了。上面的测试中，存在一个不同的变量，即不是用相同的source对象来测试不同的工具转换情况，但是这个不同并不会太影响不同框架的性能对比，基本上从上面的运行结果来看。MapStruct 性能更强悍了，缺点也比较明显，需要声明bean的转换接口，自动代码生成的方式来实现拷贝，性能媲美直接的get/set。当然我们现在一般用的Spring5+了，这段代码也早就做了改造了，新版的如下，不再存在上面的这个并发问题了。
高性能实体类转换工具MapStruct 使用教程
CharlesYooSky的博客
07-26 1522
高性能实体类转换工具MapStruct 使用教程
org.mapstruct:mapstruct 包（@Mapper、@Mapping）的使用
weixin_42272869的博客
01-06 1万+
org.mapstruct:mapstruct 包的使用 最近在学习技术时候，发现一个特别好用的包，org.mapstruct:mapstruct，它是专门用来处理 domin 实体类与 model 类的属性映射的 它的优势： 很多项目大量映射的方式通过手动get、set，首先写法很low，没有技术含量。而且中间还可能牵涉了很多类型转换，嵌套之类的繁琐操作，非常的麻烦。 关于属性的映射，apache的BeanUtil. copyProperties也可以实现，但是其性能差而且容易出异常，很多规范严禁使用这
BeanUtils与MapStruct
weixin_48359973的博客
08-19 912
本文介绍Spring的BeanUtils工具类的用法。我们经常需要将不同的两个对象实例进行属性复制，比如将DO对象进行属性复制到DTO，这种转换最原始的方式就是手动编写大量的 get/set代码，很繁琐。为了解决这一痛点，就诞生了一些方便的类库，常用的有 Apache的 BeanUtils,Spring的 BeanUtils, Dozer,Orika等拷贝工具。由于Apache的BeanUtils的性能很差，强烈不建议使用。
mapStruct测试成功以及报错总结
Kwan_9595的博客
08-27 1929
mapstruct工具转pojo,官网示例操作，走过路过不要错过，适合小白。。。
BeanUtils.copyProperties进行对象之间的属性赋值
柳落青
03-18 231
使用org.springframework.beans.BeanUtils.copyProperties方法进行对象之间属性的赋值，避免通过get、set方法一个一个属性的赋值 源码： /** * 对象属性拷贝 <br> * 将源对象的属性拷贝到目标对象 * * @param source 源对象 * @param target 目标对象 */ public static void copyProperties(Object
关于BeanUtils.copyProperties的用法和优缺点
Flyer的后花园
09-01 5820
一、简介:  　　BeanUtils提供对Java反射和自省API的包装。其主要目的是利用反射机制对JavaBean的属性进行处理。我们知道，一个JavaBean通常包含了大量的属性，很多情况下，对JavaBean的处理导致大量get/set代码堆积，增加了代码长度和阅读代码的难度。 二、用法：  　　BeanUtils是这个包里比较常用的一个工具类，这里只介绍它的copyPropert
mapstruct.zip
11-17
使用MapStruct替换BeanUtils，详见https://blog.csdn.net/z1353095373/article/details/109745090
Java工具类BeanUtils库介绍及实例详解
08-25
主要介绍了Java工具类BeanUtils库介绍及实例详解,需要的朋友可以参考下
BeanUtils工具类
12-28
内容概要：BeanUtils能够快速封装，减少代码 适用人群：学习java连接mysql的初学者 使用场景：连接数据库
BeanUtils工具类的使用.zip
11-02
BeanUtils工具类的使用.zip BeanUtils的作用：可以将jsp页面传过来的多个参数封装成一个对象。 资源包括：笔记、核心代码、搭建工程的步骤、搭建数据库的sql语句
BeanUtils.copyProperties的用法(超详细，建议收藏)
热门推荐
wwwwwww31311的博客
05-25 4万+
用法 org.springframework.beans.BeanUtils，它提供了对java反射和自省API的包装。它里面还有很多工具类，这里我们介绍一下copyProperties。 我们如果有两个具有很多相同属性的JavaBean对象a和b，想把a中的属性赋值到b，比如接口中将接收到的前端请求参数封装为reqVo,dan @Data public class User { private String id; private String name; private Stri
BeanUtils.copyProperties时日期的拷贝
11-28 4304
      首先定义一个Converter的Date实现类import java.util.Date;import org.apache.commons.beanutils.ConversionException;import org.apache.commons.beanutils.Converter;import cn.sh.cares.commons.excel.util.Excel
MapStruct快速上手
qq_45473439的博客
03-28 333
MapStruct 快速上手 简介 MapStruct是满足JSR269规范的一个Java注解处理器，用于为Java Bean生成类型安全且高性能的映射。它基于编译阶段生成get/set代码，此实现过程中没有反射，不会造成额外的性能损失。 使用- 1.注入方式 spring注入 @Mapper(componentModel = "spring") public interface ApiMapper { } ClassLoader 加载方式 @Mapper public interface Ap
mapstruct使用指南
tobebetter9527的博客
01-03 2223
文章目录1 简介2 简单入门2.1 maven配置 1 简介 一个工程中，我们会定义各种DO，DTO，VO等pojo。不同的pojo转化有两种方式，一是写getter/setter方法，另外一种是用BeanUtils.copyProperties()，第一种太繁琐，第二种不好定位问题，同时反射损耗性能。mapstruct完美解决上述问题。 mapstruct是一个java注解处理器，用来生成各种类型安全的映射类。主要优势如下： 执行速度快，因为使用普通的java方法取代反射； 编译类型安全，只要对应的实体
Mapstruct 属性类型由string转换为布尔类型
weixin_45716265的博客
06-15 2148
业务需求，前端需要的类型为布尔类型，数据库中存储的是字符串 查询到的结果是list，转换的属性类型及名称不一致。 前提：只有一个属性的类型是布尔类型 多个可以用数据字典维护这种对应关系 一、转换器 @Mapping(source = "disabled",target = "disable") RentsEntity dto2Entity(RentsVo rentsVo); 其中，source对应的是RentsVo中的属性名，target是转换后的属性名 若是数组 @Mapping
MapStruct文档（四）——转换
sinat_32787481的博客
12-09 6967
目录 3.1、隐式转换 3.1.1、枚举、BigDecimal、Date、Timestamp 3.1.2、LocalDateTime 3.1.3、Boolean 3.2、*对象属性转换 3.3、将映射目标类型传递给自定义映射器 3.4、将上下文或状态对象传递给自定义方法 3.5、区别相同参数类型和返回类型的映射方法 3.1、隐式转换 enum和String BigDecimal（等）、基本数据类(包括包装类)和String java.time.LocalDateTime（等）和.
6、Spring之Bean生命周期~创建Bean（2）
最新发布
sproutBoy的博客
06-10 690
【代码】6、Spring之Bean生命周期~创建Bean（2）
BeanUtils.copyProperties 可以使用 mapstruct 替换。
09-13
如果你需要频繁地进行属性拷贝，并且关注性能和类型安全，那么可以考虑使用MapStruct来替换BeanUtils.copyProperties。你可以创建一个包含映射规则的接口，并使用MapStruct来生成拷贝代码。这样就可以通过调用接口中...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值