如何使用Java注解功能为代码添加元数据并实现自定义解析

秋萱君_2515

秋萱君_2515

2026-06-18

782人浏览

原创

java注解是为代码添加元数据的轻量级机制,需定义注解(用@interface及元注解如@target、@retention)、标记代码、编写解析逻辑三步协同;运行时通过反射读取(要求retentionpolicy.runtime),编译期可通过apt生成源码。

如何使用java注解功能为代码添加元数据并实现自定义解析

Java注解(Annotation)是为代码添加元数据的轻量级机制,本身不直接影响程序逻辑,但可通过反射在运行时读取,或通过APT在编译期处理。要真正发挥作用,需“定义注解 + 标记代码 + 编写解析逻辑”三步协同。

定义自定义注解

使用 @interface 声明注解类型,配合元注解控制其作用范围和生命周期:

  • @Target:指定可标注的位置(如 ElementType.METHOD、ElementType.TYPE)
  • @Retention:指定保留策略(RetentionPolicy.RUNTIME 才能通过反射读取)
  • @Documented(可选):表示该注解应包含在 JavaDoc 中
  • @Inherited(可选):允许子类继承父类的注解

例如定义一个用于标记接口实现类的注解:

<font size="2">@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Service {
    String value() default "";
    String version() default "1.0";
}</font>

在代码中使用注解

将注解加在类、方法、字段等目标上,支持传入参数(键值对形式):

<font size="2">@Service(value = "user-service", version = "2.1")
public class UserServiceImpl implements UserService {
    // ...
}</font>

注意:若注解只有一个名为 value 的属性,使用时可省略名称,直接写 @Service("user-service")。

Java Maven Code Review
Java Maven Code Review

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

下载

运行时解析注解(基于反射)

通过 Class.getAnnotation() 或 Method.getAnnotation() 等方法获取注解实例,再调用其方法提取元数据:

<font size="2">Class> clazz = UserServiceImpl.class;
Service serviceAnno = clazz.getAnnotation(Service.class);
if (serviceAnno != null) {
    System.out.println("Name: " + serviceAnno.value());
    System.out.println("Version: " + serviceAnno.version());
}</font>

常见场景包括:自动注册服务、权限校验、日志埋点、序列化控制等。关键点是确保注解声明为 RetentionPolicy.RUNTIME,否则反射无法获取。

编译期处理注解(APT)

若需生成新源码(如 ButterKnife、Lombok、MapStruct),可用注解处理器(AbstractProcessor)在编译阶段扫描并处理注解:

  • 创建继承 AbstractProcessor 的类,重写 process()
  • 在 getSupportedAnnotationTypes() 中声明支持的注解全限定名
  • 使用 RoundEnvironment 获取被标注的元素(Element),再通过 Filer 生成 .java 文件
  • 将处理器打包为 jar,并在 META-INF/services/javax.annotation.processing.Processor 中声明入口类

这种方式不依赖反射,性能更高,且能在编译时报错,适合框架级能力扩展。

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

9777

6

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

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

2023.07.05

6922

9

java自学难吗
java自学难吗

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

2023.07.31

6112

8

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

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

2023.08.01

1064

3

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

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

2023.08.02

888

3

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

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

2023.08.02

1296

5

java有什么用
java有什么用

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

2023.08.02

2569

5

java在线网站
java在线网站

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

2023.08.03

19891

3

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

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

2023.08.03

1155

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
全面解析Java注解
全面解析Java注解

共12课时 | 3.3万人学习

dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习