使用Mapstruct来进行PO与VO之间的映射

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() ) );
}

使用Mapstruct来进行PO与VO之间的映射

猜你喜欢