安利通过Mapstruct这个神器,它可以代替来
BeanUtil
进行DTO、VO、PO之间的转换。它使用的是 Java 编译期的注释处理器机制,说白了它是一个代码生成器,而不是你手动进行类型转换期间的取值操作。
它给项目都使用了很多新鲜的代码,之前发现了很多鱼的时间,用过的好。
- @Mapper(componentModel = "spring")
- public interface AreaMapping {
-
- List<AreaInfoListVO> toVos(List<Area> areas);
- }
就这么几行把一个PO的集合变成了VO的集合。
- // spring bean
- @Autowired
- AreaMapping areaMapping
-
- // 转换源 areas
- List<Area> areas = ……;
- // 转换目标 vos
- List<AreaInfoListVO> vos = areaMapping.toVos(areas)
换成你手写,起码得五分炷香的尝试。
这样写还是爽,每次都要挂的Mapper类。
Spring框架提供了一个Converter<S,T>
接口:
- @FunctionalInterface
- public interface Converter<S, T> {
- @Nullable
- T convert(S source);
-
- default <U> Converter<S, U> andThen(Converter<? super T, ? extends U> after) {
- Assert.notNull(after, "After Converter must not be null");
- return (s) -> {
- T initialResult = this.convert(s);
- return initialResult != null ? after.convert(initialResult) : null;
- };
- }
- }
它的作用而转换为,这和 Mapstruct的S
作用不谋而合。T
Converter
会通过ConverterRegistry
这个注册接口注册到ConversionService
,然后你就可以通过什么ConversionService
方法convert
来进行转换:
<T> T convert(@Nullable Object source, Class<T> targetType);
根据各项机制官方推出的Spring Extensions插件,它的自动映射结构映射接口(Mapper)实现了,我们只需要通过Map 实现全部Converter
到任何转换操作即可。ConversionService
ConversionService
- /**
- * @author felord.cn
- * @since 1.0.0
- */
- @Mapper(componentModel = "spring")
- public interface CarMapper extends Converter<Car, CarDto> {
-
- @Mapping(target = "seats", source = "seatConfiguration")
- CarDto convert(Car car);
- }
调用时:
- @Autowired
- private ConversionService conversionService;
-
- Car car = ……;
- CarDto carDto = conversionService.convert(car,CarDto.class);
MapStructs会自动生成一个类型的处理Mapper注册:
- package org.mapstruct.extensions.spring.converter;
-
- import cn.felord.mapstruct.entity.Car;
- import cn.felord.mapstruct.entity.CarDto;
- import org.springframework.context.annotation.Lazy;
- import org.springframework.core.convert.ConversionService;
- import org.springframework.stereotype.Component;
- /**
- * @author felord.cn
- * @since 1.0.0
- */
- @Component
- public class ConversionServiceAdapter {
- private final ConversionService conversionService;
-
- public ConversionServiceAdapter(@Lazy final ConversionService conversionService) {
- this.conversionService = conversionService;
- }
-
- public CarDto mapCarToCarDto(final Car source) {
- return (CarDto)this.conversionService.convert(source, CarDto.class);
- }
- }
在这种情况下,如果你希望包的类型将在org.mapstruct.extensions.spring.converter
中,名称固定为。ConversionServiceAdapter
- package cn.felord.mapstruct.config;
-
- import org.mapstruct.MapperConfig;
- import org.mapstruct.extensions.spring.SpringMapperConfig;
-
- /**
- * @author felord.cn
- * @since 1.0.0
- */
- @MapperConfig(componentModel = "spring")
- @SpringMapperConfig(conversionServiceAdapterPackage = "cn.felord.mapstruct.config",
- conversionServiceAdapterClassName = "MapStructConversionServiceAdapter")
- public class MapperSpringConfig {
- }
不指定
conversionServiceAdapterPackage
元素,所以的 Adapter 类将注释的配置与生成相同的一个包中,上面的路径是可以这样的。
如果你的Spring IoC包含多个参数ConversionService
,你可以通过@SpringMapperConfig
注解的conversionServiceBeanName
指定。
- package cn.felord.mapstruct.config;
-
- import org.mapstruct.MapperConfig;
- import org.mapstruct.extensions.spring.SpringMapperConfig;
-
- /**
- * @author felord.cn
- * @since 1.0.0
- */
- @MapperConfig(componentModel = "spring")
- @SpringMapperConfig(conversionServiceAdapterPackage = "cn.felord.mapstruct.config",
- conversionServiceAdapterClassName = "MapStructConversionServiceAdapter",
- conversionServiceBeanName = "myConversionService")
- public class MapperSpringConfig {
- }
Spring提供了很多好用的实现,内部Converter<S,T>
没有直接开放,如果你想用Mapstruct的机制使用它们,可以通过@SpringMapperConfig
注解externalConversions
注册它们。
- @MapperConfig(componentModel = "spring")
- @SpringMapperConfig(
- externalConversions = @ExternalConversion(sourceType = String.class, targetType = Locale.class))
- public interface MapstructConfig {}
会在中自动生成相应的转换
- @Component
- public class ConversionServiceAdapter {
- private final ConversionService conversionService;
-
- public ConversionServiceAdapter(@Lazy final ConversionService conversionService) {
- this.conversionService = conversionService;
- }
-
- public Locale mapStringToLocale(final String source) {
- return conversionService.convert(source, Locale.class);
- }
- }
它的mapstruct-spring-annotations开发人员通过ConversionService
使用定义的Mapstruct映射器,而必须允许单独导入每个Mapper,并引导Mapper之间的松散连接。它本身不会影响Mapstruct的机制。