原文
SpringBoot 如何進(jìn)行對象復(fù)制，老鳥們都這么玩的！ (qq.com)
為什么需要對象復(fù)制
如上，是我們平時開發(fā)中最常見的三層MVC架構(gòu)模型盛末，編輯操作時Controller層接收到前端傳來的DTO對象，在Service層需要將DTO轉(zhuǎn)換成DO涯穷，然后在數(shù)據(jù)庫中保存噪径。查詢操作時Service層查詢到DO對象后需要將DO對象轉(zhuǎn)換成VO對象柱恤，然后通過Controller層返回給前端進(jìn)行渲染。這中間會涉及到大量的對象轉(zhuǎn)換找爱，很明顯我們不能直接使用getter/setter復(fù)制對象屬性梗顺，這看上去太low了。
看到這里有同學(xué)可能會問车摄，為什么不能前后端都統(tǒng)一使用DO對象呢寺谤？這樣就不存在對象轉(zhuǎn)換呀？
設(shè)想一下如果我們不想定義 DTO 和 VO吮播，直接將 DO 用到數(shù)據(jù)訪問層变屁、服務(wù)層、控制層和外部訪問接口上意狠。此時該表刪除或則修改一個字段粟关，DO 必須同步修改，這種修改將會影響到各層环戈，這并不符合高內(nèi)聚低耦合的原則闷板。通過定義不同的 DTO 可以控制對不同系統(tǒng)暴露不同的屬性，通過屬性映射還可以實現(xiàn)具體的字段名稱的隱藏院塞。不同業(yè)務(wù)使用不同的模型遮晚，當(dāng)一個業(yè)務(wù)發(fā)生變更需要修改字段時，不需要考慮對其它業(yè)務(wù)的影響拦止，如果使用同一個對象則可能因為 “不敢亂改” 而產(chǎn)生很多不優(yōu)雅的兼容性行為县遣。
對象復(fù)制工具類推薦
對象復(fù)制的類庫工具有很多，除了常見的Apache的BeanUtils汹族，Spring的BeanUtils萧求，Cglib BeanCopier，還有重量級組件MapStruct顶瞒，Orika饭聚，Dozer，ModelMapper等搁拙。如果沒有特殊要求秒梳，這些工具類都可以直接使用，除了Apache的BeanUtils箕速。原因在于Apache BeanUtils底層源碼為了追求完美酪碘，加了過多的包裝，使用了很多反射盐茎，做了很多校驗兴垦，所以導(dǎo)致性能較差，并在阿里巴巴開發(fā)手冊上強(qiáng)制規(guī)定避免使用 Apache BeanUtils。
<figcaption style="margin: 5px 0px 0px; padding: 0px; outline: 0px; max-width: 100%; box-sizing: border-box !important; overflow-wrap: break-word !important; text-align: center; color: rgb(136, 136, 136); font-size: 12px;">強(qiáng)制規(guī)定避免使用 Apache BeanUtils</figcaption>
至于剩下的重量級組件探越，綜合考慮其性能還有使用的易用性狡赐，我這里更推薦使用Orika。Orika底層采用了javassist類庫生成Bean映射的字節(jié)碼钦幔，之后直接加載執(zhí)行生成的字節(jié)碼文件枕屉，在速度上比使用反射進(jìn)行賦值會快很多。
“國外大神 baeldung 已經(jīng)對常見的組件性能進(jìn)行過詳細(xì)測試鲤氢，大家可以通過 https://www.baeldung.com/java-performance-mapping-frameworks 查看瘫筐〉凳澹”
Orika基本使用
要使用Orika很簡單嚼沿，只需要簡單四步：
- 引入依賴
<dependency>
<groupId>ma.glasnost.orika</groupId>
<artifactId>orika-core</artifactId>
<version>1.5.4</version>
</dependency>
- 構(gòu)造一個MapperFactory
MapperFactory mapperFactory = new DefaultMapperFactory.Builder().build();
- 注冊字段映射
mapperFactory.classMap(SourceClass.class, TargetClass.class)
.field("firstName", "givenName")
.field("lastName", "sirName")
.byDefault()
.register();
當(dāng)字段名在兩個實體不一致時可以通過.field()方法進(jìn)行映射宁昭，如果字段名都一樣則可省略，byDefault()方法用于注冊名稱相同的屬性相种，如果不希望某個字段參與映射威恼，可以使用exclude方法。
- 進(jìn)行映射
MapperFacade mapper = mapperFactory.getMapperFacade();
SourceClass source = new SourceClass();
// set some field values
...
// map the fields of 'source' onto a new instance of PersonDest
TargetClass target = mapper.map(source, TargetClass.class);
經(jīng)過上面四步我們就完成了SourceClass到TargetClass的轉(zhuǎn)換寝并。至于Orika的其他使用方法大家可以參考 http://orika-mapper.github.io/orika-docs/index.html看到這里箫措，肯定有粉絲會說：你這推薦的啥玩意呀，這個Orika使用也不簡單呀食茎，每次都要這先創(chuàng)建MapperFactory，建立字段映射關(guān)系馏谨，才能進(jìn)行映射轉(zhuǎn)換别渔。別急，我這里給你準(zhǔn)備了一個工具類OrikaUtils惧互，你可以通過文末github倉庫獲取哎媚。它提供了五個公共方法：
分別對應(yīng)：
- 字段一致實體轉(zhuǎn)換
- 字段不一致實體轉(zhuǎn)換（需要字段映射）
- 字段一致集合轉(zhuǎn)換
- 字段不一致集合轉(zhuǎn)換（需要字段映射）
- 字段屬性轉(zhuǎn)換注冊
接下來我們通過單元測試案例重點介紹此工具類的使用。
Orika工具類使用文檔
先準(zhǔn)備兩個基礎(chǔ)實體類喊儡，Student拨与，Teacher。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
private String id;
private String name;
private String email;
}
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Teacher {
private String id;
private String name;
private String emailAddress;
}
TC1艾猜，基礎(chǔ)實體映射
/**
* 只拷貝相同的屬性
*/
@Test
public void convertObject(){
Student student = new Student("1","javadaily","jianzh5@163.com");
Teacher teacher = OrikaUtils.convert(student, Teacher.class);
System.out.println(teacher);
}
輸出結(jié)果：
Teacher(id=1, name=javadaily, emailAddress=null)
此時由于屬性名不一致买喧，無法映射字段email。
TC2匆赃，實體映射 - 字段轉(zhuǎn)換
/**
* 拷貝不同屬性
*/
@Test
public void convertRefObject(){
Student student = new Student("1","javadaily","jianzh5@163.com");
Map<String,String> refMap = new HashMap<>(1);
//map key 放置 源屬性淤毛，value 放置 目標(biāo)屬性
refMap.put("email","emailAddress");
Teacher teacher = OrikaUtils.convert(student, Teacher.class, refMap);
System.out.println(teacher);
}
輸出結(jié)果：
Teacher(id=1, name=javadaily, emailAddress=jianzh5@163.com) </pre>
此時由于對字段做了映射，可以將email映射到emailAddress算柳。注意這里的refMap中key放置的是源實體的屬性低淡，而value放置的是目標(biāo)實體的屬性，不要弄反了。
TC3蔗蹋，基礎(chǔ)集合映射
/**
* 只拷貝相同的屬性集合
*/
@Test
public void convertList(){
Student student1 = new Student("1","javadaily","jianzh5@163.com");
Student student2 = new Student("2","JAVA日知錄","jianzh5@xxx.com");
List<Student> studentList = Lists.newArrayList(student1,student2);
List<Teacher> teacherList = OrikaUtils.convertList(studentList, Teacher.class);
System.out.println(teacherList);
}
輸出結(jié)果：
[Teacher(id=1, name=javadaily, emailAddress=null), Teacher(id=2, name=JAVA日知錄, emailAddress=null)]
此時由于屬性名不一致何荚，集合中無法映射字段email。
TC4猪杭，集合映射 - 字段映射
/**
* 映射不同屬性的集合
*/
@Test
public void convertRefList(){
Student student1 = new Student("1","javadaily","jianzh5@163.com");
Student student2 = new Student("2","JAVA日知錄","jianzh5@xxx.com");
List<Student> studentList = Lists.newArrayList(student1,student2);
Map<String,String> refMap = new HashMap<>(2);
//map key 放置 源屬性餐塘，value 放置 目標(biāo)屬性
refMap.put("email","emailAddress");
List<Teacher> teacherList = OrikaUtils.convertList(studentList, Teacher.class,refMap);
System.out.println(teacherList);
}
輸出結(jié)果：
[Teacher(id=1, name=javadaily, emailAddress=jianzh5@163.com), Teacher(id=2, name=JAVA日知錄, emailAddress=jianzh5@xxx.com)]
也可以通過這樣映射：
Map<String,String> refMap = new HashMap<>(2);
refMap.put("email","emailAddress");
List<Teacher> teacherList = OrikaUtils.classMap(Student.class,Teacher.class,refMap)
.mapAsList(studentList,Teacher.class);
TC5，集合與實體映射
有時候我們需要將集合數(shù)據(jù)映射到實體中胁孙，如Person類
@Data
public class Person {
private List<String> nameParts;
}
現(xiàn)在需要將Person類nameParts的值映射到Student中唠倦，可以這樣做
/**
* 數(shù)組和List的映射
*/
@Test
public void convertListObject(){
Person person = new Person();
person.setNameParts(Lists.newArrayList("1","javadaily","jianzh5@163.com"));
Map<String,String> refMap = new HashMap<>(2);
//map key 放置 源屬性，value 放置 目標(biāo)屬性
refMap.put("nameParts[0]","id");
refMap.put("nameParts[1]","name");
refMap.put("nameParts[2]","email");
Student student = OrikaUtils.convert(person, Student.class,refMap);
System.out.println(student);
}
輸出結(jié)果：
Student(id=1, name=javadaily, email=jianzh5@163.com)
TC6涮较，類類型映射
有時候我們需要類類型對象映射稠鼻，如BasicPerson類
@Data
public class BasicPerson {
private Student student;
}
現(xiàn)在需要將BasicPerson映射到Teacher
/**
* 類類型映射
*/
@Test
public void convertClassObject(){
BasicPerson basicPerson = new BasicPerson();
Student student = new Student("1","javadaily","jianzh5@163.com");
basicPerson.setStudent(student);
Map<String,String> refMap = new HashMap<>(2);
//map key 放置 源屬性，value 放置 目標(biāo)屬性
refMap.put("student.id","id");
refMap.put("student.name","name");
refMap.put("student.email","emailAddress");
Teacher teacher = OrikaUtils.convert(basicPerson, Teacher.class,refMap);
System.out.println(teacher);
}
輸出結(jié)果：
Teacher(id=1, name=javadaily, emailAddress=jianzh5@163.com) </pre>
TC7狂票，多重映射
有時候我們會遇到多重映射候齿，如將StudentGrade映射到TeacherGrade
@Data
public class StudentGrade {
private String studentGradeName;
private List<Student> studentList;
}
@Data
public class TeacherGrade {
private String teacherGradeName;
private List<Teacher> teacherList;
}
這種場景稍微復(fù)雜，Student與Teacher的屬性有email字段不相同闺属，需要做轉(zhuǎn)換映射慌盯；StudentGrade與TeacherGrade中的屬性也需要映射。
/**
* 一對多映射
*/
@Test
public void convertComplexObject(){
Student student1 = new Student("1","javadaily","jianzh5@163.com");
Student student2 = new Student("2","JAVA日知錄","jianzh5@xxx.com");
List<Student> studentList = Lists.newArrayList(student1,student2);
StudentGrade studentGrade = new StudentGrade();
studentGrade.setStudentGradeName("碩士");
studentGrade.setStudentList(studentList);
Map<String,String> refMap1 = new HashMap<>(1);
//map key 放置 源屬性掂器，value 放置 目標(biāo)屬性
refMap1.put("email","emailAddress");
OrikaUtils.register(Student.class,Teacher.class,refMap1);
Map<String,String> refMap2 = new HashMap<>(2);
//map key 放置 源屬性亚皂，value 放置 目標(biāo)屬性
refMap2.put("studentGradeName", "teacherGradeName");
refMap2.put("studentList", "teacherList");
TeacherGrade teacherGrade = OrikaUtils.convert(studentGrade,TeacherGrade.class,refMap2);
System.out.println(teacherGrade);
}
多重映射的場景需要根據(jù)情況調(diào)用OrikaUtils.register()注冊字段映射。輸出結(jié)果：
TeacherGrade(teacherGradeName=碩士, teacherList=[Teacher(id=1, name=javadaily, emailAddress=jianzh5@163.com), Teacher(id=2, name=JAVA日知錄, emailAddress=jianzh5@xxx.com)])
TC8国瓮，MyBaits plus分頁映射
如果你使用的是mybatis的分頁組件灭必，可以這樣轉(zhuǎn)換
public IPage<UserDTO> selectPage(UserDTO userDTO, Integer pageNo, Integer pageSize) {
Page page = new Page<>(pageNo, pageSize);
LambdaQueryWrapper<User> query = new LambdaQueryWrapper();
if (StringUtils.isNotBlank(userDTO.getName())) {
query.like(User::getKindName,userDTO.getName());
}
IPage<User> pageList = page(page,query);
// 實體轉(zhuǎn)換 SysKind轉(zhuǎn)化為SysKindDto
Map<String,String> refMap = new HashMap<>(3);
refMap.put("kindName","name");
refMap.put("createBy","createUserName");
refMap.put("createTime","createDate");
return pageList.convert(item -> OrikaUtils.convert(item, UserDTO.class, refMap));
}
小結(jié)
在MVC架構(gòu)中肯定少不了需要用到對象復(fù)制，屬性轉(zhuǎn)換的功能乃摹，借用Orika組件禁漓，可以很簡單實現(xiàn)這些功能。本文在Orika的基礎(chǔ)上封裝了工具類孵睬，進(jìn)一步簡化了Orika的操作播歼，希望對各位有所幫助。
