说到对象转换,以前都是自己new对象,然后逐个属性去转换,并set到对应的属性中。但这种方式纯手写代码,实在过于麻烦,尤其是属性繁多时,后来自己用反射去写,相比较纯手工转换要好很多,但是还是较为麻烦,后来在开发的过程中无意发现了mapstruct这个工具,是真的好用啊,属性名相同的,字段类型相的的直接不用管,属性名不同,字段类型不同的也只需要用注解去转换就可以,还可以抽取公共的转换方法,直接调用,真可谓全能。接下来就具体说一下使用方法,做为自己的掌握知识的总结,也为想使用此工具的朋友提供参考。
导入jar包:
我所使用的版本:
<org.mapstruct.version>1.3.0.Final</org.mapstruct.version>
模拟前端传入的添加对象UserAddDto:
public class UserAddDto {
private String name;
private String age;
private String address;
private String birthday;
}
要转换成的对象User(一般为数据库表对应的对象):
public class User implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(value = "主键")
private String id;
@ApiModelProperty(value = "姓名")
private String name;
@ApiModelProperty(value = "年龄")
private Integer age;
@ApiModelProperty(value = "家庭住址")
private String address;
@ApiModelProperty(value = "出生日期")
private LocalDateTime birthday;
@ApiModelProperty(value = "用户状态:1正常,0不正常")
private String status;
@ApiModelProperty(value = "创建时间")
private LocalDateTime createdTime;
}
以上两个对象的字段转换关系如下:
id:调用方法自动生成,在转换中实现,此处采用的是UUID()
name:String到String,直接转换
age:String到Integer, 会自动进行操作,不需要特殊处理
address:String到String,直接转换
birthday:String到LocalDateTime,调用自定义方法进行转换
status:添加时为固定值:1正常
createdTime:默认当前系统时间,调用java方法实现
为演示两种转换方式,此处特定义两个属性转换公共类,通常情况下只定义一个即可实现
属性转换公共类1TypeConversionMapper:
@Component
@Named("TypeConversionMapper")
public class TypeConversionMapper {
@Named("strDateToLocalDateTime")
public LocalDateTime strDateToLocalDateTime(String strDate){
if (StringUtils.isBlank(strDate))
return null;
return DateUtils.strDateToLocalDateTime(strDate);
}
}
属性转换公共类2BaseMapper
public interface BaseMapper {
default String getUUID(){
return CommonUtils.getUUID();
}
default String getUserName(){
return ThreadLocalContextHolder.getContext().getUserInfo().getUserName();
}
default String getUserId(){
return ThreadLocalContextHolder.getContext().getUserInfo().getUserId();
}
default LocalDateTime parseLocalDateToTime(String date){
DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd");
if (StringUtils.isEmpty(date)) return null;
return LocalDateTime.of(LocalDate.parse(date,dateTimeFormatter), LocalTime.of(0,0));
}
}
转换接口UserMapTran:
@Mapper(
componentModel = "spring",
uses = {TypeConversionMapper.class}
)
public interface UserMapTran extends BaseMapper{
@Mappings({
@Mapping(
target = "birthday",
source = "birthday",
qualifiedByName = "strDateToLocalDateTime"
),
@Mapping(
target = "name",source = "name"
),
@Mapping(target = "age",source = "age"),
@Mapping(target = "address",source = "address"),
@Mapping(target = "status",constant = "1"),
@Mapping(target = "id",expression = "java(getUUID())"),
@Mapping(target = "createdTime",expression = "java(java.time.LocalDateTime.now())")
})
User userAddDtoToUser(UserAddDto addDto);
}
@Mapper componentModel 指定管理组件,此处交由spring管理
users指定属性转换类 TypeConversionMapper.class
承认属性转换接口BaseMapper
birthday属性的转换是通过TypeConversionMapper来实现的,通过名字调用具体的方法(由@Name属性指定,@Mapping里的qualifiedByName属性指定具体方法)。
id属性的生成则是调用TypeConversionMapper中的方法,通过expresssion属性指定具体方法,需要说明的这种方式要指定编译语言,如java(BaseMapper接口里的方法名),如果不继承BaseMapper接口,也可以通过指定方法全路径的方式来实现,如createdTime属性的转换方式。
贴一下编译后的实现类UserMapTranImpl:
public class UserMapTranImpl implements UserMapTran {
@Autowired
private TypeConversionMapper typeConversionMapper;
public UserMapTranImpl() {
}
public User userAddDtoToUser(UserAddDto addDto) {
if (addDto == null) {
return null;
} else {
User user = new User();
user.setBirthday(this.typeConversionMapper.strDateToLocalDateTime(addDto.getBirthday()));
user.setAddress(addDto.getAddress());
user.setName(addDto.getName());
if (addDto.getAge() != null) {
user.setAge(Integer.parseInt(addDto.getAge()));
}
user.setCreatedTime(LocalDateTime.now());
user.setId(this.getUUID());
user.setStatus("1");
return user;
}
}
}
从上面的编译结果可以看出,正确调用了我们所指定的方法。