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

陌杰大大_5912

陌杰大大_5912

2026-07-07

558人浏览

原创

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")。

Playground AI
Playground AI

一款集AI图像生成和图片编辑于一体的视觉创作工具,帮助用户制作、修改和组合图片,适合多种创意设计任务。

下载

接着,在 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 方法,该方案更轻量、更直观、更易测试与维护。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10317

6

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

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

2023.07.05

7442

9

java自学难吗
java自学难吗

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

2023.07.31

6512

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1356

5

java有什么用
java有什么用

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

2023.08.02

2709

5

java在线网站
java在线网站

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

2023.08.03

20031

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1195

8

热门下载

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

精品课程

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

共268课时 | 119.6万人学习

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

共11课时 | 2.2万人学习

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

共13课时 | 4.3万人学习