如何在MapStruct中高效移除审计字段重复的@Mapping注解

针对Spring环境下MapStruct映射方法中重复编写审计字段（createdAt、updatedAt等）及关联对象字段忽略注解的问题，以下是几种高效简化配置的方案：

1. 用@MapperConfig统一全局忽略规则 #

MapStruct支持通过@MapperConfig定义全局映射配置，所有关联该配置的Mapper都会自动继承这些规则，省去重复编写的麻烦。

步骤： #

1. 创建全局配置接口，集中定义所有需要忽略的字段：

@MapperConfig
public interface AuditIgnoreConfig {
    // 基础实体审计字段忽略
    @Mapping(target = "createdAt", ignore = true)
    @Mapping(target = "updatedAt", ignore = true)
    @Mapping(target = "createdBy", ignore = true)
    @Mapping(target = "modifiedBy", ignore = true)
    @Mapping(target = "id", ignore = true)
    @Mapping(target = "quizzes", ignore = true)
    
    // 关联对象的审计字段忽略
    @Mapping(target = "parentCategory.createdAt", ignore = true)
    @Mapping(target = "parentCategory.updatedAt", ignore = true)
    @Mapping(target = "parentCategory.createdBy", ignore = true)
    @Mapping(target = "parentCategory.modifiedBy", ignore = true)
    @Mapping(target = "parentCategory.id", ignore = true)
    @Mapping(target = "parentCategory.quizzes", ignore = true)
    
    void ignoreAuditFields();
}

2. 在你的Mapper接口中指定该配置，仅保留方法特有的忽略规则：

@Mapper(config = AuditIgnoreConfig.class)
public interface CategoryMapper {
    CategoryDto toDto(final Category category);

    // 无需重复写审计字段忽略注解，自动继承全局配置
    Category toCategory(final CategoryDto categoryDto);

    // 仅添加当前方法额外需要忽略的字段
    @Mapping(target = "parentCategory", ignore = true)
    @Mapping(target = "childCategories", ignore = true)
    Category toDomain(final CategoryCreationRequest categoryCreationRequest);
}

2. 自定义组合注解封装重复配置 #

如果全局配置不适用于所有Mapper（部分Mapper不需要忽略全部字段），可以自定义一个组合注解，把重复的@Mapping打包成一个注解，按需使用。

步骤： #

1. 创建自定义组合注解：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Mappings({
    @Mapping(target = "createdAt", ignore = true),
    @Mapping(target = "updatedAt", ignore = true),
    @Mapping(target = "createdBy", ignore = true),
    @Mapping(target = "modifiedBy", ignore = true),
    @Mapping(target = "id", ignore = true),
    @Mapping(target = "quizzes", ignore = true),
    @Mapping(target = "parentCategory.createdAt", ignore = true),
    @Mapping(target = "parentCategory.updatedAt", ignore = true),
    @Mapping(target = "parentCategory.createdBy", ignore = true),
    @Mapping(target = "parentCategory.modifiedBy", ignore = true),
    @Mapping(target = "parentCategory.id", ignore = true),
    @Mapping(target = "parentCategory.quizzes", ignore = true)
})
public @interface IgnoreAuditFields {
}

2. 在Mapper方法上直接使用该注解：

@Mapper(config = MapperConfiguration.class)
public interface CategoryMapper {
    CategoryDto toDto(final Category category);

    @IgnoreAuditFields
    Category toCategory(final CategoryDto categoryDto);

    @IgnoreAuditFields
    @Mapping(target = "parentCategory", ignore = true)
    @Mapping(target = "childCategories", ignore = true)
    Category toDomain(final CategoryCreationRequest categoryCreationRequest);
}

3. 进阶：基于Spring BeanPostProcessor动态处理 #

如果需要更灵活的全局控制（比如根据实体类上的审计注解自动识别忽略字段），可以自定义BeanPostProcessor，在MapStruct生成的实现类中动态添加忽略规则。不过这种方式复杂度较高，适合需要统一处理所有实体审计字段的场景，前两种方案已经能覆盖大部分常规需求。

内容的提问来源于stack exchange，提问作者Oleksandr Zhytariuk