Java 中注解原理怎么自定义一个带属性的注解

云瑶吖_3685

云瑶吖_3685

2026-11-13

440人浏览

原创

Java注解本质是继承Annotation接口的特殊接口,需用@interface定义并配合@Target和@Retention元注解;属性以无参方法声明,支持默认值、数组及重复注解,运行时通过反射读取。

java 中注解原理怎么自定义一个带属性的注解

Java 注解本质是接口,由编译器在编译期或运行时通过反射读取并处理。自定义带属性的注解,核心在于声明一个用 @interface 定义的接口,并为它添加方法(即“属性”),再配合元注解控制其作用范围和生命周期。

1. 基础语法:用 @interface 定义注解

注解不是类,而是特殊接口,所有注解都隐式继承 java.lang.annotation.Annotation。属性以无参方法形式声明,返回类型有限制(基本类型、String、Class、枚举、其他注解,以及以上类型的数组)。

例如,定义一个带 name 和 value 属性的注解:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiLog {
    String value() default "";     // 默认空字符串
    String name() default "default";
    int level() default 1;
}

2. 必须搭配的元注解

自定义注解需至少指定 @Target 和 @Retention,否则无法正常使用:

javascript-typescript-typescript-scaffold
javascript-typescript-typescript-scaffold

你是 TypeScript 项目架构专家,专注于脚手架搭建生产就绪的 Node.js 和前端应用。生成包含现代工具链(pnpm、Vite、Next.js)、类型

下载
  • @Target:指定注解可用的位置,如 ElementType.METHOD(方法)、ElementType.TYPE(类)、ElementType.FIELD(字段)等;可传数组,支持多位置
  • @Retention:指定注解存活时间:SOURCE(仅源码)、CLASS(字节码,但不加载到 JVM)、RUNTIME(运行期可通过反射获取)——带属性且需动态读取的注解必须选 RUNTIME
  • 可选:@Documented(生成 Javadoc 时包含该注解)、@Inherited(子类可继承父类上的该注解)

3. 使用注解并读取属性值

在目标元素上使用注解后,需通过反射获取其实例并调用对应方法读取属性:

@ApiLog(value = "用户登录", name = "auth", level = 2)
public void login() { /* ... */ }
<p>// 反射读取
Method m = clazz.getDeclaredMethod("login");
if (m.isAnnotationPresent(ApiLog.class)) {
ApiLog anno = m.getAnnotation(ApiLog.class);
System.out.println(anno.value());   // "用户登录"
System.out.println(anno.name());    // "auth"
System.out.println(anno.level());   // 2
}</p>

4. 高级技巧:支持数组、默认值与重复注解

  • 数组属性写法:String[] tags() default {"api"};,使用时可写 @ApiLog(tags = {"v1", "auth"})
  • 若只有一个属性且名为 value(),使用时可省略名称:@ApiLog("hello") 等价于 @ApiLog(value = "hello")
  • 要支持重复使用同一注解(如多个 @Role("ADMIN")),需定义容器注解 + 添加 @Repeatable:
@Repeatable(Roles.class)
public @interface Role {
    String value();
}
<p>public @interface Roles {
Role[] value();
}</p>

之后就能在同一个元素上写多个 @Role,反射中用 getAnnotationsByType(Role.class) 获取全部。

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

12497

6

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

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

2023.07.05

9582

9

java自学难吗
java自学难吗

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

2023.07.31

8152

8

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

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

2023.08.01

1324

3

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

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

2023.08.02

1048

3

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

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

2023.08.02

1576

5

java有什么用
java有什么用

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

2023.08.02

3269

5

java在线网站
java在线网站

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

2023.08.03

20511

3

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

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

2023.08.03

1415

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习