Java 怎么通过反射获取方法上的注解并解析

星墨同学_7038

星墨同学_7038

2026-09-04

273人浏览

原创

java反射可获取方法注解值:先获method对象,再用getannotation()获取指定runtime注解实例并调用其属性方法;或用getdeclaredannotations()遍历所有显式声明注解,通过annotationtype()判断类型后强转解析。

java 怎么通过反射获取方法上的注解并解析

Java 中可以通过反射获取方法上的注解,并进一步解析其值。核心步骤是:先获取 Method 对象,再调用 getAnnotation(Class) 或 getDeclaredAnnotations() 获取注解实例,最后通过注解的方法(即属性)读取值。

获取指定类型的注解

最常用方式是直接获取某个自定义或标准注解的实例,前提是该注解的 @Retention 为 RUNTIME(否则运行时不可见):

  • 确保注解声明时使用 @Retention(RetentionPolicy.RUNTIME)
  • 使用 method.getAnnotation(YourAnnotation.class) 获取注解对象
  • 若注解不存在,返回 null,需判空处理

示例:

自定义注解
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiLog {
    String value() default "";
    boolean enabled() default true;
}
在方法上使用
public class UserService {
    @ApiLog(value = "用户登录", enabled = true)
    public void login(String username) { ... }
}
反射读取
Method method = UserService.class.getMethod("login", String.class);
ApiLog annotation = method.getAnnotation(ApiLog.class);
if (annotation != null) {
    System.out.println(annotation.value());   // 输出:用户登录
    System.out.println(annotation.enabled()); // 输出:true
}

获取所有注解(包括重复和元注解)

当需要检查多个注解、或不确定具体类型时,可用以下方式:

Java Maven Code Review
Java Maven Code Review

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

下载
  • method.getDeclaredAnnotations():返回该方法**显式声明**的所有注解(不含继承的)
  • method.getAnnotations():返回所有**可见**注解(含从接口/父类继承的,若注解标注了 @Inherited 且作用于类)
  • 对每个 Annotation 实例,可用 annotation.annotationType() 判断类型,再强转解析

示例:

for (Annotation ann : method.getDeclaredAnnotations()) {
    Class extends Annotation> type = ann.annotationType();
    if (type == ApiLog.class) {
        ApiLog log = (ApiLog) ann;
        System.out.println("日志名:" + log.value());
    } else if (type == Deprecated.class) {
        System.out.println("该方法已弃用");
    }
}

处理重复注解(Java 8+)

若注解支持重复(即标注了 @Repeatable),不能直接用 getAnnotation(),而应使用:

  • method.getAnnotationsByType(YourRepeatableAnnotation.class):返回所有同类型注解数组
  • method.getDeclaredAnnotationsByType(...):仅查当前声明,不包含继承

示例(重复注解):

@Repeatable(ApiLogs.class)
public @interface ApiLog {
    String value() default "";
}

public @interface ApiLogs {
    ApiLog[] value();
}

// 方法上用了两次 @ApiLog
@ApiLog("创建订单")
@ApiLog("发送通知")
public void process() { ... }

// 反射获取全部
ApiLog[] logs = method.getAnnotationsByType(ApiLog.class);
for (ApiLog log : logs) {
    System.out.println(log.value());
}

注意事项与常见问题

  • 反射获取注解前,必须确保类已被加载,且方法存在(注意拼写、参数类型匹配)
  • 私有方法需先调用 method.setAccessible(true) 才能访问(尤其配合 getDeclaredMethod)
  • 泛型参数、桥接方法可能影响 getMethod 查找,建议优先用 getDeclaredMethod + 显式设可访问
  • Spring 等框架中,常结合 AOP 在代理对象上调用反射,此时需注意目标对象(target)而非代理对象

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

9537

6

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

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

2023.07.05

6702

9

java自学难吗
java自学难吗

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

2023.07.31

5952

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1236

5

java有什么用
java有什么用

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

2023.08.02

2509

5

java在线网站
java在线网站

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

2023.08.03

19851

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习