Java中 MapStruct @Mapping 注解怎么通过编译期注解处理器生成代码

夜瑶酱_6722

夜瑶酱_6722

2026-07-14

1032人浏览

原创

mapstruct 的 @mapping 注解仅声明映射元数据,真正生成代码的是编译期注解处理器;该处理器扫描 @mapper 接口,依据 @mapping 配置生成类型安全的实现类,如 usermapperimpl,并支持字段自动匹配、表达式调用及 spring 集成。

java中 mapstruct @mapping 注解怎么通过编译期注解处理器生成代码

MapStruct 的 @Mapping 注解本身不直接生成代码,它只是声明式配置;真正生成映射代码的是 MapStruct 提供的编译期注解处理器(Annotation Processor),在 javac 编译阶段自动运行,扫描带有 @Mapper 的接口并根据 @Mapping 等注解生成具体的实现类。

注解处理器如何被触发

MapStruct 依赖标准的 Java 注解处理机制。只要项目中正确引入了 MapStruct 的 processor 依赖(如 mapstruct-processor),并在构建工具中启用注解处理,javac 就会在编译时自动发现并调用 MapStruct 的 MapperProcessor。

  • Maven 中需确保 mapstruct-processor 在 compile 范围(或通过 annotationProcessorPaths 显式配置)
  • IDE(如 IntelliJ 或 Eclipse)需开启“Enable annotation processing”,否则可能看不到生成的代码或报错
  • 生成的实现类默认放在 target/generated-sources/annotations(Maven)或类似路径下,属于编译源码的一部分

@Mapping 是如何参与代码生成的

@Mapping 本身不带逻辑,只提供元数据:比如指定源字段名、目标字段名、转换方式、默认值或忽略规则。注解处理器读取这些信息后,结合 @Mapper 接口定义的映射方法签名,拼装出类型安全的 Java 赋值和转换逻辑。

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
  • 例如 @Mapping(source = "userName", target = "name") → 生成 target.setName(source.getUserName());
  • @Mapping(target = "status", expression = "java(com.example.StatusMapper.toStatus(source.getState()))") → 插入对应表达式调用
  • 未显式配置的字段,处理器按名称自动匹配(驼峰转换),也可通过 @BeanMapping 控制策略

为什么必须用 interface + @Mapper

MapStruct 要求映射逻辑定义在 interface 上,并标注 @Mapper,因为注解处理器只扫描满足条件的接口:它是基于接口契约生成实现类(而非修改原有类)。生成的类是普通 Java 类,实现了该接口,且可被 Spring 等框架直接注入(配合 @Mapper(componentModel = "spring"))。

  • 不能对 class 使用 @Mapper —— 这不是 MapStruct 的设计模型
  • 生成类名默认为接口名 + “Impl”,如 UserMapper → UserMapperImpl
  • 所有 @Mapping 必须位于被 @Mapper 标记的接口内,否则会被忽略

常见编译失败原因和检查点

如果没看到生成代码或编译报错,通常不是 @Mapping 写错了,而是注解处理环节未就绪:

  • 依赖缺失:只有 mapstruct 运行时依赖,没加 mapstruct-processor 编译依赖
  • Lombok 干扰:若实体类用了 @Data 等 Lombok 注解,需确保 Lombok 的 processor 在 MapStruct 之前执行(Maven 中顺序重要,IDE 中需启用 Lombok 支持)
  • 字段类型不匹配且无隐式转换:如 source 是 String,target 是 LocalDate,又没配 @Mapper#uses 或 @Named 转换器,处理器会报错而非静默跳过

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

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

2023.06.15

10457

6

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

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

2023.07.05

7582

9

java自学难吗
java自学难吗

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

2023.07.31

6632

8

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

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

2023.08.01

1144

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

1376

5

java有什么用
java有什么用

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

2023.08.02

2749

5

java在线网站
java在线网站

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

2023.08.03

20071

3

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

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

2023.08.03

1215

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习