MapStruct如何实现属性非null且非空时才执行字段映射
你之前尝试使用的NullValueMappingStrategy、NullValueCheckStrategy、NullValuePropertyMappingStrategy这类内置策略,仅能识别null值场景;空字符串属于非null的字符串实例,不在这几个策略的判定范围内,无法通过调整这几个参数实现需求。可通过以下三种常用方式落地「源属性非null、非空串才映射到目标对象」的逻辑:
方案1:单属性嵌入条件表达式
针对需要校验的单个属性,直接在@Mapping注解中写判断逻辑,精准控制该属性的映射规则,不影响其他属性:
@Mapper public interface StudentMapper { @Mapping( target = "name", // 仅当源name非null、非空/全空白字符串时赋值,否则返回null expression = "java(student.getName() != null && !student.getName().isBlank() ? student.getName() : null)" ) StudentDTO toDTO(Student student); }
这种方式逻辑直观,仅对单个属性生效,可根据需要把isBlank()替换为isEmpty(),适配不同的空值判定标准。
方案2:复用公共判断工具
如果多个映射类都需要做同样的字符串有效性校验,可以把判断逻辑抽成公共静态工具类,在表达式中直接调用,避免重复编写判断逻辑:
// 公共工具类 public class StringFilterUtil { public static String filterValid(String source) { return source != null && !source.isBlank() ? source : null; } }
// 引入工具类的Mapper @Mapper(uses = StringFilterUtil.class) public interface StudentMapper { @Mapping( target = "name", expression = "java(StringFilterUtil.filterValid(student.getName()))" ) StudentDTO toDTO(Student student); }
方案3:使用命名限定符(@Named)实现类型安全的映射
如果不想编写硬编码形式的Java表达式,可以在Mapper接口内定义带@Named注解的默认转换方法,映射时指定使用该方法处理目标属性。这种方式可以获得IDE的语法校验、类型提示支持,避免字符串表达式写错的问题:
@Mapper public interface StudentMapper { // 定义命名限定的字符串过滤方法 @Named("filterValidString") default String filterValidString(String source) { if (source == null || source.isBlank()) { return null; } return source; } // 指定用上述方法处理name属性 @Mapping( target = "name", qualifiedByName = "filterValidString" ) StudentDTO toDTO(Student student); }
补充说明:如果你的映射场景是更新已存在的目标对象(即存在
@MappingTarget标记的入参),想要实现「源值无效时不覆盖目标属性的原有值」,可以在类上补充配置nullValuePropertyMappingStrategy = NullValuePropertyMappingStrategy.IGNORE,当判断逻辑返回null时,MapStruct会自动跳过对目标属性的赋值,不会覆盖原有值。
内容的提问来源于stack exchange,提问作者Ravi

