实体映射最强工具类:MapStruct 真香!
来源:blog.csdn.net/qq122516902
首先来了解一下DTO,DTO简单的理解就是做数据传输对象的,类似于VO,但是VO用于传输到前端。(~~)
1.MapStruct是用来做什么的?
现在有这么个场景,从数据库查询出来了一个user对象(包含id,用户名,密码,手机号,邮箱,角色这些字段)和一个对应的角色对象role(包含id,角色名,角色描述这些字段),现在在controller需要用到user对象的id,用户名,和角色对象的角色名三个属性。
一种方式是直接把两个对象传递到controller层,但是这样会多出很多没用的属性。更通用的方式是需要用到的属性封装成一个类(DTO),通过传输这个类的实例来完成数据传输。
User.java
@AllArgsConstructor
@Data
public class User { private Long id; private String username; private String password; private String phoneNum; private String email; private Role role;
}
Role.java
@AllArgsConstructor
@Data
public class Role { private Long id; private String roleName; private String description;
}
UserRoleDto.java,这个类就是封装的类
@Data
public class UserRoleDto { /** * 用户id */ private Long userId; /** * 用户名 */ private String name; /** * 角色名 */ private String roleName;
}
测试类,模拟将user对象转换成UserRoleDto对象
public class MainTest { User user = null; /** * 模拟从数据库中查出user对象 */ @Before public void before() { Role role = new Role(2L, "administrator", "超级管理员"); user = new User(1L, "zhangsan", "12345", "17677778888", "123@qq.com", role); } /** * 模拟把user对象转换成UserRoleDto对象 */ @Test public void test1() { UserRoleDto userRoleDto = new UserRoleDto(); userRoleDto.setUserId(user.getId()); userRoleDto.setName(user.getUsername()); userRoleDto.setRoleName(user.getRole().getRoleName()); System.out.println(userRoleDto); }
}
从上面代码可以看出,通过getter、setter的方式把一个对象属性值复制到另一个对象中去还是很麻烦的,尤其是当属性过多的时候。而MapStruct就是用于解决这种问题的。
2.使用MapStruct解决上述问题
这里我们沿用User.java、Role.java、UserRoleDto.java。
新建一个UserRoleMapper.java,这个来用来定义User.java、Role.java和UserRoleDto.java之间属性对应规则:
UserRoleMapper.java
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers; /** * @Mapper 定义这是一个MapStruct对象属性转换接口,在这个类里面规定转换规则 * 在项目构建时,会自动生成改接口的实现类,这个实现类将实现对象属性值复制 */
@Mapper
public interface UserRoleMapper { /** * 获取该类自动生成的实现类的实例 * 接口中的属性都是 public static final 的 方法都是public abstract的 */ UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class); /** * 这个方法就是用于实现对象属性复制的方法 * * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性 * * @param user 这个参数就是源对象,也就是需要被复制的对象 * @return 返回的是目标对象,就是最终的结果对象 */ @Mappings({ @Mapping(source = "id", target = "userId"), @Mapping(source = "username", target = "name"), @Mapping(source = "role.roleName", target = "roleName") }) UserRoleDto toUserRoleDto(User user); }
在测试类中测试:
通过上面的例子可以看出,使用MapStruct方便许多。
3.添加默认方法
添加默认方法是为了这个类(接口)不只是为了做数据转换用的,也可以做一些其他的事。
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers; /** * @Mapper 定义这是一个MapStruct对象属性转换接口,在这个类里面规定转换规则 * 在项目构建时,会自动生成改接口的实现类,这个实现类将实现对象属性值复制 */
@Mapper
public interface UserRoleMapper { /** * 获取该类自动生成的实现类的实例 * 接口中的属性都是 public static final 的 方法都是public abstract的 */ UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class); /** * 这个方法就是用于实现对象属性复制的方法 * * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性 * * @param user 这个参数就是源对象,也就是需要被复制的对象 * @return 返回的是目标对象,就是最终的结果对象 */ @Mappings({ @Mapping(source = "id", target = "userId"), @Mapping(source = "username", target = "name"), @Mapping(source = "role.roleName", target = "roleName") }) UserRoleDto toUserRoleDto(User user); /** * 提供默认方法,方法自己定义,这个方法是我随便写的,不是要按照这个格式来的 * @return */ default UserRoleDto defaultConvert() { UserRoleDto userRoleDto = new UserRoleDto(); userRoleDto.setUserId(0L); userRoleDto.setName("None"); userRoleDto.setRoleName("None"); return userRoleDto; } }
测试代码:
@Test
public void test3() { UserRoleMapper userRoleMapperInstances = UserRoleMapper.INSTANCES; UserRoleDto userRoleDto = userRoleMapperInstances.defaultConvert(); System.out.println(userRoleDto);
}
4. 可以使用abstract class来代替接口
mapper可以用接口来实现,也可以完全由抽象来完全代替
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers; /** * @Mapper 定义这是一个MapStruct对象属性转换接口,在这个类里面规定转换规则 * 在项目构建时,会自动生成改接口的实现类,这个实现类将实现对象属性值复制 */
@Mapper
public abstract class UserRoleMapper { /** * 获取该类自动生成的实现类的实例 * 接口中的属性都是 public static final 的 方法都是public abstract的 */ public static final UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class); /** * 这个方法就是用于实现对象属性复制的方法 * * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性 * * @param user 这个参数就是源对象,也就是需要被复制的对象 * @return 返回的是目标对象,就是最终的结果对象 */ @Mappings({ @Mapping(source = "id", target = "userId"), @Mapping(source = "username", target = "name"), @Mapping(source = "role.roleName", target = "roleName") }) public abstract UserRoleDto toUserRoleDto(User user); /** * 提供默认方法,方法自己定义,这个方法是我随便写的,不是要按照这个格式来的 * @return */ UserRoleDto defaultConvert() { UserRoleDto userRoleDto = new UserRoleDto(); userRoleDto.setUserId(0L); userRoleDto.setName("None"); userRoleDto.setRoleName("None"); return userRoleDto; } }
5.可以使用多个参数
可以绑定多个对象的属性值到目标对象中:
package com.mapstruct.demo; import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers; /** * @Mapper 定义这是一个MapStruct对象属性转换接口,在这个类里面规定转换规则 * 在项目构建时,会自动生成改接口的实现类,这个实现类将实现对象属性值复制 */
@Mapper
public interface UserRoleMapper { /** * 获取该类自动生成的实现类的实例 * 接口中的属性都是 public static final 的 方法都是public abstract的 */ UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class); /** * 这个方法就是用于实现对象属性复制的方法 * * @Mapping 用来定义属性复制规则 source 指定源对象属性 target指定目标对象属性 * * @param user 这个参数就是源对象,也就是需要被复制的对象 * @return 返回的是目标对象,就是最终的结果对象 */ @Mappings({ @Mapping(source = "id", target = "userId"), @Mapping(source = "username", target = "name"), @Mapping(source = "role.roleName", target = "roleName") }) UserRoleDto toUserRoleDto(User user); /** * 多个参数中的值绑定 * @param user 源1 * @param role 源2 * @return 从源1、2中提取出的结果 */ @Mappings({ @Mapping(source = "user.id", target = "userId"), // 把user中的id绑定到目标对象的userId属性中 @Mapping(source = "user.username", target = "name"), // 把user中的username绑定到目标对象的name属性中 @Mapping(source = "role.roleName", target = "roleName") // 把role对象的roleName属性值绑定到目标对象的roleName中 }) UserRoleDto toUserRoleDto(User user, Role role);
对比两个方法~
5.直接使用参数作为属性值
package com.mapstruct.demo; import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers; /** * @Mapper 定义这是一个MapStruct对象属性转换接口,在这个类里面规定转换规则 * 在项目构建时,会自动生成改接口的实现类,这个实现类将实现对象属性值复制 */
@Mapper
public interface UserRoleMapper { /** * 获取该类自动生成的实现类的实例 * 接口中的属性都是 public static final 的 方法都是public abstract的 */ UserRoleMapper INSTANCES = Mappers.getMapper(UserRoleMapper.class); /** * 直接使用参数作为值 * @param user * @param myRoleName * @return */ @Mappings({ @Mapping(source = "user.id", target = "userId"), // 把user中的id绑定到目标对象的userId属性中 @Mapping(source = "user.username", target = "name"), // 把user中的username绑定到目标对象的name属性中 @Mapping(source = "myRoleName", target = "roleName") // 把role对象的roleName属性值绑定到目标对象的roleName中 }) UserRoleDto useParameter(User user, String myRoleName); }
测试类:
public class Test1 { Role role = null; User user = null; @Before public void before() { role = new Role(2L, "administrator", "超级管理员"); user = new User(1L, "zhangsan", "12345", "17677778888", "123@qq.com", role); } @Test public void test1() { UserRoleMapper instances = UserRoleMapper.INSTANCES; UserRoleDto userRoleDto = instances.useParameter(user, "myUserRole"); System.out.println(userRoleDto); }
}
6.更新对象属性
在之前的例子中UserRoleDto useParameter(User user, String myRoleName);
都是通过类似上面的方法来生成一个对象。而MapStruct提供了另外一种方式来更新一个对象中的属性。@MappingTarget
public interface UserRoleMapper1 { UserRoleMapper1 INSTANCES = Mappers.getMapper(UserRoleMapper1.class); @Mappings({ @Mapping(source = "userId", target = "id"), @Mapping(source = "name", target = "username"), @Mapping(source = "roleName", target = "role.roleName") }) void updateDto(UserRoleDto userRoleDto, @MappingTarget User user); @Mappings({ @Mapping(source = "id", target = "userId"), @Mapping(source = "username", target = "name"), @Mapping(source = "role.roleName", target = "roleName") }) void update(User user, @MappingTarget UserRoleDto userRoleDto); }
通过@MappingTarget来指定目标类是谁(谁的属性需要被更新)。@Mapping还是用来定义属性对应规则。
以此为例说明:
@Mappings({ @Mapping(source = "id", target = "userId"), @Mapping(source = "username", target = "name"), @Mapping(source = "role.roleName", target = "roleName") }) void update(User user, @MappingTarget UserRoleDto userRoleDto);
@MappingTarget
标注的类UserRoleDto 为目标类,user类为源类,调用此方法,会把源类中的属性更新到目标类中。更新规则还是由@Mapping
指定。
7.没有getter/setter也能赋值
对于没有getter/setter的属性也能实现赋值操作
public class Customer { private Long id; private String name; //getters and setter omitted for brevity
} public class CustomerDto { public Long id; public String customerName;
} @Mapper
public interface CustomerMapper { CustomerMapper INSTANCE = Mappers.getMapper( CustomerMapper.class ); @Mapping(source = "customerName", target = "name") Customer toCustomer(CustomerDto customerDto); @InheritInverseConfiguration CustomerDto fromCustomer(Customer customer);
}
@Mapping(source = “customerName”, target = “name”)
不是用来指定属性映射的,如果两个对象的属性名相同是可以省略@Mapping的。
MapStruct生成的实现类:
@Generated( value = "org.mapstruct.ap.MappingProcessor", date = "2019-02-14T15:41:21+0800", comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
public class CustomerMapperImpl implements CustomerMapper { @Override public Customer toCustomer(CustomerDto customerDto) { if ( customerDto == null ) { return null; } Customer customer = new Customer(); customer.setName( customerDto.customerName ); customer.setId( customerDto.id ); return customer; } @Override public CustomerDto toCustomerDto(Customer customer) { if ( customer == null ) { return null; } CustomerDto customerDto = new CustomerDto(); customerDto.customerName = customer.getName(); customerDto.id = customer.getId(); return customerDto; }
}
@InheritInverseConfiguration
在这里的作用就是实现customerDto.customerName = customer.getName();
功能的。如果没有这个注解,toCustomerDto这个方法则不会有customerName 和name两个属性的对应关系的。
8.使用Spring依赖注入
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Customer { private Long id; private String name;
} @Data
public class CustomerDto { private Long id; private String customerName;
} // 这里主要是这个componentModel 属性,它的值就是当前要使用的依赖注入的环境
@Mapper(componentModel = "spring")
public interface CustomerMapper { @Mapping(source = "name", target = "customerName") CustomerDto toCustomerDto(Customer customer);
}
@Mapper(componentModel = “spring”)
,表示把当前Mapper类纳入spring容器。可以在其它类中直接注入了:
@SpringBootApplication
@RestController
public class DemoMapstructApplication { // 注入Mapper @Autowired private CustomerMapper mapper; public static void main(String[] args) { SpringApplication.run(DemoMapstructApplication.class, args); } @GetMapping("/test") public String test() { Customer customer = new Customer(1L, "zhangsan"); CustomerDto customerDto = mapper.toCustomerDto(customer); return customerDto.toString(); } }
看一下由mapstruct自动生成的类文件,会发现标记了@Component
注解。
@Generated( value = "org.mapstruct.ap.MappingProcessor", date = "2019-02-14T15:54:17+0800", comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
@Component
public class CustomerMapperImpl implements CustomerMapper { @Override public CustomerDto toCustomerDto(Customer customer) { if ( customer == null ) { return null; } CustomerDto customerDto = new CustomerDto(); customerDto.setCustomerName( customer.getName() ); customerDto.setId( customer.getId() ); return customerDto; }
}
9.自定义类型转换
有时候,在对象转换的时候可能会出现这样一个问题,就是源对象中的类型是Boolean类型,而目标对象类型是String类型,这种情况可以通过@Mapper
的uses属性来实现:
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Customer { private Long id; private String name; private Boolean isDisable;
} @Data
public class CustomerDto { private Long id; private String customerName; private String disable;
}
定义转换规则的类:
public class BooleanStrFormat { public String toStr(Boolean isDisable) { if (isDisable) { return "Y"; } else { return "N"; } } public Boolean toBoolean(String str) { if (str.equals("Y")) { return true; } else { return false; } }
}
定义Mapper,@Mapper( uses = { BooleanStrFormat.class})
,注意,这里的users属性用于引用之前定义的转换规则的类:
@Mapper( uses = { BooleanStrFormat.class})
public interface CustomerMapper { CustomerMapper INSTANCES = Mappers.getMapper(CustomerMapper.class); @Mappings({ @Mapping(source = "name", target = "customerName"), @Mapping(source = "isDisable", target = "disable") }) CustomerDto toCustomerDto(Customer customer);
}
这样子,Customer类中的isDisable属性的true就会转变成CustomerDto中的disable属性的yes。
MapStruct自动生成的类中的代码:
@Generated( value = "org.mapstruct.ap.MappingProcessor", date = "2019-02-14T16:49:18+0800", comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
public class CustomerMapperImpl implements CustomerMapper { // 引用 uses 中指定的类 private final BooleanStrFormat booleanStrFormat = new BooleanStrFormat(); @Override public CustomerDto toCustomerDto(Customer customer) { if ( customer == null ) { return null; } CustomerDto customerDto = new CustomerDto(); // 转换方式的使用 customerDto.setDisable( booleanStrFormat.toStr( customer.getIsDisable() ) ); customerDto.setCustomerName( customer.getName() ); customerDto.setId( customer.getId() ); return customerDto; }
}
要注意的是,如果使用了例如像spring这样的环境,Mapper引入uses类实例的方式将是自动注入,那么这个类也应该纳入Spring容器:
CustomerMapper.java指定使用spring
@Mapper(componentModel = "spring", uses = { BooleanStrFormat.class})
public interface CustomerMapper { CustomerMapper INSTANCES = Mappers.getMapper(CustomerMapper.class); @Mappings({ @Mapping(source = "name", target = "customerName"), @Mapping(source = "isDisable", target = "disable") }) CustomerDto toCustomerDto(Customer customer);
}
转换类要加入Spring容器:
@Component
public class BooleanStrFormat { public String toStr(Boolean isDisable) { if (isDisable) { return "Y"; } else { return "N"; } } public Boolean toBoolean(String str) { if (str.equals("Y")) { return true; } else { return false; } }
}
MapStruct自动生成的类:
@Generated( value = "org.mapstruct.ap.MappingProcessor", date = "2019-02-14T16:55:35+0800", comments = "version: 1.3.0.Final, compiler: javac, environment: Java 1.8.0_181 (Oracle Corporation)"
)
@Component
public class CustomerMapperImpl implements CustomerMapper { // 使用自动注入的方式引入 @Autowired private BooleanStrFormat booleanStrFormat; @Override public CustomerDto toCustomerDto(Customer customer) { if ( customer == null ) { return null; } CustomerDto customerDto = new CustomerDto(); customerDto.setDisable( booleanStrFormat.toStr( customer.getIsDisable() ) ); customerDto.setCustomerName( customer.getName() ); customerDto.setId( customer.getId() ); return customerDto; }
}
我们创建了一个高质量的技术交流群,与优秀的人在一起,自己也会优秀起来,赶紧点击加群,享受一起成长的快乐。另外,如果你最近想跳槽的话,年前我花了2周时间收集了一波大厂面经,节后准备跳槽的可以点击这里领取!
推荐阅读
掌握这几个减少 try catch 的方法,让代码更简洁!
这里有一份完整的Java学习路径(文末赠书)
spring-configuration-metadata.json文件是做啥的?
··································
你好,我是程序猿DD,10年开发老司机、阿里云MVP、腾讯云TVP、出过书创过业、国企4年互联网6年。从普通开发到架构师、再到合伙人。一路过来,给我最深的感受就是一定要不断学习并关注前沿。只要你能坚持下来,多思考、少抱怨、勤动手,就很容易实现弯道超车!所以,不要问我现在干什么是否来得及。如果你看好一个事情,一定是坚持了才能看到希望,而不是看到希望才去坚持。相信我,只要坚持下来,你一定比现在更好!如果你还没什么方向,可以先关注我,这里会经常分享一些前沿资讯,帮你积累弯道超车的资本。
点击领取2022最新10000T学习资料
实体映射最强工具类:MapStruct 真香!相关推荐
- 丢弃掉那些BeanUtils工具类吧,MapStruct真香!!!
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 在前几天的文章<为什么阿里巴巴禁止使用Apache Bean ...
- idea抽取重复方法快捷键_使用 IDEA 几分钟就重构了同事800 行quot;又臭又长quot; 的类!真香!...
最近在对已有项目进行扩展的时候,发现要改动的一个类它长 766 行,开放了近 40 个 public 接口,我流着泪把它给改完了.为了防止这样的惨剧再次发生在我的身上,我觉得有必要写一篇博客来让广大程 ...
- 使用 IDEA 几分钟就重构了同事800 行又臭又长 的类!真香!
橙味菌|https://sourl.cn/gvFv33 最近在对已有项目进行扩展的时候,发现要改动的一个类它长 766 行,开放了近 40 个 public 接口,我流着泪把它给改完了.为了防止这样的 ...
- 阿里推出又一款数据高效同步工具DataX,真香、真牛X!
因公众号更改推送规则,请点"在看"并加"星标"第一时间获取精彩技术分享 点击关注#互联网架构师公众号,领取架构师全套资料 都在这里 0.2T架构师学习资料干货分 ...
- 适合自己才是最好的,又是一个能替代 Postman 的工具,Apifox 真香!
发送HTTP请求 API界面功能布局 API请求参数 Header 参数 你可以设置或者导入 Header 参数,cookie也在Header进行设置 Query 参数 Query 支持构造URL参数 ...
- SpringBoot整合Redis+mybatis,封装RedisUtils工具类等实战(附源码)
点击上方蓝色字体,选择"标星公众号" 优质文章,第一时间送达 关注公众号后台回复pay或mall获取实战项目资料+视频 作者:陈彦斌 cnblogs.com/chenyanbin/ ...
- JCF——Java工具类使用
Java工具类的使用(Java数据结构实现) JCF简介 1. 数组 2. 列表 List 3. 集合 Set 4. 映射 Map 迭代器 工具类 Queue 队列 栈
- 推荐一个 Java 实体映射工具 MapStruct
声明: 1.DO(业务实体对象),DTO(数据传输对象). 2.我的代码中用到了 Lombok ,不了解的可以自行了解一下,了解的忽略这条就好. 在一个成熟的工程中,尤其是现在的分布式系统中,应用与应 ...
- Java实体映射工具MapStruct
声明: 1.DO(业务实体对象),DTO(数据传输对象). 2.我的代码中用到了 Lombok ,不了解的可以自行了解一下,了解的忽略这条就好. 1 2 3 在一个成熟的工程中,尤其是现在的分布式系统 ...
- java+基于dom4j工具类_基于dom4j的xml映射实体的工具类(java)
基于dom4j的xml映射实体的工具类(java) 工具是基于dom4j,使用反射使实体属性与xml的标签关联,目前兼容List,Map后续更新兼容. 历史更新: 发布-2019-6-22 增加注解@ ...
最新文章
- 写《回国驯火记》的那个安普若
- java 抽象类与接口理解
- JPA教程:映射实体–第1部分
- 零基础入门Python3-列表list详解
- linqto 多个关键字模糊查询_MySQL查询与约束
- 【2021Java最新学习路线】java后端开发入门
- QuickFlow教程(14)—ExecuteCode using QuickFlowDesigner
- R语言:Error in file(out, “wt“) : cannot open the connection
- 清理谷歌浏览器注册表_注册表修改默认浏览器(建议Chrome)
- 重读模电教材一_童诗白、华成英
- js复制到剪贴板html5,移动端web 复制到剪贴板 怎么实现?
- Logistic模型原理详解以及Python项目实现
- php单引号的作用,PHP中单引号和双引号的区别与作用
- Ubuntu更换阿里软件安装源(vim方式)
- [BZOJ1061][NOI2008]志愿者招募(费用流神题单纯形裸题)
- 【间歇性努力,不是真正的努力】
- 数据分析基础篇---统计学基础
- php 查看文件锁定状态_Photoshop脚本 查看当前图层的锁定状态
- Web过滤器:Filter
- java.util.Date、java.sql.Date和java.sql.Timestamp之间的转换