怎么利用元注解Target与Retention限定自定义注解的范围

老晨君_2246

老晨君_2246

2026-04-07

788人浏览

原创

@Target指定注解适用位置,@Retention控制保留阶段;必须显式声明二者,否则易致反射失效或编译报错。

怎么利用元注解target与retention限定自定义注解的范围

Target 指定注解能加在哪些地方

注解不是随便往哪都能贴的——@Target 就是干这个事的。它用 ElementType 枚举值控制生效位置,比如你写了个校验注解,只允许用在字段上,那必须显式声明 @Target(ElementType.FIELD),否则 IDE 可能不报错,但运行时反射拿不到,或者被误用在方法上导致逻辑错乱。

常见组合示例:

  • @Target({ElementType.METHOD, ElementType.FIELD}):既可用于 getter 方法,也可用于实体字段
  • @Target(ElementType.TYPE):只能加在类、接口、枚举上(比如标记某个模块的入口)
  • @Target(ElementType.PARAMETER):专用于方法参数(常配合 AOP 或参数解析器)

漏写 @Target 不会编译失败,但默认等价于 @Target(ElementType.ANNOTATION_TYPE)(即只能标注其他注解),这几乎不是你想要的。

Retention 控制注解保留到哪个阶段

@Retention 决定注解“活多久”:源码期(SOURCE)、编译期(CLASS)、运行期(RUNTIME)。绝大多数自定义注解需要反射读取,必须选 RetentionPolicy.RUNTIME;如果只是给编译器看(比如 @Override),用 SOURCE 就够了。

容易踩的坑:

  • 写成 @Retention(RetentionPolicy.CLASS) 却在运行时用 getAnnotation() 去取——返回 null,因为字节码里虽有,但 JVM 不加载进内存
  • 误以为 SOURCE 能被注解处理器(APT)处理,其实可以,但注意:Kotlin 的 kapt 默认不支持 Java APT 的 SOURCE 注解,得配 kapt.includeCompileClasspath = true

两者搭配不当会导致注解“看不见”

哪怕 @Retention(RetentionPolicy.RUNTIME) 写对了,如果 @Target 没覆盖实际使用位置,编译器就直接报错。比如定义了 @Target(ElementType.METHOD),却用在字段上:javac 会提示 error: annotation @XXX is not applicable to this kind of declaration。

典型错误场景:

  • 想用注解驱动 JSON 序列化(如 @JsonAlias 风格),但忘了加 FIELD 和 METHOD,结果 setter/getter 上的注解被忽略
  • 写了个日志切面注解,@Target 只写了 TYPE,结果加在方法上不生效,还以为是 AOP 配置错了
  • 用 Lombok 的 @FieldNameConstants 时,发现生成的静态字段名不对——其实是 @Target 限制了只能用于 TYPE,你却试图在内部类里用,编译不过

IDE 和构建工具对元注解的检查很松

IntelliJ 默认不会严格校验 @Target 是否匹配实际用法(尤其 Kotlin + Java 混合项目),而 Maven 编译(maven-compiler-plugin)会。这意味着:代码在 IDE 里绿灯,一跑 mvn compile 就挂。

建议做法:

  • 所有自定义注解都显式写全 @Target 和 @Retention,别依赖默认
  • 在单元测试里用 Class.getDeclaredField() 或 Method.getAnnotation() 实测能否取到,而不是只看编译是否通过
  • 如果用 Gradle,确认 javaToolchain 版本与注解处理器兼容(例如 JDK 17+ 的 RetentionPolicy.SOURCE 注解,某些老版 processor 会跳过)

最麻烦的情况是:注解本身合法,但目标元素被泛型擦除、代理类包裹或模块封装(如 JPMS),这时候 getAnnotation() 返回 null 往往不是元注解问题,而是反射路径没走对——得先排除 @Target 和 @Retention 配置错误,再查更底层的机制。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

11577

6

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

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

2023.07.05

8682

9

java自学难吗
java自学难吗

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

2023.07.31

7452

8

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

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

2023.08.01

1224

3

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

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

2023.08.02

988

3

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

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

2023.08.02

1476

5

java有什么用
java有什么用

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

2023.08.02

3049

5

java在线网站
java在线网站

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

2023.08.03

20291

3

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

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

2023.08.03

1335

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习