MapStruct最佳实践

本文将以一个中级Java开发者角度,探讨如何整合Spring Conversion Service、MapStruct Spring Extensions和Lombok三个常用框架,以最少的代码和配置,完成复杂对象转换工作。

👉你将学会:

  • 如何将对象转换逻辑从接口代码剥离;

  • 如何灵活地注册Spring对象转换器;

  • 如何使用MapStruct作为转换器的底层实现;

  • 如何使用自己的BeanUtil实现兜底策略。

版本限制

  • Java 17
  • SpringBoot 3.1.x
  • Lombok 1.18.x
  • MapStruct 1.5.5 Final

Maven依赖配置

Lombok和MapStruct都是非常优秀的类库,能够极大提升开发效率,两者实现原理差不多,都是编译期间生成代码。
MapStruct Spring Extensions是MapStruct基于Spring框架的扩展,自动将Mapper注册为Converter。

  <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.30</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>org.mapstruct</groupId>
            <artifactId>mapstruct</artifactId>
            <version>1.5.5.Final</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok-mapstruct-binding</artifactId>
            <version>0.2.0</version>
        </dependency>

        <dependency>
            <groupId>org.mapstruct.extensions.spring</groupId>
            <artifactId>mapstruct-spring-annotations</artifactId>
            <version>1.1.0</version>
        </dependency>
  </dependencies>

Maven插件配置

 <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.11.0</version>
                    <configuration>
                        <annotationProcessorPaths>
                            <path>
                                <groupId>org.projectlombok</groupId>
                                <artifactId>lombok</artifactId>
                                <version>1.18.30</version>
                            </path>
                            <path>
                                <groupId>org.mapstruct</groupId>
                                <artifactId>mapstruct-processor</artifactId>
                                <version>1.5.5.Final</version>
                            </path>
                            <path>
                                <groupId>org.projectlombok</groupId>
                                <artifactId>lombok-mapstruct-binding</artifactId>
                                <version>0.2.0</version>
                            </path>
                            <path>
                                <groupId>org.mapstruct.extensions.spring</groupId>
                                <artifactId>mapstruct-spring-extensions</artifactId>
                                <version>1.1.0</version>
                            </path>
                        </annotationProcessorPaths>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>

MapStruct配置

@MapperConfig注解可以配置一些对象转换过程中的公用配置,比如忽略目标对象中不存在的属性,需要做如下配置:

@MapperConfig(
    componentModel = "spring",
    unmappedTargetPolicy = ReportingPolicy.IGNORE
)
public interface DefaultConverterConfig {
}

对象转换器

以下是一个常见的数据字典转换器,实现了Entity/DTO互相转换,并自动注册为Spring Converter:

@Mapper(config = DefaultConverterConfig.class)
public interface DictDataToDictDataDtoConverter extends Converter<DictData, DictDataDto> {

    @InheritInverseConfiguration
    @DelegatingConverter
    DictData invertConvert(DictDataDto dto);

    @AfterMapping
    default void postMapping(DictData entity, @MappingTarget DictDataDto dto) {
        // do something
    }

    @AfterMapping
    default void postMapping(DictDataDto dto, @MappingTarget DictData entity) {
        // do something
    }
}

执行编译命令后会自动生成DictDataToDictDataDtoConverter.class和反向的DictDataDtoToDictDataConverter.class
当然了,你也可以根据需要自行添加XxxToXxxVoConverter或者XxxToXxxBoConverter等各种转换器。

转换方法

    @Autowired
    private ConversionService conversionService;

    protected <T> T convert(Object source, Class<T> targetType) {
        // 如果没有配置转换器则使用BeanUtil兜底
        return conversionService.canConvert(source.getClass(), targetType) ? conversionService.convert(source, targetType) : BeanUtil.copyProperties((source, targetType);
    }

    @SuppressWarnings("unchecked")
    protected <T> List<T> convertAll(@Nullable List<?> sourceList, Class<T> targetType) {
        return conversionService.canConvert(sourceList.get(0).getClass(), targetType)
            ? (List<T>) conversionService.convert(sourceList, TypeDescriptor.forObject(sourceList), TypeDescriptor.collection(List.class, TypeDescriptor.valueOf(targetType)))
            : BeanUtil.copyToList(sourceList, targetType);
    }

以上两个方法是通用的,可以根据需要,放到BaseController或者BaseService里面。
注意:BeanUtil来自Hutool,也可以替换成自己的工具类。

接口实例

如此一来,我们便可以愉快的调用convert()方法,而不用关心目标对象到底是个什么O了🙂

@RestController
@RequestMapping("/dict")
public class DictDataController extends BaseController {
    @Autowired
    private DictDataService dictDataService;

    @GetMapping
    public Result<DictDataDto> doQuery(@RequestParam Long id) {
        DictData entity = dictDataService.getById(id);
        return Result.success(convert(entity, DictDataDto.class));
    }
}

--- THE END ---

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容