更多參考：
https://juejin.im/entry/5b228c2651882574b15882ba
https://blog.csdn.net/u014175005/article/details/72792839
使用Mapstruct來進行PO與VO之間的映射
區別與mvc模型的 mvvm模型,將模型對象與視圖對象view model分離開，來做到與底層model分離開來。大大解耦底層model與界面vo的關係，至此就需要一個工具來做到po與vo分離開來。
最初的想法是使用apache-beanutils 但是其對一些深層次對象拷貝做不到，雖然可以通過改寫其內部源碼實現對嵌套對象屬性拷貝，但是出現特殊業務轉換，如 屬性名字不匹配，beanutils對於mapstruct就相形見絀了。
話不多說：
maven引入
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>1.1.0.Final</version>
</dependency>
模擬po對象
public class Person {
private String name;
private Integer age;
private Date birthdate;
private float wallet;
...setter getter
}
創建vo對象
public class PersonVo {
private String name;
private Integer age;
private Date birth;//與po對象屬性名不一致
private float wallet;
private String birthformat;//通過po對象的某一屬性擴展
...setter getter
｝
創建mapstuct 接口
@Mapper
public interface Persion2PersonVoMapper {
Persion2PersonVoMapper MAPPER = Mappers.getMapper(Persion2PersonVoMapper.class);
@Mappings({
@Mapping(source = "birthdate", target = "birth"),//屬性名不一致映射
@Mapping(target = "birthformat", expression = "java(org.apache.commons.lang3.time.DateFormatUtils.format(person.getBirthdate(),\"yyyy-MM-dd HH:mm:ss\"))"),//自定義屬性通過java代碼映射
})
public PersonVo PersonToPersonVo(Person person);
public List<PersonVo> PersonToPersonVos(List<Person> list);
}
創建測試類
public class MapStuctTest {
//單個對象映射
@Test
public void singleTest(){
Person person=new Person("wayne",12,new Date(),12f);
PersonVo personVo = Persion2PersonVoMapper.MAPPER.PersonToPersonVo(person);
Assert.assertTrue(personVo.getName().equals(person.getName()));
Assert.assertTrue(personVo.getAge().equals(person.getAge()));
Assert.assertTrue(personVo.getBirth().equals(person.getBirthdate()));
Assert.assertTrue(personVo.getWallet()==person.getWallet());
}
//對象集合映射
@Test
public void listTest(){
Person person=new Person("wayne",12,new Date(),12f);
Person person2=new Person("wayne2",13,new Date(new Date().getTime()+3600000),13f);
Person person3=new Person("wayne3",14,new Date(new Date().getTime()+7200000),14f);
Person person4=new Person("wayne4",15,new Date(new Date().getTime()+9800000),15f);
List<Person> list=new ArrayList();
list.add(person);
list.add(person2);
list.add(person3);
list.add(person4);
List<PersonVo> personVos = Persion2PersonVoMapper.MAPPER.PersonToPersonVos(list);
Assert.assertTrue(list.size()==personVos.size());
}
}
我們來看看debug信息。
1. 單個對象映射測試
singleTest()測試方法
查看debug信息
使用一行 語句
PersonVo personVo = Persion2PersonVoMapper.MAPPER.PersonToPersonVo(person);
1
源屬性 birthdate 已經轉換到 目標屬性 birth，同時我們目標類的自定義屬性也接收到源對象的格式化 birthdate 屬性值爲“2017-05-28 13:22:21”
單個對象並沒有體現便捷,我們來看集合對象的轉換。
2. 集合對象映射測試
listTest()測試方法
查看debug信息
這是源對象集合信息
映射後的目標集合對象信息
可以看到集合轉集合也只使用一行代碼
List<PersonVo> personVos = Persion2PersonVoMapper.MAPPER.PersonToPersonVos(list);
1
幫我們省去很多集合遍歷添加操作。
ok 我們來看看底層原理。
我們所寫的 Persion2PersonVoMapper 接口在編譯時生成一個Persion2PersonVoMapperImpl 實現類。
public class Persion2PersonVoMapperImpl implements Persion2PersonVoMapper {
@Override
public PersonVo PersonToPersonVo(Person person) {
if ( person == null ) {
return null;
}
PersonVo personVo = new PersonVo();
personVo.setBirth( person.getBirthdate() );
personVo.setName( person.getName() );
personVo.setAge( person.getAge() );
personVo.setWallet( person.getWallet() );
personVo.setBirthformat( org.apache.commons.lang3.time.DateFormatUtils.format(person.getBirthdate(),"yyyy-MM-dd HH:mm:ss") );
return personVo;
}
@Override
public List<PersonVo> PersonToPersonVos(List<Person> list) {
if ( list == null ) {
return null;
}
List<PersonVo> list_ = new ArrayList<PersonVo>();
for ( Person person : list ) {
list_.add( PersonToPersonVo( person ) );
}
return list_;
}
}
我並未對生成類進行修改，只稍作格式化。
原來 並沒有很高級的操作，只是mapstruct 幫我們生成的 手動get set操作，然後for add操作。
自定義轉義
對一些特殊的轉換 我們可以進行自定義訂製。
public class MapStructUtils {
public float asfloat(float inputfloat){
BigDecimal bigDecimal =new BigDecimal(inputfloat+"");
return bigDecimal.setScale(2,BigDecimal.ROUND_HALF_UP).floatValue();
//float數據 四捨五入保留兩位小數
}
}
mapper上面添加註解
@Mapper(uses=MapStructUtils.class)
1
查看對應的生成實現
@Override
public PersonVo PersonToPersonVo(Person person) {
if ( person == null ) {
return null;
}
PersonVo personVo = new PersonVo();
personVo.setBirth( person.getBirthdate() );
if ( person.getBirthdate() != null ) {
personVo.setBirthformat( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss" ).format( person.getBirthdate() ) );
}
personVo.setName( person.getName() );
personVo.setAge( person.getAge() );
personVo.setWallet( mapStructUtils.asfloat( person.getWallet() ) );
return personVo;
}
可以查看到 float類型轉換時 使用了我們自定義的方法
personVo.setWallet( mapStructUtils.asfloat( person.getWallet() ) );
1
vo轉換爲po Inverse反轉
反轉映射
Person2PersonVoMapper.java
@InheritInverseConfiguration
public Person PersonVoToPerson(PersonVo personVo);
1
2
3
測試類
@Test
public void singleTest(){
Person person=new Person("wayne",12,new Date(),12.1231231f);
PersonVo personVo = Person2PersonVoMapper.MAPPER.PersonToPersonVo(person);
Assert.assertTrue(personVo.getName().equals(person.getName()));
Assert.assertTrue(personVo.getAge().equals(person.getAge()));
Assert.assertTrue(personVo.getBirth().equals(person.getBirthdate()));
//Inverse 反轉
personVo.setBirthformat("2017-05-28 19:59:27");
Person person1 = Person2PersonVoMapper.MAPPER.PersonVoToPerson(personVo);
}
vo反向生成po對象
vo更新po
@Mappings({
@Mapping(target = "birthdate", source = "birth")
})
public void UpdatePersonVo( PersonVo personVo, @MappingTarget Person person);
單元測試
@Test
public void singleUpdateTest(){
Person person=new Person("wayne",12,new Date(),12f);
PersonVo personVo = Persion2PersonVoMapper.MAPPER.PersonToPersonVo(person);
//Person person2=new Person("handsome wayne",92,new Date(new Date().getTime()+9800000),92f);
personVo.setName("handsome wayne");
personVo.setAge(92);
personVo.setBirth(new Date(new Date().getTime()+9800000));
Persion2PersonVoMapper.MAPPER.UpdatePersonVo(personVo,person);
}
反向更新
map映射
@MapMapping(valueDateFormat ="yyyy-MM-dd HH:mm:ss")
public Map<String ,String> DateMapToStringMap(Map<String,Date> sourceMap);
1
2
測試方法
@Test
public void mapMappingTest(){
Map<String,Date> map=new HashMap<>();
map.put("key1",new Date());
map.put("key2",new Date(new Date().getTime()+9800000));
Map<String, String> stringObjectMap = Person2PersonVoMapper.MAPPER.DateMapToStringMap(map);
}
總結一下
關於mapper接口
它可以自動封裝一些同級，屬性名相同的屬性名如上name age 屬性，可以無需手動寫 @Mapping
對於非同級或屬性名 需要寫相關的 @mapping 屬性名不同可以查考 birth 屬性配置。如果不同級@Mapping(source = “XXX.birthdate”, target = “XX.birth”) 如此就行了。
關於實現類，老版本的eclipse可能無法自動編譯出來，如果使用maven，install就可以有生產類，以防可能會出現 class not found 異常。
@mapping 還有很多屬性
public @interface Mapping {
String target();
String source() default "";
String dateFormat() default "";
String numberFormat() default "";
String constant() default "";
String expression() default "";
boolean ignore() default false;
Class<? extends Annotation>[] qualifiedBy() default {};
String[] qualifiedByName() default {};
Class<?> resultType() default void.class;
String[] dependsOn() default {};
String defaultValue() default "";
}
target，source，expression 在此不再複述,
dateFormat 可以代替事例中expression ，如此：
@Mapping(target = "birthformat", source = "birthdate",dateFormat = "yyyy-MM-dd HH:mm:ss"),
//生產類
if ( person.getBirthdate() != null ) {
personVo.setBirthformat( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss" ).format( person.getBirthdate() ) );
}