首页
/ MapStruct中conditionQualifiedByName与@Condition注解的正确使用

MapStruct中conditionQualifiedByName与@Condition注解的正确使用

2025-05-30 05:16:26作者:姚月梅Lane

MapStruct是一个强大的Java对象映射框架,它通过注解处理器自动生成类型安全的bean映射代码。在使用过程中,开发者可能会遇到条件映射的问题,特别是conditionQualifiedByName@Condition注解的配合使用。

问题背景

在MapStruct中,@Mapping注解提供了conditionQualifiedByName属性,用于指定一个条件方法来判断是否应该执行该映射。然而,很多开发者在使用时发现条件判断没有生效,生成的代码中仍然包含了无条件的映射语句。

根本原因

通过分析发现,要使conditionQualifiedByName生效,必须满足两个关键条件:

  1. 条件方法必须同时使用@Named注解进行标记
  2. 条件方法还必须使用@Condition注解进行标记

缺少任何一个注解都会导致条件判断逻辑不被MapStruct处理器识别和生成。

正确用法示例

public class BaseMapper {
    @Condition
    @Named("isStringNotNullOrEmpty")
    public boolean isStringNotNullOrEmpty(String input) {
        return StringUtils.isNotEmpty(input);
    }
}
@Mapper
public abstract class EmployeeMapper extends BaseMapper {
    @Mappings({
        @Mapping(source="gender", target="gender", 
                conditionQualifiedByName="isStringNotNullOrEmpty", 
                qualifiedByName="toGender")
    })
    public abstract Target transformSource(Source employee);
}

生成代码分析

正确配置后,MapStruct生成的代码会包含条件判断逻辑:

public class Target extends EmployeeMapper {
    @Override
    public Target transformSource(Source employee) {
        if (employee == null) {
            return null;
        }

        Target.Builder target = Target.newBuilder();
        if (isStringNotNullOrEmpty(employee.getGender())) {
            target.gender(toGender(employee.getGender()));
        }

        return target.build();
    }
}

常见误区

  1. 仅使用@Named注解:很多开发者只添加了@Named注解而忽略了@Condition注解,导致条件判断不生效
  2. 方法签名不匹配:条件方法必须返回boolean类型,且参数类型与源字段类型匹配
  3. 继承关系问题:当条件方法定义在父类中时,确保子类mapper正确继承

最佳实践

  1. 对于复杂的条件判断,建议将条件方法集中定义在基础mapper类中
  2. 使用有意义的条件方法名称,提高代码可读性
  3. 在团队项目中,建立统一的命名规范,避免命名冲突
  4. 编写单元测试验证条件映射的正确性

通过正确理解和使用conditionQualifiedByName@Condition注解的组合,开发者可以更灵活地控制MapStruct的映射行为,生成更加健壮和高效的映射代码。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
595
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K