【开发实用】还在用BeanUtils?不如用MapStruct

news2024/12/28 20:38:23

文章目录

  • 1. 什么是MapStruct
  • 2. 为什么使用MapStruct
  • 3. 如何使用MapStruct

1. 什么是MapStruct

MapStruct是一个Java注解处理器,它可以简化Java bean之间的转换。它使用基于生成器的方法创建类型安全的映射代码,这些代码在编译时生成,并且比反射更快、更可靠。使用MapStruct可以避免手动编写大量重复的转换代码,从而提高生产力和代码质量。

MapStruct通过使用注解,在源代码中指定映射规则,MapStruct可以自动生成转换器代码。MapStruct支持各种转换场景,包括简单类型、集合、继承、日期、枚举、嵌套映射等等。同时,它还能够与Spring和CDI等IoC容器无缝集成,方便地将MapStruct转换器注入到应用程序中。

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

在开发中比较常用的用来实现JavaBean之间的转换应该就是org.springframework.beans.BeanUtils,它俩有以下区别:

  1. 编译时生成代码 vs 运行时反射MapStruct生成的映射代码是在编译时生成的,而BeanUtils则是在运行时使用反射机制实现转换
  2. 性能和可扩展性:由于MapStruct生成的代码是类型安全的,因此可以比使用反射更加高效和可靠。同时,MapStruct还能够自定义转换逻辑并支持扩展,使得它更加灵活和可扩展。
  3. 集成方式:MapStruct可以无缝集成到Spring中,也可以与其他IoC容器结合使用;而BeanUtils是Spring框架自带的工具类。
  4. 映射规则的定义方式:MapStruct使用基于注解的方式在源代码中定义映射规则,而BeanUtils则需要手动编写复杂的转换方法。

2. 为什么使用MapStruct

在一些高并发的场景,性能是开发者十分重视的,BeanUtils虽然也可以方便地完成JavaBean之间的转换,但是由于其底层是基于反射实现的,在高并发场景下难免会出现大规模的数据处理和转换操作,这时候还是用BeanUtils会导致接口响应速度有所下降。

这时候,最最最高效的方法就是手动get/set,但是这种需要反复写大量重复的转换代码,并且这些代码难以被反复利用,于是就考虑使用MapStruct。

MapStruct是一种基于注解的代码生成器,它通过生成优化的映射代码来实现高性能的Bean映射。与BeanUtils相比,MapStruct在生成的映射代码中使用了更少的反射调用,并且在类型转换时可以直接使用Javac编译器已经提供的类型转换逻辑,从而避免了额外的性能开销。此外,由于MapStruct是基于注解的,它还可以提供更好的类型检查和编译时错误提示。

以下是当前比较常用的JavaBean之间转化的工具的性能对比:

image-20230602212240984

可见,随着转化次数的增加只有MapStruct的性能最接近get/set的效率。

因此,在高并发场景下,使用MapStruct可以更有效地利用系统资源,提高系统的吞吐量和响应速度。


3. 如何使用MapStruct

接下来用一个案例来说说如何使用MapStruct,更多详细的用法可以查看官方文档。

温馨提示:在生成get/set方法的时候,最好不要用lombok,不然有可能会出现一些奇奇怪怪的问题

先引入依赖:

<!-- MapStruct begin -->
<!-- https://mvnrepository.com/artifact/org.mapstruct/mapstruct -->
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct</artifactId>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mapstruct/mapstruct-processor -->
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
</dependency>
<!-- MapStruct end -->

Student类:

public class Student {
    private String sId;
    private String sName;
    private String sSex;

    public String getsId() {
        return sId;
    }

    public void setsId(String sId) {
        this.sId = sId;
    }

    public String getsName() {
        return sName;
    }

    public void setsName(String sName) {
        this.sName = sName;
    }

    public String getsSex() {
        return sSex;
    }

    public void setsSex(String sSex) {
        this.sSex = sSex;
    }
}

StudentVo类:

public class StudentVo {
    private String id;
    private String name;
    private String sSex;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getsSex() {
        return sSex;
    }

    public void setsSex(String sSex) {
        this.sSex = sSex;
    }
}

现在模拟两个业务:

  1. Student类 转 StudentVo类
  2. StudentVo类 转 Student类

首先,需要定义一个对象接口映射的接口

/**
 * @description:对象接口映射
 * @author:lrk
 * @date: 2023/6/2
 */
@MapperConfig
public interface IMapping<SOURCE, TARGET> {
    /**
     * 映射同名属性
     * @param var1 源
     * @return     结果
     */
    @Mapping(target = "createTime", dateFormat = "yyyy-MM-dd HH:mm:ss")
    TARGET sourceToTarget(SOURCE var1);

    /**
     * 映射同名属性,反向
     * @param var1 源
     * @return     结果
     */
    @InheritInverseConfiguration(name = "sourceToTarget")
    SOURCE targetToSource(TARGET var1);

    /**
     * 映射同名属性,集合形式
     * @param var1 源
     * @return     结果
     */
    @InheritConfiguration(name = "sourceToTarget")
    List<TARGET> sourceToTarget(List<SOURCE> var1);

    /**
     * 反向,映射同名属性,集合形式
     * @param var1 源
     * @return     结果
     */
    @InheritConfiguration(name = "targetToSource")
    List<SOURCE> targetToSource(List<TARGET> var1);

    /**
     * 映射同名属性,集合流形式
     * @param stream 源
     * @return       结果
     */
    List<TARGET> sourceToTarget(Stream<SOURCE> stream);

    /**
     * 反向,映射同名属性,集合流形式
     * @param stream 源
     * @return       结果
     */
    List<SOURCE> targetToSource(Stream<TARGET> stream);
}

这个接口上需要加org.mapstruct.MapperConfig的注解,表示这是一个构造器。

接下来,就需要构造一个具体类的转换配置了,需要继承IMapping接口

这里就模拟转换两个类的相互转化,其他比如List的转换可以自主实现

/**
 * @description:学生类转换配置
 * @author:lrk
 * @date: 2023/6/2
 */
@Mapper(
        // 指定依赖注入框架
        componentModel = "spring",
        unmappedTargetPolicy = ReportingPolicy.IGNORE,
        unmappedSourcePolicy = ReportingPolicy.IGNORE
)
public interface StudentMapping extends IMapping<Student, StudentVo>{

    /**
     * Student 转 StudentVo
     * @param var1 源
     * @return
     */
    @Mapping(target = "id", source = "sId")
    @Mapping(target = "name", source = "sName")
    @Override
    StudentVo sourceToTarget(Student var1);

    /**
     * StudentVo 转 Student
     * @param var1 源
     * @return
     */
    @Mapping(target = "sId", source = "id")
    @Mapping(target = "sName", source = "name")
    @Override
    Student targetToSource(StudentVo var1);
}
  1. 继承接口的泛型为<Student, StudentVo>,指定了Student是源,StudentVo是目标。
  2. 接口上需要有org.mapstruct.Mapper注解,注解里面有三个参数
    • componentModel:指定依赖注入框架,目前只支持springCDI
    • unmappedTargetPolicy:在映射方法的目标对象的属性未填充源值时应用的默认报告策略。
      • ERROR:任何未映射的目标属性都将导致映射代码生成失败
      • WARN:任何未映射的目标属性都将在构建时导致警告
      • IGNORE:忽略未映射的目标属性
    • unmappedSourcePolicy:同上
  3. 认真观察Student与StudentVo可以看见,两个类除了成员变量sSex一样外,其余的成员变量属性均不一样,这时候可以使用org.mapstruct.Mapping注解在接口方法上
    • Mapping:当属性在目标实体中具有不同的名称时,可以通过注释指定其名称

编写测试代码

@Resource
private IMapping<Student, StudentVo> studentMapping;


@Test
public void test_mapstruct() {
    Student student = new Student();
    student.setsId("10086");
    student.setsName("张三");
    student.setsSex("男");
    StudentVo studentVo = studentMapping.sourceToTarget(student);
    log.info("Student:{} 转 StudentVo:{}", JSONUtil.toJsonStr(student), JSONUtil.toJsonStr(studentVo));
    Student student1 = studentMapping.targetToSource(studentVo);
    log.info("StudentVo:{} 转 Student:{}", JSONUtil.toJsonStr(studentVo), JSONUtil.toJsonStr(student1));

}

image-20230602214035903

细心的你估计已经发现了,为什么这里可以用@ResourceIMapping<Student, StudentVo>注入,代码中并没有看见将其放进Spring容器呀?

别急,前面说到MapStruct的转换代码是在编译时生成的,查看编译生成的代码可以发现其中已经加入了@Component注解并实现了StudentMapping

@Component
public class StudentMappingImpl implements StudentMapping {
    public StudentMappingImpl() {
    }

    public List<StudentVo> sourceToTarget(List<Student> var1) {
        if (var1 == null) {
            return null;
        } else {
            List<StudentVo> list = new ArrayList(var1.size());
            Iterator var3 = var1.iterator();

            while(var3.hasNext()) {
                Student student = (Student)var3.next();
                list.add(this.sourceToTarget(student));
            }

            return list;
        }
    }

    public List<Student> targetToSource(List<StudentVo> var1) {
        if (var1 == null) {
            return null;
        } else {
            List<Student> list = new ArrayList(var1.size());
            Iterator var3 = var1.iterator();

            while(var3.hasNext()) {
                StudentVo studentVo = (StudentVo)var3.next();
                list.add(this.targetToSource(studentVo));
            }

            return list;
        }
    }

    public List<StudentVo> sourceToTarget(Stream<Student> stream) {
        return stream == null ? null : (List)stream.map((student) -> {
            return this.sourceToTarget(student);
        }).collect(Collectors.toCollection(ArrayList::new));
    }

    public List<Student> targetToSource(Stream<StudentVo> stream) {
        return stream == null ? null : (List)stream.map((studentVo) -> {
            return this.targetToSource(studentVo);
        }).collect(Collectors.toCollection(ArrayList::new));
    }

    public StudentVo sourceToTarget(Student var1) {
        if (var1 == null) {
            return null;
        } else {
            StudentVo studentVo = new StudentVo();
            studentVo.setId(var1.getsId());
            studentVo.setName(var1.getsName());
            studentVo.setsSex(var1.getsSex());
            return studentVo;
        }
    }

    public Student targetToSource(StudentVo var1) {
        if (var1 == null) {
            return null;
        } else {
            Student student = new Student();
            student.setsId(var1.getId());
            student.setsName(var1.getName());
            student.setsSex(var1.getsSex());
            return student;
        }
    }
}

这是因为前面在StudentMapping指定了依赖注入框架为Spring的原因,所以生成的代码自动将其放进容器,方便我们开发者使用。


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/602847.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

2023夏季黑客松大赛,Moonbeam邀请你来BUIDL

由Parity和OneBlock联合举办的「2023 夏季波卡黑客松大赛」正在火热开启中。自报名开启之日&#xff0c;便获得了来自海内外对波卡生态的高度专注和对Web3开发的热情。 本次黑客松聚焦智能合约、开发工具、社交网络等大赛命题&#xff0c;邀请了行业领军人、技术大咖、投资人等…

推进开源法律知识普及|2023开放原子全球开源峰会开源法律与合规分论坛即将启幕

随着开源在推动创新、促进协作方面的作用日益凸显&#xff0c;开源领域的法律与合规问题日益受到关注。 6月11日&#xff0c;开放原子全球开源峰会开源法律与合规分论坛将在北京经济开发区国家信创园召开&#xff0c;论坛以“开源知识产权的深度现实与广阔未来”为主题&#x…

基于SSM的校园旧书交易交换平台

末尾获取源码 开发语言&#xff1a;Java Java开发工具&#xff1a;JDK1.8 后端框架&#xff1a;SSM 前端&#xff1a;采用JSP技术开发 数据库&#xff1a;MySQL5.7和Navicat管理工具结合 服务器&#xff1a;Tomcat8.5 开发软件&#xff1a;IDEA / Eclipse 是否Maven项目&#x…

Mybatis_plus——标准分页功能制作

mybatispuls中提供分页查询中需要两个参数&#xff0c;一个是IPage接口的实现类&#xff0c;还有一个后面说。 IPage有且只有一个实现类Page类型在里面已经提供有了&#xff0c;传两个参数即可使用&#xff0c;一个是页码值&#xff0c;一个是每页显示数据的条数。查询完之后可…

chatgpt赋能python:Python代做:让您的网站更友好的SEO利器

Python代做&#xff1a;让您的网站更友好的SEO利器 如果您是一位网站管理员或者SEO工程师&#xff0c;您一定知道SEO对于网站的重要性。那么在SEO中&#xff0c;Python代做可以为您提供什么&#xff1f;在本文中&#xff0c;我们将通过介绍Python代做的技术和方法&#xff0c;…

unity发布webGL后无法预览解决

众所周知&#xff0c;unity发布成webgl后是无法直接预览的。因为一般来说浏览器默认都是禁止webgl运行的。 直接说我最后的解决方法&#xff1a;去vscode里下载一个live server ,安装好。 下载vscode地址Visual Studio Code - Code Editing. Redefined 期间试过几种方法都不管…

Ansys Zemax | 探究 OpticStudio 偏振分析功能

本文介绍了 OpticStudio 模拟基于偏振的光学现象的几种方法。本文的目的是在对基于偏振的光学进行建模时检查这些特征的优势和正确应用。讨论的功能包括偏振光瞳图、琼斯矩阵、双折射、表面涂层等。这些对于波片和隔离器等实际应用很重要。&#xff08;联系我们获取文章附件&am…

plt.loglog()函数的用法和示例(含代码)

目录 常用坐标下的图像显示在loglog函数下的显示同时显示参考文献 plt.loglog()函数通常是用于和对数函数相关的显示中。 在研究plt.loglog()函数之前&#xff0c;我们可以先从常见的线性平面坐标系入手。 如 np.linespace()函数,它在指定的间隔内返回均等的数字。 np.linespa…

Redis主从架构、数据同步原理、全量同步、增量同步

目录 专栏导读一、Redis主从架构二、数据同步原理三、全量同步的流程三、可以从以下几个方面来优化Redis主从就集群四、全量同步和增量同步区别&#xff1f;五、什么时候执行全量同步&#xff1f;六、什么时候执行增量同步&#xff1f;七、超卖问题 大家好&#xff0c;我是哪吒…

高完整性系统工程(八):Hoare Logic

目录 1. 霍尔逻辑&#xff08;Proving Programs Correct&#xff09; 1.1 警告&#xff08;Caveats&#xff09; 1.2 误解&#xff08;Misconception&#xff09; 1.3 编程语言&#xff08;Programming Language&#xff09; 1.4 程序&#xff08;Programs&#xff09; 1…

java学习 spring mybatis maven juc并发 缓存 分布式

Spring系列第11篇&#xff1a;bean中的autowire-candidate又是干什么的&#xff1f;_路人甲Java的博客-CSDN博客 Spring系列 Spring系列第1篇&#xff1a;为何要学spring&#xff1f; Spring系列第2篇&#xff1a;控制反转&#xff08;IoC&#xff09;与依赖注入&#xff08;DI…

I.MX RT1170加密启动详解(1):加密Boot镜像组成

使用RT1170芯片构建的所有平台一般都是高端场合&#xff0c;我们需要考虑软件的安全需求。该芯片集成了一系列安全功能。这些特性中的大多数提供针对特定类型攻击的保护&#xff0c;并且可以根据所需的保护程度配置为不同的级别。这些特性可以协同工作&#xff0c;也可以独立工…

macOS Ventura 13.5beta2 OpenCore 双引导分区原版黑苹果镜像

镜像特点&#xff08;本文原地址&#xff1a;http://www.imacosx.cn/113805.html&#xff0c;转载请注明出处&#xff09; 完全由黑果魏叔官方制作&#xff0c;针对各种机型进行默认配置&#xff0c;让黑苹果安装不再困难。系统镜像设置为双引导分区&#xff0c;全面去除clove…

【cfeng work】什么是云原生 Cloud Native

WorkProj 内容管理 云原生云原生应用十二要素应用cfeng的work理解 本文introduce 云原生 Cloud Native相关内容 随着技术的迭代&#xff0c;从最初的物理机—> 虚拟机&#xff0c;从单机 —> 分布式微服务&#xff0c; 现在的热门概念就是云☁&#xff08;cloud&#xff…

Windows 11 绕过 TPM 方法总结,通用免 TPM 镜像下载 (2023 年 5 月更新)

Windows 11 绕过 TPM 方法总结&#xff0c;通用免 TPM 镜像下载 (2023 年 5 月更新) 在虚拟机、Mac 电脑和 TPM 不符合要求的旧电脑上安装 Windows 11 的通用方法总结 请访问原文链接&#xff1a;https://sysin.org/blog/windows-11-no-tpm/&#xff0c;查看最新版。原创作品…

Tomcat安全配置

1.删除webapps里面自带文件&#xff08;关闭manage页面等&#xff09; 删除webapps目录中的docs、examples、host-manager、manager等正式环境用不着的目录&#xff0c;这一步就可以解决大部分漏洞。有的网站没删除manager页面&#xff0c;并且管理员弱口令&#xff0c;导致直…

PCL点云处理之三维凸包点提取与凸包模型生成,分别保存到PCD与PLY文件(一百七十一)

PCL点云处理之三维凸包点提取与凸包模型生成,分别保存到PCD与PLY文件(一百七十一) 一、算法介绍二、算法实现1.代码2.结果总结一、算法介绍 现给定一块点云,需要实现下面两个功能开发 (1)获取点云的三维凸包点,保存至PCD格式的文件中 (2)获取点云的三维凸包模型,保存…

华为OD机试真题B卷 Java 实现【报数游戏】,附详细解题思路

一、题目描述 100个人围成一圈&#xff0c;每个人有一个编码&#xff0c;编号从1开始到100。他们从1开始依次报数&#xff0c;报到为M的人自动退出圈圈&#xff0c;然后下一个人接着从1开始报数&#xff0c;直到剩余的人数小于M。请问最后剩余的人在原先的编号为多少&#xff…

Netty核心源码剖析(一)

准备工作 将Netty的源码包netty-all-4.1.20.Final-sources.jar添加到项目中; 在io.netty.example包下,有很多Netty源码案例,可以用来分析! 1.Netty启动过程源码剖析 1>.将io.netty.exampler.echo包下的文件复制到当前项目的其他目录中; 2>.EchoServer.java /*** Ec…

建立第一个react页面

<body><!-- 准备一个容器 --><div id"test"></div><!-- 必须在周边库之前引入核心库 --><script type"text/javascript"src"./js/react.development.js"></script><!-- 引入周边库 --><scr…