Java 中注解怎么通过自定义注解处理器(Processor)在编译期输出警告日志

大婷同学_6398

大婷同学_6398

2026-07-28

927人浏览

原创

java自定义注解处理器通过继承abstractprocessor并在init()中获取messager,于process()中调用printmessage输出编译期警告;需在meta-inf/services/下注册、用@supportedannotationtypes声明支持注解,并通过roundenvironment获取被注解元素进行条件判断。

java 中注解怎么通过自定义注解处理器(processor)在编译期输出警告日志

Java 中自定义注解处理器(Processor)可以在编译期通过 Messager 输出警告日志,无需运行时干预,也不依赖第三方日志框架。

注册并继承 AbstractProcessor

创建一个类继承 javax.annotation.processing.AbstractProcessor,重写 init() 和 process() 方法。在 init() 中获取 Messager 实例,它是编译器提供的消息输出工具。

  • Messager 是编译器注入的,只能在 init() 后使用
  • 必须在 resources/META-INF/services/javax.annotation.processing.Processor 文件中声明全限定类名,否则编译器不会加载该处理器
  • 推荐添加 @SupportedAnnotationTypes 注解,显式声明支持哪些注解,避免无谓触发

用 Messager.printMessage 输出警告

在 process() 方法中,调用 messager.printMessage(Diagnostic.Kind.WARNING, "警告内容", element) 即可输出编译期警告。其中:

  • Diagnostic.Kind.WARNING 表示警告级别(非错误,不中断编译)
  • 第二个参数是警告文本,支持普通字符串或格式化(如 String.format 拼接)
  • 第三个参数是关联的 Element(如被标注的类、方法),能让警告准确定位到源码位置

例如:对带有 @DeprecatedApi 注解的方法,输出 "该 API 已废弃,请改用 XxxService.doSomething()",IDE 和命令行编译都会显示带行号的黄色警告。

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载

获取被注解元素并做条件判断

通过 RoundEnvironment 的 getElementsAnnotatedWith() 获取所有匹配注解的元素,再逐个检查是否满足警告条件:

  • 可用 element.getKind() 判断是类、方法还是字段
  • 用 element.getSimpleName() 或 element.asType() 提取名称或类型信息
  • 结合 element.getAnnotationMirrors() 可读取注解属性值(如 @WarnOn("v2.0") 中的版本号)

这样就能实现“仅当方法返回类型为 void 且标注了 @Dangerous 时才发出警告”这类精细控制。

编译时启用并验证效果

确保构建工具能识别注解处理器:

  • Maven 项目需将处理器模块作为 compile 依赖,并配置 maven-compiler-plugin 的 annotationProcessorPaths
  • Gradle 使用 annotationProcessor 或 compileOnly + processor 配置
  • 命令行编译需用 javac -processor YourProcessor ... 显式指定

成功后,修改源码触发重新编译,警告会出现在编译日志中,且 IDE(如 IntelliJ)会在对应代码行下方标黄提示,点击可跳转。

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

相关文章

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

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

下载

相关标签:

java mysql java开发 处理器

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

相关专题

更多
java
java

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

2023.06.15

9237

6

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

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

2023.07.05

6402

9

java自学难吗
java自学难吗

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

2023.07.31

5732

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

848

3

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

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

2023.08.02

1216

5

java有什么用
java有什么用

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

2023.08.02

2429

5

java在线网站
java在线网站

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

2023.08.03

19791

3

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

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

2023.08.03

1095

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习