MapStruct
前言
在日常开发中往往需要进行Java bean 之间的复制操作,常用的映射框架有ModelMapper、Common-BeanUtils。
但是他们都是基于反射进行bean属性的复制,在考虑效率方面,反而不如我们直接使用get××(),set××()高效。
MapStruct 是一款高效bean映射器,使用预编译的方式生成对应的get,set方法。
映射问题
在其他映射框架中如果源属性在目标属性中不存在,目标属性为null即可,不会有error或者warning;
但是在MapStruct中源属性在目标属性中不存在,编译会有warning;
Unmapped target property: "××××".
解决
在方法上添加 @Mapping(target = “deletedAt”, ignore = true)
@Mapper
public interface MallDeviceConverterMapper {
MallDeviceConverterMapper INSTANCE = Mappers.getMapper(MallDeviceConverterMapper.class);
@Mapping(target = "deletedAt", ignore = true)
MallDeviceProductResponse toMallDeviceResponse(MallDevice.PageMallDeviceResponse request);
采用不映射策略
@Mapper(componentModel = “spring”, unmappedTargetPolicy = ReportingPolicy.IGNORE)
ERROR:任何未映射的目标属性都将使构建失败–这可以避免意外的未映射字段
WARN:(默认)构建期间的警告消息
IGNORE:无输出或错误
-
defaut:
这是默认的情况,mapstruct不使用任何组件类型,可以通过Mappers.getMapper(Class)方式获取自动生成的实例对象; -
cdi: 使用@Inject进行注入;
-
spring: 生成的实现类上面会自动添加一个@ Component注解,可以通过Spring的 @Autowired方式进行注入;
-
jsr330: 生成的实现类上会添加@javax.inject.Named 和@Singleton注解,可以通过 @Inject注解获取;
或者
@BeanMapping (ignoreUnmappedSourceProperties)//加在接口上面
null 值问题
笔者实际遇到了null值处理问题
场景:GRPC中根据proto编译的java bean,通过 MapStruct进行复制时出现空指针,排查发现是GRPC的这段代码产生的问题。
/**
* <code>string createdAt = 16;</code>
* @param value The createdAt to set.
* @return This builder for chaining.
*/
public Builder setCreatedAt(
//GRPC的set方法的非空判断产生了空指针异常
java.lang.String value) {
if (value == null) { throw new NullPointerException(); }
createdAt_ = value;
bitField0_ |= 0x00008000;
onChanged();
return this;
}
所以需要配置MapStruct中@Mapper的所有源属性进行非空检查的策略
@Mapper 非空策略
null 值问题的处理MapStruct中@Mapper 的两个配置策略会给到答案
MapStruct API
/**
* nullValueCheckStrategy 对源属性进行空值检查策略
* ALWAYS-对所有源属性进行空值检查
* ON_IMPLICIT_CONVERSION-对隐式转换的源属性进行空值检查
* NullValueMappingStrategy 如果为null目标属性返回策略
* RETURN_NULL-返回 null 默认策略
* RETURN_DEFAULT-返回默认值
**/
@Mapper(nullValueCheckStrategy = ALWAYS,nullValueMappingStrategy = RETURN_DEFAULT)
自定义映射器(上述问题都可以解决,基本转换需求都可实现)
有特定需求,可直接使用自定义映射器
自定义映射器
public class BigDecimalMapper {
public BigDecimal stringToBigDecimal(String string){
return StringUtils.isNotBlank(string) ? new BigDecimal(string) : null;
}
}
转换器
@Mapper(uses = BigDecimalMapper.class)
public interface MallDeviceConverterMapper {
MallDeviceConverterMapper INSTANCE = Mappers.getMapper(MallDeviceConverterMapper.class);
@Mapping(target = "deletedAt", ignore = true)
MallDeviceProductResponse toMallDeviceResponse(MallDevice.PageMallDeviceResponse request);
}