脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → MapStruct实体转换复制

性能爆棚的实体转换复制工具MapStruct使用详解

 更新时间：2023年03月27日 14:34:40   作者：红兔哥  
这篇文章主要为大家介绍了性能爆棚的实体转换复制工具MapStruct使用详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

引言

Java项目中实体转换无处不在，当实体字段较多或者大批量的进行复制时，通过手工setter/getter显得太LOW，同时兼备高性能要求情况下，MapStruct完全完全能够胜任。官方解释，MapStruct是一个代码生成器，它基于约定优于配置的方法，极大地简化了Java bean类型之间映射的实现。生成的映射代码使用普通方法调用，因此快速、类型安全且易于理解。因为MapStruct是在编译期间生成setter/getter方法，实际运行时就是直接调用setter/getter，效率会非常高。

优点

  • MapStruct编译期生成映射代码，所以可以在编译时暴露映射错误的代码，让错误提前暴露；
  • 因为使用setter/getter方式，而非反射方式，所以可以更快的执行效率；
  • 可以实现深拷贝，自动类型转换，如枚举转换；
  • 进行自定义的映射，多种映射方式，下边具体说明；

性能对比

对比对象10个对象复制1次1万个对象复制1次100万个对象复制1次100万个对象复制5次
MapStruct0ms3ms96ms281ms
Hutools的BeanUtil23ms102ms1734ms8316ms
Spring的BeanUtils2ms47ms726ms3676ms
Apache的BeanUtils20ms156ms10658ms52355ms
Apache的PropertyUtils5ms68ms6767ms30694ms

使用

依赖

<!-- MapStruct核心，包含了一些必要的注解-->
<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>${org.mapstruct.version}</version>
    </dependency>
</dependencies>
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <annotationProcessorPaths>
                    <!-- MapStruct编译，注解处理器，根据注解自动生成Mapper的实现 -->
                    <path>
                        <groupId>org.mapstruct</groupId>
                        <artifactId>mapstruct-processor</artifactId>
                        <version>${org.mapstruct.version}</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

定义转换接口

/**
 * 测试接口
 *
 * @author reboot
 */
@Mapper
public interface OrderConvertor {
    /**
     * 实例
     */
    OrderConvertor INSTANCE = Mappers.getMapper(OrderConvertor.class);
    /**
     * OrderDo -> OrderModel
     *
     * @param orderDo 订单实体
     * @return {@link OrderModel}
     */
    OrderModel toModel(OrderDo orderDo);
    /**
     * OrderDo -> OrderModel
     *
     * @param orderDos 订单实体
     * @return {@link OrderModel}
     */
    List<OrderModel> toModel(List<OrderDo> orderDos);
    /**
     * OrderModel -> OrderDo
     *
     * @param orderModel 订单模型
     * @return {@link OrderDo}
     */
    OrderDo toDo(OrderModel orderModel);
    /**
     * OrderModel -> OrderDo
     *
     * @param orderModels 订单模型
     * @return {@link OrderDo}
     */
    List<OrderDo> toDo(List<OrderModel> orderModels);
}

编译结果

MapStruct会自动生成对应接口的实现，并自动完成属性映射关系，List会自动进行批量处理。

调用

/**
 * 订单服务
 *
 * @author reboot
 */
@Service
public class OrderService {
    /**
     * 获取订单列表
     *
     * @return {@link List}<{@link OrderModel}>
     */
    public List<OrderModel> getOrderList() {
        // 获取数据库数据DO
        List<OrderDo> result = selectOrderList();
        // 参数转换
        return OrderConvertor.INSTANCE.toModel(result);
    }
}

插件

上边的使用方式虽然能够正常使用，但是在一些属性配置映射上和提示上，如果使用插件能够提升使用体验，IDEA中可以直接安装Mapstruct Support插件，当然Eclipse也有对应的插件。

特性

  • 突出显示目标属性和源属性。将目标属性和源属性转到声明的setter / getter中；
  • 错误和快速修复：
    • 缺少@Mapper或@MapperConfig注解检查；
    • 快速修复未映射的目标属性，添加未映射目标属性和忽略未映射目标属性；

其他用法

更加详细的内容可以查看官方文档，发布文章时最新版本是 MapStruct 1.5.3.Final.html。

基础映射

@Mapper
public interface CarMapper {
    @Mapping(target = "manufacturer", source = "make")
    @Mapping(target = "seatCount", source = "numberOfSeats")
    CarDto carToCarDto(Car car);
    @Mapping(target = "fullName", source = "name")
    PersonDto personToPersonDto(Person person);
}

target表示目标属性名，source表示源属性名，一般在目标属性和源属性不同时使用，相同的属性名会自动进行映射。

映射器添加自定义方法

@Mapper
public interface CarMapper {
    @Mapping(...)
    ...
    CarDto carToCarDto(Car car);
    default PersonDto personToPersonDto(Person person) {
        //hand-written mapping logic
    }
}

自定义方法personToPersonDto并实现，在生成的实现类中会进行覆盖使用。

多个源参数映射

@Mapper
public interface AddressMapper {
    @Mapping(target = "description", source = "person.description")
    @Mapping(target = "houseNumber", source = "address.houseNo")
    DeliveryAddressDto personAndAddressToDeliveryAddressDto(Person person, Address address);
    @Mapping(target = "description", source = "person.description")
    @Mapping(target = "houseNumber", source = "hn")
    DeliveryAddressDto personAndAddressToDeliveryAddressDto(Person person, Integer hn);
}

存在多个源参数，使用参数名.属性名的方式进行表示，也可以直接使用基础类型的属性名称。

嵌套属性映射到当前目标

@Mapper
 public interface CustomerMapper {
     @Mapping( target = "name", source = "record.name" )
     @Mapping( target = ".", source = "record" )
     @Mapping( target = ".", source = "account" )
     Customer customerDtoToCustomer(CustomerDto customerDto);
 }

当源参数中存在对象属性，可以手动进行映射，或者直接使用"."的方式将对象中的属性全部映射到当前目标对象。

表达式方式

@Mapper
public interface SourceTargetMapper {
    SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
    @Mapping(
        target = "timeAndFormat",
        expression = "java( new org.sample.TimeAndFormat( s.getTime(), s.getFormat() ) )"
    )
    Target sourceToTarget(Source s);
}

支持使用java代码块进行转换，一般可以将静态方法处理的字段放到这里。

更新现有实例

@Mapper
public interface CarMapper {
    void updateCarFromDto(CarDto carDto, @MappingTarget Car car);
}

@MappingTarget源参数，编译时会将carDto参数中的属性映射到car参数中。

Map映射

@Mapper
public interface CustomerMapper {
    @Mapping(target = "name", source = "customerName")
    Customer toCustomer(Map<String, String> map);
}

直接将map中的key进行映射。

更多用法

还有更多其他用法，比如：

  • 支持映射定义的public属性；
  • 支持映射参数Builder模式；
  • 使用注入方式引入转换器；
  • 数据类型字段转换，如枚举、日期，支持日期格式化，支持数字类型格式化，具体可以看 Implicit type conversions；
  • 集合类型自动转换；
  • 转换Stream；
  • ......

总结

MapStruct还有很多其他高阶特性，限于篇幅文章仅仅列举部分示例，有兴趣的同学可以查看对应文档试试。使用适当的工具有效提高编程效率，在使用工具过程中我们也了解其实现原理，不断提高自身。后边有时间也把MapStruct实现原理拿出来讲讲，跟大家一起学习进步！

以上就是性能爆棚的实体转换复制工具MapStruct使用详解的详细内容，更多关于MapStruct实体转换复制的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • IDEA创建springboot依赖下载很慢的解决方法

    IDEA创建springboot依赖下载很慢的解决方法

    maven会使用远程仓库来加载依赖,是一个国外的网站,所以会很慢,本文主要介绍了IDEA创建springboot依赖下载很慢的解决方法,具有一定的参考价值,感兴趣的可以了解一下
    2023-12-12
  • Springboot中动态语言groovy介绍

    Springboot中动态语言groovy介绍

    Apache的Groovy是Java平台上设计的面向对象编程语言，这门动态语言拥有类似Python、Ruby和Smalltalk中的一些特性，可以作为Java平台的脚本语言使用，这篇文章主要介绍了springboot中如何使用groovy,需要的朋友可以参考下
    2022-09-09
  • 深入解析Java中的数据类型与变量

    深入解析Java中的数据类型与变量

    这篇文章主要介绍了深入解析Java中的数据类型与变量,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-09-09
  • springboot中@ConfigurationProperties无效果的解决方法

    springboot中@ConfigurationProperties无效果的解决方法

    本文主要介绍了springboot中@ConfigurationProperties无效果,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-06-06
  • Java定义形式及可变参数实例解析

    Java定义形式及可变参数实例解析

    这篇文章主要介绍了Java定义形式及可变参数实例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • java使用PDFRenderer实现预览PDF功能

    java使用PDFRenderer实现预览PDF功能

    这篇文章主要为大家详细介绍了java使用PDFRenderer实现预览PDF功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-12-12
  • Java必备知识之位运算及常见进制解读

    Java必备知识之位运算及常见进制解读

    从现代计算机中所有的数据二进制的形式存储在设备中。即 0、1 两种状态，计算机对二进制数据进行的运算(+、-、*、/)都是叫位运算，即将符号位共同参与运算的运算
    2021-10-10
  • Spring Boot使用线程池创建多线程的完整示例

    Spring Boot使用线程池创建多线程的完整示例

    在 Spring Boot 2 中,可以使用 @Autowired 注入 线程池（ThreadPoolTaskExecutor 或 ExecutorService）,从而管理线程的创建和执行,以下是使用 @Autowired 方式注入线程池的完整示例,感兴趣的朋友一起看看吧
    2025-03-03
  • Spring加载properties文件的两种方式实例详解

    Spring加载properties文件的两种方式实例详解

    这篇文章主要介绍了Spring加载properties文件的两种方式,需要的朋友可以参考下
    2018-02-02
  • javaweb实现百度GPS定位接口（经纬度）

    javaweb实现百度GPS定位接口（经纬度）

    这篇文章主要介绍了javaweb实现百度GPS定位接口（经纬度），文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-02-02

最新评论