讲师中心 微信公众号
AI工具推荐 视频效率加速

如何使用注解Annotation为代码添加元数据描述信息

胖宇吖_1124

胖宇吖_1124

发布时间:2026-04-01 21:42:33

|

529人浏览过

|

来源于php中文网

原创

Java注解是结构化元数据,必须用@Retention指定生命周期、@Target限定作用目标才能生效;缺一不可,否则反射读不到或编译报错。

如何使用注解annotation为代码添加元数据描述信息

注解(Annotation)不是“给代码加备注”的快捷方式,它本质是编译期或运行时可被读取的结构化元数据——用错时机、漏掉 @Retention 或没写 @Target,注解就等于没写。

Java 注解必须声明生命周期和作用目标才能生效

只写 @interface MyAnno 是无效的。JVM 不知道该保留到什么时候、能用在哪儿。

  • @Retention(RetentionPolicy.RUNTIME):缺它,反射读不到;选 CLASS 就只能被字节码工具读,SOURCE 连 class 文件都不进
  • @Target({ElementType.METHOD, ElementType.TYPE}):不加这个,编译器会拒绝你把它标在字段上
  • 顺手加上 @Documented 才能让 javadoc 生成时包含该注解说明

示例:

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Documented
public @interface ApiVersion {
    String value() default "1.0";
}

运行时读取注解要用 Class/Method 对象的 getAnnotation() 方法

注解不会自动触发逻辑,必须显式调用反射 API 获取,且注意空指针风险。

  • clazz.getAnnotation(ApiVersion.class) 返回 null 表示没标注,别直接链式调用
  • 方法级注解要先拿到 Method 实例:clazz.getDeclaredMethod("xxx").getAnnotation(ApiVersion.class)
  • 如果用了 RetentionPolicy.CLASS,getAnnotation() 永远返回 null——此时只能用 ASM 或 javac 插件处理

常见错误现象:NullPointerException 出现在 anno.value(),其实是前面 getAnnotation() 返回了 null。

Spring 中的注解不是“即插即用”,依赖 BeanPostProcessor 或 AOP 织入

@Autowired、@Transactional 这类注解本身不做任何事,背后是 Spring 容器在启动时扫描并注册处理器。

  • 自定义注解想实现类似效果,得手动注册 BeanPostProcessor(如处理字段注入)或 Aspect(如方法拦截)
  • 别在普通 new 出来的对象上调用 @Autowired 字段——Spring 管不着,字段永远为 null
  • @Configuration 类里的 @Bean 方法,其参数能被自动注入,是因为 Spring 在解析配置类时做了特殊处理,不是注解本身的能力

重复注解需用 @Repeatable 声明容器,否则编译报错

Java 8 以前不支持同一位置多个相同注解,现在可以,但语法有硬性要求。

  • 必须定义一个“容器注解”,比如 @MyAnnos,其 value() 返回 MyAnno[]
  • 原注解上加 @Repeatable(MyAnnos.class)
  • 使用时可写多次:@MyAnno("v1") @MyAnno("v2"),反射读取时用 getAnnotationsByType(MyAnno.class),不能用 getAnnotation()

漏掉 @Repeatable 却写了两个同名注解?编译器直接报错:Duplicate annotation。

最常被忽略的一点:注解属性类型受限严格——只能是基本类型、String、Class、枚举、其他注解,或以上类型的数组;不能是任意对象,也不能有方法体或泛型参数。试图绕过这些限制,只会让编译失败或运行时异常。

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

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
java
java

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

11177

2023.06.15

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

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

8282

2023.07.05

java自学难吗
java自学难吗

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

7152

2023.07.31

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

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

1204

2023.08.01

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

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

968

2023.08.02

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

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

1436

2023.08.02

java有什么用
java有什么用

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

2949

2023.08.02

java在线网站
java在线网站

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

20211

2023.08.03

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

40

2026.10.22

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn