返回顶部
首页 > 资讯 > 后端开发 > Python >Java MapStruct解了对象映射的毒
  • 680
分享到

Java MapStruct解了对象映射的毒

2024-04-02 19:04:59 680人浏览 安东尼

Python 官方文档:入门教程 => 点击学习

摘要

目录前言介绍代码编写探个究竟结尾前言 mvc模式是目前主流项目的标准开发模式,这种模式下框架的分层结构清晰,主要分为Controller,Service,Dao。分层的结构下,各层之

前言

mvc模式是目前主流项目的标准开发模式,这种模式下框架的分层结构清晰,主要分为Controller,Service,Dao。分层的结构下,各层之间的数据传输要求就会存在差异,我们不能用一个对象来贯穿3层,这样不符合开发规范且不够灵活。

我们常常会遇到层级之间字段格式需求不一致的情况,例如数据库中某个字段是datetime日期格式,这个时间戳在数据库中的存储值为2020-11-06 23:59:59.999999,但是传递给前端的时候要求接口返回yyyy-MM-dd的格式,或者有些数据在数据库中是逗号拼接的String类型,但是前端需要的是切割后的List类型等等。

所以我们提出了层级间的对象模型,就是我们常见的VO,DTO,DO,PO等等。这种区分层级对象模型的方式虽然清晰化了我们各层级间的对象传递,但是对象模型间的相互转换和值拷贝确是让人感觉很麻烦,拷贝来拷贝去,来来回回,过程重复乏味,编写此类映射代码是一项繁琐且容易出错的任务。

最简单粗糙的拷贝方法就是不断的new对象然后对象间的 setter 和 getter,这种方式应对字段属性少的还可以,如果属性字段很多那么大段的set,get的代码就显得很不雅美。因此需要借助对象拷贝工具,目前市场上的也蛮多的像BeanCopy,Dozer等等,但是这些我感觉都不够好,今天我推荐一个实体映射工具就是 MapStruct。

介绍

MapStruct的官网地址是 https://mapstruct.org/MapStruct,是一个快速安全的bean 映射代码生成器,只需要通过简单的注解就可以实现对象间的属性转换,是一款 Apache LICENSE 2.0 授权的开源产品,GitHub源码地址是 Https://github.com/mapstruct。

通过官网的三连问(What,Why,How)我们可以大概的了解到 MapStruct 的作用,它的优势以及它是如何实现的。

从上面的三连问中我们可以得到如下信息:

  • 基于约定优于配置的方法 MapStruct 极大地简化了 Java bean 类型之间的映射的实现,通过简单的注解就可以工作。生成的映射代码使用普通的方法调用而不是反射,因此速度快,类型安全且易于理解。
  • 在编译时生成 Bean 映射 与其他映射框架相比,MapStruct 在编译时生成 Bean 映射,这样可以确保高性能,而且开发人员可以快速的得到反馈和彻底的错误检查。
  • 一个注释处理器 MapStruct 是一个注释处理器,已插入 Java 编译器,可用于命令行构建(Maven,Gradle等),也可用于您首选的IDE中(idea,Eclipse等)。

代码编写

MapStruct 需要 Java 1.8或更高版本。对于Maven-based 的项目,在pom 文件中添加如下依赖即可


<!-- 指定版本-->
<properties>
    <org.mapstruct.version>1.4.1.Final</org.mapstruct.version>
</properties>
<!-- 添加依赖 -->
<dependencies>
   <dependency>
	<groupId>org.mapstruct</groupId>
	<artifactId>mapstruct</artifactId>
	<version>${org.mapstruct.version}</version>
   </dependency>
   <dependency>
	<groupId>org.mapstruct</groupId>
	<artifactId>mapstruct-processor</artifactId>
	<version>${org.mapstruct.version}</version>
   </dependency>
</dependencies>

基本的依赖引入后就可以编写代码了,简单的定义一个映射类,为了与 mybatis中的 mapper 接口区分,我们可以取名为 xxObjectConverter

例如汽车对象的映射类名为 CarObjectConverter,我们有两个对象模型 DO 和 DTO,它们内部的属性字段如下:

数据库对应的持久化对象模型 CarDo


public class Car {
    @apiModelProperty(value = "主键id")
    private Long id;
	
    @ApiModelProperty(value = "制造商")
    private String manufacturers;
	
    @ApiModelProperty(value = "销售渠道")
    private String saleChannel;

    @ApiModelProperty(value = "生产日期")
    private Date productionDate;
    ...
}

层级间传输的对象模型 CarDto


public class CarDto {
    @ApiModelProperty(value = "主键id")
    private Long id;
	
    @ApiModelProperty(value = "制造商")
    private String maker;
	
    @ApiModelProperty(value = "销售渠道")
    private List<Integer> saleChannel;

    @ApiModelProperty(value = "生产日期")
    private Date productionDate;
    ...
}

再编写具体的 MapStruct 对象映射器


@Mapper
public interface CarObjectConverter{

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

    @Mapping(target = "maker", source = "manufacturers")
    CarDto carToCarDto(Car car);

}

对于字段名相同的可以不用额外的指定映射规则,但是字段名不同的属性则需要指出字段的映射规则,如上我们持久层 DO 的制造商的字段名是manufacturers 而层级间传输的DTO模型中则是maker,我们就需要在映射方法上通过@Mapping注解指出映射规则,我个人习惯是喜欢将target写在前面,source写在后面,这样是与映射对象的位置保持一致,差异字段多的时候方便对比且不易混淆。

开发过程中还会经常遇到一些日期格式的转换,就如开篇时说的那种,这时我们也可以指定日期的映射规则


@Mapper
public interface CarObjectConverter{

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

    @Mapping(target = "maker", source = "manufacturers")
    @Mapping(target = "productionDate", dateFORMat = "yyyy-MM-dd", source = "productionDate")
    CarDto carToCarDto(Car car);

}

这些都还是一些简单的字段的映射,但有时候我们两个对象模型间的字段类型不一致,如上汽车的销售渠道字段saleChannel,这个在数据库中是字符串逗号拼接的值1,2,3,而我们传递出去的需要是 List 的 Integer 类型,这种复杂的如何映射呢?

也是有方法的,我们先编写一个将字符串逗号分隔然后转成 List 的工具方法,如下


public class CollectionUtils {

    public static List<Integer> list2String(String str) {
        if (StringUtils.isNoneBlank(str)) {
            return Arrays.asList(str.split(",")).stream().map(s -> Integer.valueOf(s.trim())).collect(Collectors.toList());
        }
        return null;
    }
}

然后在映射Mapping中使用表达式即可


@Mapper
public interface CarObjectConverter {

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

    @Mapping(target = "maker", source = "manufacturers")
    @Mapping(target = "productionDate", dateFormat = "yyyy-MM-dd", source = "productionDate")
    @Mapping(target = "saleChannel", expression = "java(com.jiajian.demo.utils.CollectionUtils.list2String(car.getSaleChannel()))")
    CarDto carToCarDto(Car car);

}

这样就完成了所有字段的映射工作,我们在需要对象模型转换的地方按照如下方式调用即可


CarDto carDto = CarObjectConverter.INSTANCE.carToCarDto(car);

这种是单体对象之间的 Copy 很多时候我们需要 List 对象模型间的转换,只需要再写一个方法carToCarDtos即可


@Mapper
public interface CarObjectConverter{

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

    @Mapping(target = "maker", source = "manufacturers")
    @Mapping(target = "productionDate", dateFormat = "yyyy-MM-dd", source = "productionDate")
    @Mapping(target ="saleChannel", expression = "java(com.jiajian.demo.utils.CollectionUtils.list2String(car.getSaleChannel()))")
    CarDto carToCarDto(Car car);

    List<CarDto> carToCarDtos(List<Car> carList);

}

探个究竟

会不会好奇这是怎么实现的,我们只是创建了一个接口然后在接口方法上加一个注解并在注解里面指定字段的映射规则就可以实现对象属性间的拷贝,这是怎么做到的呢?

我们这里通过 MapStruct 创建的只是一个接口,要实现具体的功能接口必有实现。

MapStruct 会在我们代码编译的时候为我们创建一个实现类,而这个实现类里面通过字段的setter, getter方法来实现字段的赋值,从而实现对象的映射。

这里需要注意一点:如果你修改了任一映射对象,记得需要先执行mvn clean再启动项目,否则调试的时候会报错。

结尾

MapStrut 的功能远不至于上面介绍的这些,我只是挑出几个常用的语法进行示例讲解,如果读者感兴趣想深入的了解更多可以参考官方的参考文档

遇见 MapStruct 后我就开始在项目中抛弃掉了原来的那些 BeanCopyUtils 的工具,相对而言 MapStruct 确实更简洁且易使用而且定制功能也很强。

从编译文件可以看出 MapStruct 是通过setter,getter来实现属性值的拷贝,然后这种方式不是最简单又最安全高效的吗?只是 MapStruct 更好的帮助我们实现了,避免了项目中冗余的重复代码,大道至简。

以上就是MapStruct解了对象映射的毒的详细内容,更多关于MapStruct的资料请关注编程网其它相关文章!

--结束END--

本文标题: Java MapStruct解了对象映射的毒

本文链接: https://lsjlt.com/news/124402.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • Java MapStruct解了对象映射的毒
    目录前言介绍代码编写探个究竟结尾前言 MVC模式是目前主流项目的标准开发模式,这种模式下框架的分层结构清晰,主要分为Controller,Service,Dao。分层的结构下,各层之...
    99+
    2024-04-02
  • 了解 Unix 对象和 Laravel 中的对象关系映射
    Unix对象和Laravel中的对象关系映射是两个非常重要的概念。在本篇文章中,我们将深入探讨这两个主题,以帮助您更好地了解它们的作用和用途。 Unix对象 Unix是一种操作系统,它使用对象来表示文件、目录和设备等概念。在Unix中,一切...
    99+
    2023-08-09
    laravel unix 对象
  • MapStruct对象映射转换解决Bean属性拷贝性能问题
    目录简介适用场景工作时机使用案例1、添加依赖2、定义两个类3、单元测试核心总结简介 MapStruct 是一个代码生成器(可以生成对象映射转换的代码),它基于约定优于配置的方法,极大...
    99+
    2024-04-02
  • Hibernate映射之基本类映射和对象关系映射详解
    回想一些我们在没有学习ssh的时候,我们建立数据库的表时,首先是数据库建模E-R图,然后再通过实体模型来建立关系模型,再建立相应的表。实体间存在三种关系,一对一,一对多(或者说多对一),多对多。而如今我们要根据类来映射相应的表,那只能是通过...
    99+
    2023-05-31
    hibernate 对象 映射
  • Java实体映射工具MapStruct使用方法详解
    目录1.序 2.简单用例 3.使用详解 1)关于接口注解@Mapper几种属性用法详解 2) 其他方法级别注解 总结1.序 通常在后端开发中经常不直接返回实体Entity类,经过处...
    99+
    2024-04-02
  • SpringBoot + MapStruct 属性映射工具的使用详解
    1. MapStruct 是什么? 截取下官方的原话 我给翻译了一下 说白了 当你的对象A有几十个属性 而另一个对象B 与A比较只有一些细微的差别 那么这时候只需要映射过去即可 而...
    99+
    2024-04-02
  • @RequestBody不能映射到对象的解决
    目录@RequestBody不能映射到对象解决方法@RequestBody使用方法(将数据映射到java对象上)1.请求方式如下2.对象定义如下3.可以看到,json数据映射到Use...
    99+
    2024-04-02
  • hibernate中的对象关系映射
    Hibernate的本质就是对象关系映射(ObjectRelational Mapping),ORM实现了将对象数据保存到数据库中,以前我们对关系表进行操作,执行增删改查等任务,现在我们不再对关系表进行操作,而是直接对对象操作。hibern...
    99+
    2023-05-31
    hibernate 映射 te
  • 详解Java对象转换神器MapStruct库的使用
    目录前言MapStruct简介MapStruct入门1. 引入依赖2. 需要转换的对象3. 创建转换器4. 验证5. 自动生成的实现类MapStruct进阶场景1:属性名称不同、(基...
    99+
    2024-04-02
  • PHP 对象关系映射与数据库抽象层中对象-关系映射的最佳实践
    php 对象关系映射 (orm) 最佳实践包括命名一致性、适当映射、注释、避免硬编码、利用查询生成器和监视数据库架构更改。实操案例中,doctrine orm 框架可用于连接 mysql...
    99+
    2024-05-06
    orm 数据库抽象 mysql composer
  • 【Java 基础篇】Java反射:深入了解Class对象
    Java是一门强类型语言,它要求在编译时知道所有的类和对象类型。然而,有时候我们需要在运行时动态地获取和操作类的信息,这就是Java反射的用武之地。本文将深入探讨Java反射,特别是与Class对象...
    99+
    2023-10-27
    java python 开发语言 ajax 网络 eclipse git 原力计划
  • 用新的映射对象替换映射变量线程安全吗?
    php小编苹果在这里为大家解答一个常见的问题:“用新的映射对象替换映射变量线程安全吗?”映射变量是一种常见的数据结构,用于存储键值对。在多线程环境中,线程安全是一个重要的考虑因素。尽管...
    99+
    2024-02-10
    并发访问 键值对
  • 如何解组 Pulumi auto.Result 对象结构或映射
    php小编西瓜分享如何解组 Pulumi auto.Result 对象结构或映射。Pulumi 是一个跨云平台的基础设施即代码工具,它允许开发人员使用编程语言来定义和管理云基础设施。在...
    99+
    2024-02-10
  • jQuery中如何将$引用的对象映射回原始的对象
    本文小编为大家详细介绍“jQuery中如何将$引用的对象映射回原始的对象”,内容详细,步骤清晰,细节处理妥当,希望这篇“jQuery中如何将$引用的对象映射回原始的对象”文章能帮助大家解决疑惑,下面跟着小编...
    99+
    2024-04-02
  • 详解Java反射创建对象
    一、什么是反射 Java Reflaction in Action中的解释:反射是运行中的程序检查自己和软件运行环境的能力,它可以根据它发现的进行改变。通俗的讲就是反射可以在运行时根...
    99+
    2024-04-02
  • .NET中实现对象数据映射示例详解
    目录前言示例Mapster 使用总结前言 对象数据映射即将一个对象的数据根据特定规则批量映射到另一个对象中,减少手工操作和降低人为出错率。如将 DTO ...
    99+
    2022-11-13
    .NET对象数据映射 .NET数据映射
  • 对象关系映射ORM的缺点是什么
    对象关系映射ORM的缺点是什么?很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。对象关系映射(ORM)提供了概念性的、易于理解的模...
    99+
    2024-04-02
  • 关于MyBatis中映射对象关系的举例
    目录MyBatis映射对象关系双向many2one/one2many关系中的组合关系(级联)Mybatis映射原理MyBatis映射对象关系 双向many2one/one2many关...
    99+
    2024-04-02
  • 在java中怎么对MyBatis注解进行映射
    本篇文章为大家展示了在java中怎么对MyBatis注解进行映射,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。java  中MyBatis注解映射的实例详解1.普通映射 @Sel...
    99+
    2023-05-31
    java mybatis ava
  • 提取不了从 YAML 映射中的键/值对
    编程并不是一个机械性的工作,而是需要有思考,有创新的工作,语法是固定的,但解决问题的思路则是依靠人的思维,这就需要我们坚持学习和更新自己的知识。今天编程网就整理分享《提取不了从 YAML 映射中的键...
    99+
    2024-04-04
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作