Java中注解处理器怎么生成 META-INF/services/javax.annotation.processing.Processor 配置文件

浅磊君_4687

浅磊君_4687

2026-10-03

526人浏览

原创

注解处理器注册依赖构建工具在编译打包阶段生成meta-inf/services/javax.annotation.processing.processor文件,而非运行时生成;主流方式是使用autoservice注解自动创建该文件,或通过maven-jar-plugin手动配置服务声明。

java中注解处理器怎么生成 meta-inf/services/javax.annotation.processing.processor 配置文件

注解处理器生成 META-INF/services/javax.annotation.processing.Processor 文件,不是靠注解处理器自己在运行时生成,而是由构建工具(如 Maven 或 Gradle)在编译打包阶段,根据你声明的处理器类自动写入的。关键在于:你得让构建工具“知道”哪个类是处理器,并配置它参与注解处理流程。

确保 Processor 类正确实现并声明

你的处理器类必须:

  • 实现 javax.annotation.processing.Processor 接口(或继承 AbstractProcessor)
  • 提供无参构造方法
  • 在类上用 @SupportedAnnotationTypes 和 @SupportedSourceVersion 声明支持范围(非强制但强烈推荐)
  • 如果是 Java 9+ 模块项目,还需在 module-info.java 中声明 provides javax.annotation.processing.Processor with YourProcessorClass;

用 maven-compiler-plugin 显式注册(推荐方式)

Maven 默认不会自动发现和注册处理器 —— 它需要你明确告诉它:“这个 jar 里包含注解处理器”。做法是在 pom.xml 中配置 maven-compiler-plugin 的 annotationProcessorPaths(用于依赖中的处理器),或更常见的是:把处理器模块本身作为 compile 依赖,并启用 proc:only 或 proc:full。

但真正触发 META-INF/services/... 文件生成的,是 使用 maven-compiler-plugin 的 compilerArgs 配合 -processor 参数,或者更稳妥的方式:用 maven-compiler-plugin + annotationProcessorPaths + forceJavacCompilerUse。不过最直接可控的做法是:

  • 在处理器模块的 pom.xml 中添加 maven-jar-plugin 插件,手动写入服务文件:
<plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-jar-plugin</artifactid><version>3.3.0</version><configuration><archive><manifestentries><automatic-module-name>your.processor.module</automatic-module-name></manifestentries><services><service><type>javax.annotation.processing.Processor</type><provider>com.example.YourProcessor</provider></service></services></archive></configuration></plugin>

这个配置会让 Maven 在打 jar 包时,自动生成 META-INF/services/javax.annotation.processing.Processor,内容就是 com.example.YourProcessor。

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载

用 annotation-processors 插件(简化方案)

如果你不想手写插件配置,可用社区插件 google/auto-service:

  • 添加依赖:com.google.auto.service:auto-service:1.1.1(注意 scope 为 provided)
  • 在你的 Processor 类上加 @AutoService(Processor.class)
  • 编译时 auto-service 会在 target/generated-sources/annotations/ 下生成服务配置文件,并被 jar 插件一并打包进去

这是目前最常用、最省心的方式,无需手动维护路径或插件配置,适合绝大多数项目。

验证生成结果

执行 mvn clean package 后,解压生成的 .jar 文件,检查是否存在:

META-INF/
└── services/
    └── javax.annotation.processing.Processor

该文件内容应为一行纯文本:com.example.YourProcessor(类全限定名,无空格、无空行)。

如果缺失,常见原因有:没加 @AutoService、没配 maven-jar-plugin 服务声明、或 jar 插件被其他插件覆盖导致 META-INF/services 未被包含。

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

相关文章

java速学教程(入门到精通)
java速学教程(入门到精通)

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

下载

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

相关专题

更多
java
java

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

2023.06.15

9617

6

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

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

2023.07.05

6782

9

java自学难吗
java自学难吗

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

2023.07.31

6012

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1276

5

java有什么用
java有什么用

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

2023.08.02

2529

5

java在线网站
java在线网站

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

2023.08.03

19871

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习