在之前章节的例子中&＃xff0c;我们在接收参数的时候都是使用的 User 类对象&＃xff0c;这是一个 DO 对象&＃xff0c;是用于与数据库进行交互的&＃xff0c;而不是用于与前端业务进行交互的&＃xff0c;所以需要创建一个 BO 业务对象用来与前端业务进行交互&＃xff0c;保证数据隔离性及安全性。

接收参数换成了 BO 对象&＃xff0c;但数据入库使用的是 DO 对象&＃xff0c;这中间就需要将 BO 对象的属性复制到 DO 对象&＃xff0c;然后代码里就会出现大量的 do.set(bo.get())&＃xff0c;这让代码显得臃肿&＃xff0c;繁琐。当然&＃xff0c;通过反射或者是使用 Spring 提供的 BeanUtils.copyProperties() 等方法也可以达到简化代码的效果&＃xff0c;但是在效率方面不尽如人意。

而 MapStruct 则提供了一种高效的解决方案&＃xff0c;其实现方式是在编译期&＃xff0c;自动生成相关的 do.set(bo.get()) 代码&＃xff0c;所以&＃xff0c;在运行期实际上就是直接调用原生的get/set 方法。

相关知识

MapStruct官网&＃xff1a;http://mapstruct.org

课程目标

SpringBoot 整合 MapStruce 以及 Lombok

操作步骤

本文使用 Idea 集成开发环境

环境准备

安装 MapStruce 插件

File -> settings&＃xff0c;打开 Idea 的设置界面&＃xff0c;从左侧栏选择 Plugins 选项&＃xff0c;再在右侧查询 MapStruce&＃xff0c;点击安装。

设置IDE

File -> Settings 打开设置界面&＃xff0c;

选择 Build,Execution,Deployment -> Compiler -> Annotation Processors 进入设置界面&＃xff0c;

勾选 enable annotation processing

添加依赖

添加 mapstruct 的依赖

​

同时整合 Lombok&＃xff0c;添加对 Lombok 的依赖

​

添加 mapstruct 的插件依赖&＃xff0c;同时配置 Lombok

​

编码

编写 DTO 类&＃xff0c;用于接收前端入参

​

编写 Mappering 转换器

• 类上添加 &＃64;Mapper 注解&＃xff0c;用于项目启动时自动加载
• 方法上添加 &＃64;Mapping 注解&＃xff0c;用于设置转换规则&＃xff0c;source 设置源对象属性&＃xff0c;target 设置目标对象属性&＃xff0c;如果源对象属性名与目标对象属性名一致&＃xff0c;则无需设置&＃xff0c;在本例中&＃xff0c;我们需要将 UserBO 对象的 mobile 属性复制至 User 对象的 name 属性中
• 设置常量 INSTANCE&＃xff0c;用于其它方法调用&＃xff0c;也可以通过 Spring 的 IOC 进行注入

​

编写 controller 接口

​

源码地址

本章源码 : https://github.com/caiyuanzi-song/boot.git

总结

MapStruct 释放掉大量的属性复制的代码&＃xff0c;改为编译时自动生成&＃xff0c;所以只是精简了项目代码。

注意

项目编译后&＃xff0c;UserMapper 接口会在 target 目录的相应路径下生成一个 class 实现类&＃xff0c;通过查看该实现类&＃xff0c;可以看到实际生成的代码结构。但是&＃xff0c;在编码过程中&＃xff0c;如果修改了 UserMapper 接口内容&＃xff0c;Idea 有时并不会重新编译&＃xff0c;导致最新的修改无法生效&＃xff0c;必须得先对项目执行一次 clean 操作&＃xff0c;清除掉 class 实现类&＃xff0c;再次启动时就会重新编译。