高效、优雅的对象copy之MapStruct入门到精通,实战踩坑版
一、前言
大家在开发中,最让人头疼的就是:对象之间的拷贝,前端的VO和数据库的Entity不一致!
性能最好的就是手动set
,主要是枯燥且无技术含量,不仅耗费大量时间而且很容易出错;
所以我们要成为优秀的程序员,要多借助轮子,开发效率事半功倍,开发技能也是增长不少!
如果系统性能没有要求,怎么实现都是好的,但是我们要有追求哈,追求高质量!
每个东西都有存在的价值,不要捧一踩一哈!
二、MapStruct简介
MapStruct是基于JSR 269
的Java注释处理器,用于生成类型安全的 Bean 映射类。
您所要做的就是定义一个映射器接口,该接口声明任何所需的映射方法。在编译过程中,MapStruct将生成此接口的实现
。此实现使用纯 Java 方法调用在源对象和目标对象之间进行映射,即无反射
或类似内容。
与手动编写映射代码相比,MapStruct通过生成繁琐且容易出错的代码来节省时间
。遵循配置方法的约定
,MapStruct使用合理的默认值,但在配置或实现特殊行为时会步入歧途。
三、优势
与动态映射框架相比,MapStruct具有以下优点:
通过使用普通方法调用而
不是反射
快速执行编译时类型安全
:只能映射彼此映射的对象和属性,不会意外地将订单实体映射到客户 DTO 等。在构建时清除错误报告,如果
映射不完整(并非所有目标属性都已映射)
映射不正确(找不到正确的映射方法或类型转换)
性能图大家可以看一下:
四、整合实战
0. 使用
@Mapper
将接口标记为映射接口
对于源对象和目标对象中具有不同名称的属性,可以使用注释来配置名称:@Mapping
按照约定,接口声明一个成员Mappers INSTANCE
,为客户端提供对映射器实现的访问。
下面我们来具体使用!
1. 导入依赖
这里使用最新的,如果引入了lombok可能会有问题,就是他们俩都是在编译期运行的,mapstruct如果比lombok先执行,就会找不到get、set方法,所以会有问题,官网已经有了解决方案!现在是启动不会报错!
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.5.3.Final</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</dependency>
2. 错误总结
- 不会自动生成impl实现类?
我们需要加上依赖:
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.5.3.Final</version>
</dependency>
- 重新启动就会出现和lombok的冲突问题:
java: No property named "name" exists in source parameter(s).
Type "UserVO" has no properties.
<build>
<pluginManagement>
<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>1.5.3.Final</version>
</path>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.24</version>
</path>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-mapstruct-binding</artifactId>
<version>0.2.0</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
3. 常用实战1
用户表:
@Data
public class User {
private Integer id;
private String username;
private Integer age;
}
前端用户VO:
@Data
public class UserVO {
private Integer id;
private String name;
private Integer age;
}
我们创建接口进行两个对象之间的映射:
import com.example.demo.mapstruct.entity.User;
import com.example.demo.mapstruct.entity.UserVO;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.factory.Mappers;
/**
* @author wangzhenjun
* @date 2023/1/28 16:05
*/
@Mapper
public interface UserMapper {
UserMapper INSTANCE = Mappers.getMapper(UserMapper.class);
@Mapping(source ="name",target = "username")
User userVOToUser(UserVO userVO);
}
属性多了可以嵌套:
@Mappings({
@Mapping(source ="name",target = "username"),
@Mapping(source ="name1",target = "username1")
})
也可以:
@Mapping(source ="name",target = "username")
@Mapping(source ="name1",target = "username1")
编写测试类:
@SpringBootTest
class DemoApplicationTests {
@Test
void demoMapstruct(){
UserVO userVO = new UserVO(1,"小红",18);
User user = UserMapper.INSTANCE.userVOToUser(userVO);
System.out.println(user);
}
}
我们看到拷贝没有任何问题!
我们看看是怎么实现的:
mapstruct
会在编译期自动生成实现类去帮助我们去赋值,不指定位默认策略,名称一致进行copy!
不一致可以按上面的进行指定,不指定则不会有set方法!
4. 常用实战2
下面进行多个源参数的映射方法演示:
我们把user类加上一个字段:
private BigDecimal score;
新增加一个Score
类:
@Data
@AllArgsConstructor
public class Score {
private Integer studentId;
private BigDecimal score;
}
调整上面的UserMapper
接口:
@Mappings({
@Mapping(source ="userVO.name",target = "username"),
@Mapping(source ="score.score",target = "score")
})
User userVOToUser(UserVO userVO, Score score);
测试代码:
UserVO userVO = new UserVO(1,"小红",18);
Score score = new Score(1,new BigDecimal(100));
User user = UserMapper.INSTANCE.userVOToUser(userVO,score);
System.out.println(user);
结果显示正常:
5. 常用实战3
我们在来看一个企业级能够用得上的,就是自定义方法,然后进行赋值:
场景:一个商品有长宽高,我们把长宽高从cm变为m!
还有很多String转Integer、Float等等,都是按照下面这种自定义方法去实现!
VO和对象都是一样的哈!
@Data
@AllArgsConstructor
public class ProductVO {
private Integer id;
private String name;
private BigDecimal length;
private BigDecimal width;
private BigDecimal high;
}
看清楚,别导错包了!
qualifiedByName
:指定自定义方法的名称
@Named("cmToM")
:起别名,不使用找不到方法
可以写一起,也可以整一个工具类里写方法,在这里进行引用!
如果是使用spring,我们可以把接口作为bean进行注入调用(推荐)
加上参数即可开启:
@Mapper(componentModel = MappingConstants.ComponentModel.SPRING)
/**
* @author wangzhenjun
* @date 2023/1/28 17:13
*/
@Mapper(componentModel = MappingConstants.ComponentModel.SPRING)
public interface ProductMapper {
@Mapping(source = "length",target = "length",qualifiedByName = "cmToM")
@Mapping(source = "width",target = "width",qualifiedByName = "cmToM")
@Mapping(source = "high",target = "high",qualifiedByName = "cmToM")
Product productVOToPrduct(ProductVO productVO);
@Named("cmToM")
default BigDecimal cmToM (BigDecimal oldValue){
if (oldValue == null) {
return BigDecimal.ZERO;
}
return oldValue.divide(new BigDecimal("100"));
}
}
测试:
@SpringBootTest
class DemoApplicationTests {
@Autowired
private ProductMapper productMapper;
@Test
void demoMapstruct(){
ProductVO productVO = new ProductVO(1,"美丽家园地板",new BigDecimal(100),new BigDecimal(50),new BigDecimal(8));
Product product = productMapper.productVOToProduct(productVO);
System.out.println(product);
}
}
完美转化!
6. 常用实战4
在实战一个LocalDateTime、String相互转化的
,后面大家可以去官网文档去找你需要的:
在刚刚的商品类加个字段:
private String createdAt;
VO里也加上一个:
private LocalDateTime createdAt;
编写个转化类:
这里交给spring管理了,因为ProductMapper也交给spring管理,不加的话会找不到此类!
@Component
public class LocalDateTimeMapper {
public String asString(LocalDateTime date) {
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
return date != null ? date.format(formatter): null;
}
public LocalDateTime asLocalDateTime(String date) {
DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
return date != null ? LocalDateTime.parse(date,formatter) : null;
}
}
ProductMapper修改一下:
uses = LocalDateTimeMapper.class
使用咱们上面写的类即可!
@Mapper(componentModel = MappingConstants.ComponentModel.SPRING,uses = LocalDateTimeMapper.class)
public interface ProductMapper {
@Mapping(source = "length",target = "length",qualifiedByName = "cmToM")
@Mapping(source = "width",target = "width",qualifiedByName = "cmToM")
@Mapping(source = "high",target = "high",qualifiedByName = "cmToM")
Product productVOToProduct(ProductVO productVO);
@Named("cmToM")
default BigDecimal cmToM (BigDecimal oldValue){
if (oldValue == null) {
return BigDecimal.ZERO;
}
return oldValue.divide(new BigDecimal("100"));
}
}
测试一下:
ProductVO productVO = new ProductVO(1,"美丽家园地板",
new BigDecimal(100),new BigDecimal(50),
new BigDecimal(8), LocalDateTime.now());
Product product = productMapper.productVOToProduct(productVO);
System.out.println(product);
完美转化:
六、总结
通过简介到实战,这时咱们就是优雅的程序员了!
更多的例子可以去官网进行查看:
写作不易,大家给点支持,你的支持是我写作的动力哈!
对你有帮助,还请不要吝啬你的发财小手点点关注哈!
关注小编的微信公众号,一起交流学习!文章首发看哦!
高效、优雅的对象copy之MapStruct入门到精通,实战踩坑版的更多相关文章
- CSS+DIV网页样式布局实战从入门到精通 中文pdf扫描版
CSS+DIV网页样式布局实战从入门到精通通过精选案例引导读者深入学习,系统地介绍了利用CSS和DIV进行网页样式布局的相关知识和操作方法. 全书共21章.第1-5章主要介绍网页样式布局的基础知识,包 ...
- CentOS7入门到精通实战课程课后习题
Linux自动化运维系列①: CentOS7入门到精通实战--->传送门 http://edu.51cto.com/course/13055.html 01.系统入门课后习题 1.口述一个命令执 ...
- 《C#从入门到精通(第3版)》目录
C#从入门到精通(第3版)pdf+源码 一.基础知识 1.初识C#及其开发环境 2.开始C#之旅 3.变量与常量 4.表达式与运算符 5.字符与字符串 6.流程控制语句 7.数组与集合 8.属性和方法 ...
- Python从入门到精通(第2版)——pyuic5: error: no such option: -m的问题解决
前言 在学习<Python从入门到精通(第2版)>的第15章 GUI界面编程--15.2.4 将.ui文件转换为.py文件时,按照书中步骤出错时的问题解决,希望对同样学习本书的同学有所帮助 ...
- 优雅的对象转换解决方案-MapStruct及其入门(一)
第一次看到 MapStruct 的时候, 我个人非常的开心. 因为其跟我内心里面的想法不谋而合. 1 MapStruct 是什么? 1.1 JavaBean 的困扰 对于代码中 JavaBean之间的 ...
- Scala2.12 从入门到精通实战高端视频课程(含网盘下载地址)
Scala快速入门到精通 下载地址链接:https://pan.baidu.com/s/1bTSZSlWftFYaLQL6lVH62A 提取码:ohfk 下载后使用视频中自带的专用播放器打开视频就能看 ...
- 优雅的对象转换解决方案-MapStruct使用进阶(二)
在前面, 介绍了 MapStruct 及其入门. 本文则是进一步的进阶. 在 MapStruct 生成对应的实现类的时候, 有如下的几个情景. 1 属性名称相同,则进行转化 在实现类的时候, 如果属性 ...
- Echarts轻松入门,内附踩坑秘籍
首先介绍一下我们的主角ECharts ECharts,一个纯 Javascript 的图表库,可以流畅的运行在 PC 和移动设备上,兼容当前绝大部分浏览器(IE8/9/10/11,Chrome,Fir ...
- MySQL5.7从入门到精通 (视频教学版) 刘增杰 编著
第1章 初识MySQL MySQL是一个开放源代码的数据库管理系统(DBMS),它是由MySQL AB公司开发.发布和支持的.MySQL是一个跨平台(Windows.Linux.UNIX.MacOS) ...
- 《PHP从入门到精通(第3版)》目录
一.基础知识 1.初识PHP 2.PHP环境搭建和开发工具 3.PHP语言基础 4.流程控制语句 5.字符串操作 6.正则表达式 7.PHP数组 8.PHP与Web页面交互 9.PHP与JavaScr ...
随机推荐
- 开发用户K8S授权
#开发用户没有K8S权限 [ans@master ~]$ kubectl get po Unable to connect to the server: x509: certificate signe ...
- beego-orm-sqlite
dao.go ``` package daoimport ( "fmt" "github.com/astaxie/beego/orm" "html&q ...
- kubeedge的云边协同通道
1. CloudHub安全认证流程 2. EdgeHub安全认证流程 3. Edged节点纳管
- 一步一图带你深入理解 Linux 物理内存管理
1. 前文回顾 在上篇文章 <深入理解 Linux 虚拟内存管理> 中,笔者分别从进程用户态和内核态的角度详细深入地为大家介绍了 Linux 内核如何对进程虚拟内存空间进行布局以及管理的相 ...
- orcl rollup 分组小计、合计
表数据: select * from group_test; 分组小计.合计: select group_id, decode(concat(job, group_id), null, '合计', g ...
- 1.1 大数据简介-hadoop-最全最完整的保姆级的java大数据学习资料
目录 1 hadoop-最全最完整的保姆级的java大数据学习资料 1.1 大数据简介 1.1.1 大数据的定义 1.1.2 大数据的特点 1.1.3 大数据的应用场景 1.1.4 大数据的发展趋势及 ...
- 【Java SE进阶】Day08 File类、递归
一.File类 1.概述java.io.File 文件和路径的抽象表示 用于文件和目录的创建.查找和删除等 分类 file--文件 directory--文件夹/目录 path--路径 2.静态成员变 ...
- 【数据库】union和union all合并结果操作
一.含义 UNION 操作符用于合并两个或多个 SELECT 语句的结果集. UNION 内部的 SELECT 语句必须拥有相同数量的列.列也必须拥有相似的数据类型.同时,每条 SELECT 语句中的 ...
- java调用python脚本 并传参(根据配置文件获取python文件地址)
方式一: Java代码 package com.mybatis.plus.utils; import cn.hutool.core.lang.Console; import java.io.Buffe ...
- Git学习脑图
背景: 最近在学习Git工作流,学习的是廖雪峰大神的教程,里面也很详尽了,于是自己就用脑图简单归纳自己选择学习的部分,方便日后查阅. 脑图: