如何借助Lombok生成MapStruct源存在校验实现REST接口DTO部分更新
适配Lombok与MapStruct源存在校验能力的实现方案
核心规则说明
- MapStruct识别源存在校验逻辑的规则非常明确:对于源对象里叫
x的字段,会自动找类里签名为boolean isXPresent()的方法。只要这个方法存在,就不再走默认的非null判断逻辑,而是用这个方法的返回值做判断:返回true就把源字段的值(哪怕是null)映射到目标对象,返回false就直接跳过这个字段的映射 - 如果类里找不到对应的存在校验方法,MapStruct才会用默认逻辑:只有源字段的值不是null,才执行字段映射
自动生成源存在校验方法的落地路径
既然项目已经用Lombok生成getter和setter,完全没必要手动在每个DTO里写一堆isXxxPresent()方法,借助Lombok的注解处理扩展能力,完全可以在编译期自动生成符合MapStruct要求的校验方法,具体步骤:
1. 先做一个简单的标记注解
创建一个只在源码编译阶段生效的注解,用来标记哪些DTO字段需要自动生成存在校验逻辑:
@Target(ElementType.FIELD) @Retention(RetentionPolicy.SOURCE) public @interface RequiredPresenceCheck {}
2. 扩展Lombok的注解处理插件
Lombok本身是在编译期操作抽象语法树来生成代码的,我们可以扩展它的AST遍历逻辑,在编译期自动完成这些事:
- 给每个被
@RequiredPresenceCheck标记的字段,在所属的DTO类里自动加一个对应的布尔标记位,比如对应name字段,就自动生成私有属性private boolean namePresenceFlag = false; - 修改Lombok原本为这个字段生成的setter方法,在正常给字段赋值的同时,自动把对应的标记位改成
true - 自动生成符合MapStruct命名要求的存在校验方法,方法体就直接返回对应的标记位值,比如
public boolean isNamePresent() { return namePresenceFlag; }
所有逻辑都在编译期完成,不会给运行时增加额外开销,业务代码完全不需要感知这些标记位的存在。
3. 业务代码正常编写即可
DTO类还是沿用原来的写法,搭配Lombok的@Data注解生成getter/setter,只需要给需要支持部分更新的字段加上自定义的标记注解,完全不用手写任何校验方法:
@Data public class UserUpdateDTO { @RequiredPresenceCheck private String name; @RequiredPresenceCheck private Integer age; @RequiredPresenceCheck private String email; }
MapStruct的映射接口也不需要加额外配置,会自动识别生成的存在校验方法,实现精准的部分更新:
@Mapper public interface UserMapper { // 自动根据存在标记判断是否更新对应字段 void updateEntityFromDto(UserUpdateDTO dto, @MappingTarget User user); }
落地避坑点
- 生成的校验方法命名必须严格匹配MapStruct的规则:
is+ 字段名(首字母大写) +Present,不然MapStruct识别不到,还是会走原来的非null判断逻辑,达不到部分更新的效果 - 配置好注解处理器的执行顺序:要保证Lombok的处理器比MapStruct的处理器先执行,不然MapStruct在解析代码的时候还看不到Lombok生成的校验方法,会出现功能失效的问题
- 别在业务代码里手动维护这些存在标记位,所有标记位的赋值逻辑都交给编译期插件自动处理,不然新增字段的时候很容易漏改,反而增加冗余代码
内容的提问来源于stack exchange,提问作者Denis Kokorin
相关产品推荐
相关产品推荐

