背景
在寫代碼的時(shí)候，不同的層带膀、不同的接口等地方，有時(shí)候都要對對象做一下轉(zhuǎn)換著拭，之前一直用的是BeanUtils荷愕，感覺用起來沒那么靈活衡怀。后來看了一篇文章介紹了一個(gè)新的bean轉(zhuǎn)換工具——mapstruct（https://mp.weixin.qq.com/s/jwT2wi6ZQL7VqMFTk6rEvg），考慮到舊的項(xiàng)目改起來比較麻煩安疗，所以到最近接了個(gè)需求要開發(fā)新的項(xiàng)目抛杨，所以嘗試一下在這個(gè)項(xiàng)目里面用這個(gè)工具。
代碼案例
1.配置pom.xml
<org.mapstruct.version>1.4.1.Final</org.mapstruct.version>
...
需要lambok
...
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>${org.mapstruct.version}</version>
</dependency>
...
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<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.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${org.projectlombok.version}</version>
</path>
<path>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>${org.mapstruct.version}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
2.創(chuàng)建一個(gè)mapper接口類：
//加上這個(gè)componentModel方便在spring項(xiàng)目里面直接注入
@Mapper(componentModel = "spring")
public interface XXXConverter{
}
3.針對不同情況的轉(zhuǎn)換荐类，創(chuàng)建不同的方法
簡單粗暴映射兩個(gè)對象的屬性名相同的值（支持集合類怖现，如list,set等）
XXXDto entityToDto(XXXEntity entity);
List<XXXDto> entityToDto(List<XXXEntity> entity)
有時(shí)候同一個(gè)對象返回給不同接口時(shí)，字段不同玉罐。按傳統(tǒng)的方法真竖，可能是創(chuàng)建不同的Vo類來映射，用MapStruct的話厌小，可以分別創(chuàng)建不同的方法來映射給同一個(gè)對象
//通過ignore恢共，可以忽略掉前端不需要的屬性
@Mapping(target = "createdBy", ignore = true)
@Mapping(target = "createdGmt", ignore = true)
@Mapping(target = "modifiedBy", ignore = true)
@Mapping(target = "modifiedGmt", ignore = true)
XXXVo entityToVo1(XXXEntity entity);
@Mapping(target = "content", ignore = true)
@Mapping(target = "desc", ignore = true)
XXXVo entityToVo2(XXXEntity entity);
通過表達(dá)式（expression = "java(Java代碼)"）來進(jìn)行來進(jìn)行一些特殊的賦值：
@Mapping(target = "createdGmt", expression = "java(new java.util.Date())")
@Mapping(target = "modifiedGmt", expression = "java(new java.util.Date())")
XXXENtity reqToEntity(XXXReq req);
再進(jìn)行列表映射的時(shí)候，被映射的對象有些屬性再源對象里面沒有璧亚，需要通過其他方法來寫入的時(shí)候讨韭，可以通過@Context注解來實(shí)現(xiàn)：
@Mapping(target = "versionNo", expression = "java(version)")
XXXRecord entityToRecord(XXXEntitydiseaseAndSkill, @Context String versionNo);
//這里的方法名，要跟上面的相同
List<XXXRecord> entityToRecord(List<XXXEntity> entities, @Context String versionNo);
字段名相同癣蟋，但是字段類型不同：
//源字段是List類型透硝，目標(biāo)字段是用豎線分隔的字符串
@Mapping(target = "imgUrls", expression = "java(transListToString(req.getImgUrls()))")
XXXENtity reqToEntity(XXXReq req);
default String transListToString(List<String> list) {
return String.join("|", list);
}
其他支持但還沒用到的場景：日期格式化、多個(gè)對象映射到一個(gè)對象疯搅、map映射等等濒生。想用到的但是還沒找到辦法實(shí)現(xiàn)的場景：只映射指定字段，其余全部忽略（目前僅支持忽略指定字段幔欧，其余默認(rèn)映射）
4.在對應(yīng)的業(yè)務(wù)類里面調(diào)用
XXXDto dto = xxxConverter.dtoToEntity(entity);
原理
通過lombok生成每個(gè)接口對應(yīng)的代碼罪治，實(shí)際上生成的代碼如下：
public XXXENtity reqToEntity(XXXReq req) {
if ( req == null ) {
return null;
}
XXXENtity entity= new XXXENtity ();
entity.setCreatedBy( req.getCreatedBy() );
entity.setCreatedId( req.getCreatedId() );
entity.setKnowledgeId( req.getKnowledgeId() );
entity.setDetail( req.getDetail() );
entity.setImgUrls( transListToString(req.getImgUrls()) );
entity.setCreatedGmt( new java.util.Date() );
entity.setModifiedGmt( new java.util.Date() );
return diseaseAndSkillFeedback;
}
優(yōu)點(diǎn)
擴(kuò)展性強(qiáng)丽声，支持各種騷操作
根據(jù) 這篇文章 的性能壓測來看，JMapper 和 MapStruct 的性能最好
因?yàn)镸apStruct是生成靜態(tài)代碼觉义，而BeanUtil是利用了反射雁社，所以性能肯定比BeanUtil要好的
面對不同的字段需要，有時(shí)候可以用創(chuàng)建不同的映射方法來代替創(chuàng)建那么多同一層級不同的對象
如果字段修改了晒骇，可以在idea上安裝MapStruct相關(guān)插件霉撵，來提醒（標(biāo)黃）：
場景越復(fù)雜，對比BeanUtil等工具而言洪囤，代碼越簡潔
缺點(diǎn)
每次改了對應(yīng)的對象或mapper類徒坡，都需要clean之后再install
如果只是最基礎(chǔ)的同字段名映射，其實(shí)沒有直接用BeanUtil方便瘤缩，畢竟用mapstruct的話崭参，還得多建一個(gè)類
總結(jié)
越復(fù)雜的場景，用MapStruct越好款咖；只是簡單的場景的話何暮，用不用都行。
