Java 基础中注解怎么通过元注解自定义编译期标记

阿萱小哥_9433

阿萱小哥_9433

2026-09-03

951人浏览

原创

自定义编译期标记注解需设@retention为source或class、@target限定作用位置,并配合apt处理器实现编译时校验或代码生成;不应用runtime,推荐加@documented和javadoc。

java 基础中注解怎么通过元注解自定义编译期标记

自定义编译期标记注解,核心是让注解只在源码或 class 文件阶段存在,运行时不可见,且不依赖反射处理——这类注解通常用于编译器检查或 APT(Annotation Processing Tool)生成代码。

@Retention 设为 SOURCE 或 CLASS

这是决定“编译期标记”属性的关键。必须明确指定保留策略:

  • SOURCE:注解仅保留在 .java 源文件中,编译后彻底丢弃。适合纯编译检查类场景,如自定义 @NonNullCheck、@ApiVersion 等,由注解处理器在编译时校验并报错。
  • CLASS(默认值):注解写入 .class 文件,但 JVM 加载时不保留,运行时无法通过反射获取。适合需要构建工具(如 Gradle/Maven 插件)或字节码增强工具(如 Byte Buddy)读取的场景。

不要用 RUNTIME,否则就不是“编译期标记”,而是运行时注解了。

@Target 明确限定作用位置

告诉编译器这个标记能加在哪。常见组合有:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载
  • ElementType.METHOD:标记某个方法需做参数非空校验
  • ElementType.PARAMETER:标记方法参数不可为 null
  • ElementType.TYPE:标记整个类属于某个 API 版本
  • ElementType.PACKAGE:配合 package-info.java 使用,标记整个包的特性(如 @DeprecatedPackage)

避免宽泛设置,比如只用于方法就别写 @Target({TYPE, METHOD, FIELD}),否则容易误用。

搭配注解处理器(APT)实现真正功能

编译期注解本身不执行逻辑,必须靠 APT 在 javac 编译过程中扫描并响应:

  • 编写一个继承 AbstractProcessor 的处理器类
  • 在 process() 方法中遍历被该注解标记的元素,做校验、生成辅助类、输出警告或错误
  • 通过 Messager 输出编译期提示(warning / error),例如:messager.printMessage(Diagnostic.Kind.ERROR, "@ApiV2 不能用于私有方法", element);
  • 在 resources/META-INF/services/javax.annotation.processing.Processor 中声明处理器全类名

典型例子:Lombok 的 @Data、@Builder 就是靠 APT 在编译期生成 getter/setter/构造器代码;Android 的 ButterKnife 早期也用 APT 生成绑定代码。

可选但推荐:加上 @Documented 和清晰 Javadoc

虽然不影响编译行为,但能提升协作体验:

  • @Documented:确保该注解出现在生成的 JavaDoc 中,方便团队成员查阅用途
  • 为注解类写明 Javadoc,说明适用场景、约束条件、典型误用示例
  • 注解元素尽量设合理默认值(如 String value() default "";),减少使用时冗余写法

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

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

8997

6

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

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

2023.07.05

6182

9

java自学难吗
java自学难吗

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

2023.07.31

5552

8

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

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

2023.08.01

1004

3

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

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

2023.08.02

828

3

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

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

2023.08.02

1176

5

java有什么用
java有什么用

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

2023.08.02

2389

5

java在线网站
java在线网站

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

2023.08.03

19711

3

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

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

2023.08.03

1075

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习