干掉 BeanUtils!试试这款 Bean 自动映射工具

2024-04-16 19:48

本文主要是介绍干掉 BeanUtils!试试这款 Bean 自动映射工具,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

开发背景

你有没有遇到过这样的开发场景?

服务通过接口对外提供数据,或者服务之间进行数据交互,首先查询数据库并映射成数据对象(XxxDO)。

正常情况下,接口是不允许直接以数据库数据对象 XxxDO 形式对外提供数据的,而是要再封装成数据传输对象(XxxDTO)提供出去。

为什么不能直接提供 DO?

1)根据单一设计原则,DO 只能对应数据实体对象,不能承担其他职责;

2)DO 可能包含表所有字段数据,不符合接口的参数定义,数据如果过大会影响传输速度,也不符合数据安全原则;

3)根据《阿里 Java 开发手册》分层领域模型规约,不能一个对象走天下,需要定义成 POJO/DO/BO/DTO/VO/Query 等数据对象,完整的定义可以参考阿里开发手册,关注公众号:Java技术栈,在后台回复:手册,可以获取最新高清完整版。

传统 DO -> DTO 做法

XxxDTO 可能包含 XxxDO 大部分数据,或者组合其他 DO 的部分数据,传统的做法有以下几种:

  • get/ set

  • 构造器

  • BeanUtils 工具类

  • Builder 模式

我相信大部分人的做法都是这样的,虽然很直接,但是普遍真的很 Low,耦合性又强,还经常丢参数,或者搞错参数值,在这个开发场景,我个人觉得这些都不是最佳的方式。

这种开发场景又实在是太常见了,那有没有一种 Java bean 自动映射工具?

没错——正是 MapStruct!!

MapStruct 简介

官网地址:

https://mapstruct.org/

开源地址:

https://github.com/mapstruct/mapstruct

图片

Java bean mappings, the easy way!

以简单的方式进行 Java bean 映射。

MapStruct 是一个代码生成器,它和 Spring Boot、Maven 一样也是基于约定优于配置的理念,极大地简化了 Java bean 之间数据映射的实现。

MapStruct 的优势:

1、MapStruct 使用简单的方法调用生成映射代码,因此***速度非常快***;

2、类型安全,避免出错,只能映射相互映射的对象和属性,因此不会错误将用户实体错误地映射到订单 DTO;

3、只需要 JDK 1.8+,不用其他任何依赖,自包含所有代码

4、易于调试

5、易于理解

支持的方式:

MapStruct 支持命令行编译,如:纯 javac 命令、Maven、Gradle、Ant 等等,也支持 Eclipse、IntelliJ IDEA 等 IDEs。

MapStruct 实战

本文栈长基于 IntelliJ IDEA、Spring Boot、Maven 进行演示。

基本准备

新增两个数据库 DO 类:

一个用户主类,一个用户扩展类。

/*** 微信公众号:Java技术栈* @author 栈长*/
@Data
public class UserDO {private String name;private int sex;private int age;private Date birthday;private String phone;private boolean married;private Date regDate;private Date loginDate;private String memo;private UserExtDO userExtDO;}
/*** 微信公众号:Java技术栈* @author 栈长*/
@Data
public class UserExtDO {private String regSource;private String favorite;private String school;private int kids;private String memo;}

新增一个数据传输 DTO 类:

用户展示类,包含用户主类、用户扩展类的部分数据。

/*** 微信公众号:Java技术栈* @author 栈长*/
@Data
public class UserShowDTO {private String name;private int sex;private boolean married;private String birthday;private String regDate;private String registerSource;private String favorite;private String memo;}

开始实战

重点来了,不要 get/set,不要 BeanUtils,怎么把两个用户对象的数据封装到 DTO 对象?

Spring Boot 基础这篇就不介绍了,系列基础教程和示例源码可以看这里:https://github.com/javastacks/spring-boot-best-practice

引入 MapStruct 依赖:

<dependencies><dependency><groupId>org.mapstruct</groupId><artifactId>mapstruct</artifactId><version>${org.mapstruct.version}</version></dependency>
</dependencies>

Maven 插件相关配置:

MapStruct 和 Lombok 结合使用会有版本冲突问题,注意以下配置。

<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><path><groupId>org.mapstruct</groupId><artifactId>mapstruct-processor</artifactId><version>${org.mapstruct.version}</version></path><!-- 使用 Lombok 需要添加 --><path><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>${org.projectlombok.version}</version></path><!-- Lombok 1.18.16 及以上需要添加,不然报错 --><path><groupId>org.projectlombok</groupId><artifactId>lombok-mapstruct-binding</artifactId><version>${lombok-mapstruct-binding.version}</version></path></annotationProcessorPaths></configuration></plugin></plugins>
</build>

添加 MapStruct 映射:

/*** 微信公众号:Java技术栈* @author 栈长*/
@Mapper
public interface UserStruct {UserStruct INSTANCE = Mappers.getMapper(UserStruct.class);@Mappings({@Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")@Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")@Mapping(source = "userExtDO.regSource", target = "registerSource")@Mapping(source = "userExtDO.favorite", target = "favorite")@Mapping(target = "memo", ignore = true)})UserShowDTO toUserShowDTO(UserDO userDO);List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs);}

重点说明:

1)添加一个 interface 接口,使用 MapStruct 的 @Mapper 注解修饰,这里取名 XxxStruct,是为了不和 MyBatis 的 Mapper 混淆;

2)使用 Mappers 添加一个 INSTANCE 实例,也可以使用 Spring 注入,后面会讲到;

3)添加两个映射方法,返回单个对象、对象列表;

4)使用 @Mappings + @Mapping 组合映射,如果两个字段名相同可以不用写,可以指定映射的日期格式、数字格式、表达式等,ignore 表示忽略该字段映射;

5)List 方法的映射会调用单个方法映射,不用单独映射,后面看源码就知道了;

另外,Java 8+ 以上版本不需要 @Mappings 注解,直接使用 @Mapping 注解就行了:

图片

Java 8 修改之后:

/*** 微信公众号:Java技术栈* @author 栈长*/
@Mapper
public interface UserStruct {UserStruct INSTANCE = Mappers.getMapper(UserStruct.class);@Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")@Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")@Mapping(source = "userExtDO.regSource", target = "registerSource")@Mapping(source = "userExtDO.favorite", target = "favorite")@Mapping(target = "memo", ignore = true)UserShowDTO toUserShowDTO(UserDO userDO);List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs);}

测试一下:

/*** 微信公众号:Java技术栈* @author 栈长*/
public class UserStructTest {@Testpublic void test1() {UserExtDO userExtDO = new UserExtDO();userExtDO.setRegSource("公众号:Java技术栈");userExtDO.setFavorite("写代码");userExtDO.setSchool("社会大学");UserDO userDO = new UserDO();userDO.setName("栈长");userDO.setSex(1);userDO.setAge(18);userDO.setBirthday(new Date());userDO.setPhone("18888888888");userDO.setMarried(true);userDO.setRegDate(new Date());userDO.setMemo("666");userDO.setUserExtDO(userExtDO);UserShowDTO userShowDTO = UserStruct.INSTANCE.toUserShowDTO(userDO);System.out.println("=====单个对象映射=====");System.out.println(userShowDTO);List<UserDO> userDOs = new ArrayList<>();UserDO userDO2 = new UserDO();BeanUtils.copyProperties(userDO, userDO2);userDO2.setName("栈长2");userDOs.add(userDO);userDOs.add(userDO2);List<UserShowDTO> userShowDTOs = UserStruct.INSTANCE.toUserShowDTOs(userDOs);System.out.println("=====对象列表映射=====");userShowDTOs.forEach(System.out::println);}
}

输出结果:

图片

来看结果,数据转换结果成功。

什么原理?

如上我们知道,通过一个注解修饰接口就可以搞定了,是什么原理呢?

来看编译后的目录:

图片

原理就是在编译期间生成了一个该接口的实现类。

打开看下其源码:

public class UserStructImpl implements UserStruct {public UserStructImpl() {}public UserShowDTO toUserShowDTO(UserDO userDO) {if (userDO == null) {return null;} else {UserShowDTO userShowDTO = new UserShowDTO();if (userDO.getBirthday() != null) {userShowDTO.setBirthday((new SimpleDateFormat("yyyy-MM-dd")).format(userDO.getBirthday()));}userShowDTO.setRegisterSource(this.userDOUserExtDORegSource(userDO));userShowDTO.setFavorite(this.userDOUserExtDOFavorite(userDO));userShowDTO.setName(userDO.getName());userShowDTO.setSex(userDO.getSex());userShowDTO.setMarried(userDO.isMarried());userShowDTO.setRegDate(DateFormatUtils.format(userDO.getRegDate(), "yyyy-MM-dd HH:mm:ss"));return userShowDTO;}}public List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOs) {if (userDOs == null) {return null;} else {List<UserShowDTO> list = new ArrayList(userDOs.size());Iterator var3 = userDOs.iterator();while(var3.hasNext()) {UserDO userDO = (UserDO)var3.next();list.add(this.toUserShowDTO(userDO));}return list;}}private String userDOUserExtDORegSource(UserDO userDO) {if (userDO == null) {return null;} else {UserExtDO userExtDO = userDO.getUserExtDO();if (userExtDO == null) {return null;} else {String regSource = userExtDO.getRegSource();return regSource == null ? null : regSource;}}}private String userDOUserExtDOFavorite(UserDO userDO) {if (userDO == null) {return null;} else {UserExtDO userExtDO = userDO.getUserExtDO();if (userExtDO == null) {return null;} else {String favorite = userExtDO.getFavorite();return favorite == null ? null : favorite;}}}
}

其实实现类就是调用了对象的 get/set 等其他常规操作,而 List 就是循环调用的该对象的单个映射方法,这下就清楚了吧!

Spring 注入法

上面的示例创建了一个 UserStruct 实例:

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

如 @Mapper 注解源码所示:

图片

参数 componentModel 默认值是 default,也就是手动创建实例,也可以通过 Spring 注入。

Spring 修改版如下:

干掉了 INSTANCE,@Mapper 注解加入了 componentModel = "spring" 值。

/*** 微信公众号:Java技术栈* @author 栈长*/
@Mapper(componentModel = "spring")
public interface UserSpringStruct {@Mapping(source = "birthday", target = "birthday", dateFormat = "yyyy-MM-dd")@Mapping(target = "regDate", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(userDO.getRegDate(),\"yyyy-MM-dd HH:mm:ss\"))")@Mapping(source = "userExtDO.regSource", target = "registerSource")@Mapping(source = "userExtDO.favorite", target = "favorite")@Mapping(target = "memo", ignore = true)UserShowDTO toUserShowDTO(UserDO userDO);List<UserShowDTO> toUserShowDTOs(List<UserDO> userDOS);}

测试一下:

本文用到了 Spring Boot,所以这里就要用到 Spring Boot 的单元测试方法。Spring Boot 单元测试不懂的可以关注公众号:Java技术栈,在后台回复:boot,系列教程都整理好了。

/*** 微信公众号:Java技术栈* @author 栈长*/
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserSpringStructTest {@Autowiredprivate UserSpringStruct userSpringStruct;@Testpublic void test1() {UserExtDO userExtDO = new UserExtDO();userExtDO.setRegSource("公众号:Java技术栈");userExtDO.setFavorite("写代码");userExtDO.setSchool("社会大学");UserDO userDO = new UserDO();userDO.setName("栈长Spring");userDO.setSex(1);userDO.setAge(18);userDO.setBirthday(new Date());userDO.setPhone("18888888888");userDO.setMarried(true);userDO.setRegDate(new Date());userDO.setMemo("666");userDO.setUserExtDO(userExtDO);UserShowDTO userShowDTO = userSpringStruct.toUserShowDTO(userDO);System.out.println("=====单个对象映射=====");System.out.println(userShowDTO);List<UserDO> userDOs = new ArrayList<>();UserDO userDO2 = new UserDO();BeanUtils.copyProperties(userDO, userDO2);userDO2.setName("栈长Spring2");userDOs.add(userDO);userDOs.add(userDO2);List<UserShowDTO> userShowDTOs = userSpringStruct.toUserShowDTOs(userDOs);System.out.println("=====对象列表映射=====");userShowDTOs.forEach(System.out::println);}
}

如上所示,直接使用  @Autowired 注入就行,使用更方便。

输出结果:

图片

没毛病,稳如狗。

这篇关于干掉 BeanUtils!试试这款 Bean 自动映射工具的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/909740

相关文章

Java枚举类实现Key-Value映射的多种实现方式

《Java枚举类实现Key-Value映射的多种实现方式》在Java开发中,枚举(Enum)是一种特殊的类,本文将详细介绍Java枚举类实现key-value映射的多种方式,有需要的小伙伴可以根据需要... 目录前言一、基础实现方式1.1 为枚举添加属性和构造方法二、http://www.cppcns.co

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优

SpringBoot中封装Cors自动配置方式

《SpringBoot中封装Cors自动配置方式》:本文主要介绍SpringBoot中封装Cors自动配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录SpringBoot封装Cors自动配置背景实现步骤1. 创建 GlobalCorsProperties

idea中创建新类时自动添加注释的实现

《idea中创建新类时自动添加注释的实现》在每次使用idea创建一个新类时,过了一段时间发现看不懂这个类是用来干嘛的,为了解决这个问题,我们可以设置在创建一个新类时自动添加注释,帮助我们理解这个类的用... 目录前言:详细操作:步骤一:点击上方的 文件(File),点击&nbmyHIgsp;设置(Setti

使用Java实现通用树形结构构建工具类

《使用Java实现通用树形结构构建工具类》这篇文章主要为大家详细介绍了如何使用Java实现通用树形结构构建工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录完整代码一、设计思想与核心功能二、核心实现原理1. 数据结构准备阶段2. 循环依赖检测算法3. 树形结构构建4. 搜索子

利用Python开发Markdown表格结构转换为Excel工具

《利用Python开发Markdown表格结构转换为Excel工具》在数据管理和文档编写过程中,我们经常使用Markdown来记录表格数据,但它没有Excel使用方便,所以本文将使用Python编写一... 目录1.完整代码2. 项目概述3. 代码解析3.1 依赖库3.2 GUI 设计3.3 解析 Mark

利用Go语言开发文件操作工具轻松处理所有文件

《利用Go语言开发文件操作工具轻松处理所有文件》在后端开发中,文件操作是一个非常常见但又容易出错的场景,本文小编要向大家介绍一个强大的Go语言文件操作工具库,它能帮你轻松处理各种文件操作场景... 目录为什么需要这个工具?核心功能详解1. 文件/目录存javascript在性检查2. 批量创建目录3. 文件

jvm调优常用命令行工具详解

《jvm调优常用命令行工具详解》:本文主要介绍jvm调优常用命令行工具的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一 jinfo命令查看参数1.1 查看jvm参数二 jstack命令2.1 查看现场堆栈信息三 jstat 实时查看堆内存,gc情况3.1

MySQL使用binlog2sql工具实现在线恢复数据功能

《MySQL使用binlog2sql工具实现在线恢复数据功能》binlog2sql是大众点评开源的一款用于解析MySQLbinlog的工具,根据不同选项,可以得到原始SQL、回滚SQL等,下面我们就来... 目录背景目标步骤准备工作恢复数据结果验证结论背景生产数据库执行 SQL 脚本,一般会经过正规的审批

Spring 中使用反射创建 Bean 实例的几种方式

《Spring中使用反射创建Bean实例的几种方式》文章介绍了在Spring框架中如何使用反射来创建Bean实例,包括使用Class.newInstance()、Constructor.newI... 目录1. 使用 Class.newInstance() (仅限无参构造函数):2. 使用 Construc