讲师中心 微信公众号
AI工具推荐 视频效率加速

MapStruct 中高效忽略审计字段:自定义注解消除重复 @Mapping

陌杰大大_5912

陌杰大大_5912

发布时间:2026-07-07 21:09:45

|

558人浏览过

|

来源于php中文网

原创

MapStruct 中高效忽略审计字段:自定义注解消除重复 @Mapping

本文介绍如何通过自定义复合注解(如 @ignoreauditmapping)统一管理 createdat、updatedat、createdby、modifiedby 等通用审计字段的忽略逻辑,避免在多个 mapstruct 映射方法中重复书写冗长的 @mapping(ignore = true) 声明,显著提升代码可维护性与可读性。

本文介绍如何通过自定义复合注解(如 @ignoreauditmapping)统一管理 createdat、updatedat、createdby、modifiedby 等通用审计字段的忽略逻辑,避免在多个 mapstruct 映射方法中重复书写冗长的 @mapping(ignore = true) 声明,显著提升代码可维护性与可读性。

在使用 MapStruct 构建 Spring 应用时,实体类常包含审计字段(如 createdAt、updatedAt、createdBy、modifiedBy),这些字段通常由 JPA 或 Spring Data Audit 自动填充,不应由 DTO 或请求对象反向映射。但若每个 @Mapping 方法都显式声明十余个 @Mapping(target = "xxx", ignore = true),不仅代码臃肿,还极易因遗漏或拼写错误导致安全漏洞(如意外覆盖 id 或审计时间)。

✅ 推荐方案:自定义组合注解(Composed Annotation)
MapStruct 原生支持将多个 @Mapping 注解封装为一个自定义注解——这是最简洁、类型安全且 IDE 友好的方式。只需定义一次,即可复用于任意映射方法:

// 审计字段统一忽略注解
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Mapping(target = "createdAt", ignore = true)
@Mapping(target = "updatedAt", ignore = true)
@Mapping(target = "createdBy", ignore = true)
@Mapping(target = "modifiedBy", ignore = true)
public @interface IgnoreAuditMapping {}

⚠️ 注意:该注解必须标注 @Retention(RUNTIME),否则 MapStruct 在运行时无法读取元数据;同时需确保 @Mapping 的 target 字段名与实际 POJO 属性严格一致(区分大小写,支持点号路径如 "parentCategory.createdAt")。

接着,在 Mapper 接口中直接应用该注解,并按需补充其他特例忽略项:

@Mapper(config = MapperConfiguration.class)
public interface CategoryMapper {

    CategoryDto toDto(Category category);

    @IgnoreAuditMapping
    @Mapping(target = "id", ignore = true)
    @Mapping(target = "quizzes", ignore = true)
    // 支持嵌套路径(自动继承 IgnoreAuditMapping 中的 parentCategory.*)
    @Mapping(target = "parentCategory.id", ignore = true)
    @Mapping(target = "parentCategory.quizzes", ignore = true)
    Category toCategory(CategoryDto categoryDto);

    @IgnoreAuditMapping
    @Mapping(target = "id", ignore = true)
    @Mapping(target = "quizzes", ignore = true)
    @Mapping(target = "parentCategory", ignore = true)       // 全量忽略 parentCategory 对象
    @Mapping(target = "childCategories", ignore = true)
    Category toDomain(CategoryCreationRequest request);
}

? 进阶技巧:扩展可复用性

  • 若不同模块审计字段略有差异(如部分实体含 deletedAt 或 version),可定义多组注解:@IgnoreBaseAuditMapping、@IgnoreFullAuditMapping;
  • 结合 @InheritConfiguration 实现配置继承,适用于需差异化处理 target 的场景(例如某些方法需映射 id 但忽略其余审计字段);
  • 配合 MapStruct 的 @MapperConfig 全局配置,可统一设置 unmappedTargetPolicy = ReportingPolicy.IGNORE,避免未映射字段报错(但不替代语义明确的 ignore = true)。

✅ 总结
使用自定义组合注解是解决 MapStruct 中审计字段重复忽略问题的最优实践:它零侵入、零反射开销、完全兼容编译期代码生成,且天然支持 IDE 自动补全与静态检查。相比抽象父接口或手动编写 @AfterMapping 方法,该方案更轻量、更直观、更易测试与维护。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

10297

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

7422

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6512

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1124

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

928

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1356

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2709

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20031

2023.08.03

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

60

2026.10.10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
零基础精通 PS 视频教程
零基础精通 PS 视频教程

共268课时 | 119.6万人学习

前端工程师必备技能—PS切图
前端工程师必备技能—PS切图

共11课时 | 2.2万人学习

麦子学院Photoshop切片视频教程
麦子学院Photoshop切片视频教程

共13课时 | 4.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn