使用场景:
在开发中,从数据库获取的数据需要处理再返回给前端,那么mapStruct直接的映射是实现不了的,我们就需要编写工具类和方法进行处理数据。
例如:我们数据库存储的价格单位是分,但返回给前端是元。
解决方案:
编写工具类MoneyConverterUtil
,它包含一个方法fenToYuan
,用于将分转换为元:
public class MoneyConverterUtil{public static BigDecimal fenToYuan(BigDecimal fen) {return fen.divide(BigDecimal.valueOf(100), 2, RoundingMode.HALF_UP);}
}
现在,想在MapStruct映射中使用这个方法来转换一个字段。Mapper接口如下所示:
错误示范
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;@Mapper
public interface TariffPackageMapper {TariffPackageMapper INSTANCE = Mappers.getMapper(TariffPackageMapper.class);@Mappings({@Mapping(target = "purchaseCostPrice", expression = "java(MoneyConverterUtil.fenToYuan(source.getPurchaseCostPrice()))"),@Mapping(target = "resourceCostPrice", expression = "java(MoneyConverterUtil.fenToYuan(source.getResourceCostPrice()))")})TariffPackageResponse doToResponse(TariffPackage source);
}
这样子写会有问题,因为没有指定MoneyConverterUtil的类路径,底层生成的实现类是找不到该类而报错。所以我们要加上类路径com.sundark.common.utils.
正确示范
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;
import org.mapstruct.Mappings;
import org.mapstruct.factory.Mappers;@Mapper
public interface TariffPackageMapper {TariffPackageMapper INSTANCE = Mappers.getMapper(TariffPackageMapper.class);@Mappings({@Mapping(target = "purchaseCostPrice", expression = "java(com.sundark.common.utils.MoneyConverterUtil.fenToYuan(source.getPurchaseCostPrice()))"),@Mapping(target = "resourceCostPrice", expression = "java(com.sundark.common.utils.MoneyConverterUtil.fenToYuan(source.getResourceCostPrice()))")})TariffPackageResponse doToResponse(TariffPackage source);
}
总结:
@Mapper
注解标记了接口是一个MapStruct映射器接口。TariffPackageMapper.INSTANCE
提供了一个全局访问点,用于访问由MapStruct生成的实现类。@Mappings
注解包含了多个@Mapping
注解,允许您为同一个方法指定多个映射规则。- 每个
@Mapping
注解中的expression
属性指定了如何计算目标字段的值。这里使用了java(MoneyConverterUtil.fenToYuan(...))
来调用工具类MoneyConverterUtil
中的方法。 @Mapping
注解用于指定一个特定的属性映射。target = "purchaseCostPrice"
:这表示映射的目标属性是purchaseCostPrice
。expression = "java(MoneyConverterUtil.fenToYuan(tariffPackage.getPurchaseCostPrice()))"
:这表示映射的值不是直接从一个属性复制到另一个属性,而是通过执行一个自定义的Java表达式来计算得出。这个表达式调用了MoneyConverterUtil
类中的fenToYuan
方法,并将tariffPackage
对象的getPurchaseCostPrice()
方法的返回值作为参数传递给这个方法。
使用了MapStruct框架来定义从TariffPackage
对象到TariffPackageResponse
对象的映射规则。@Mappings
注解是一个容器注解,它允许你为同一个方法指定多个@Mapping
注解。在你提供的代码中,doToResponse
方法将TariffPackage
对象的两个属性(purchaseCostPrice
和resourceCostPrice
)映射到TariffPackageResponse
对象的相应属性,并且这两个属性的值都需要经过转换