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

反射获取类、方法及字段上注解信息的通用API

风辰吖_8414

风辰吖_8414

发布时间:2026-04-06 13:26:56

|

920人浏览过

|

来源于php中文网

原创

Java反射中获取注解信息的核心是统一基于AnnotatedElement接口,区分使用getAnnotation()与getAnnotationsByType()处理普通和重复注解,递归查找父类/接口注解,并通过空值校验、类型检查及异常捕获保障健壮性。

反射获取类、方法及字段上注解信息的通用api

Java 反射中获取注解信息的核心在于 getAnnotation()、getDeclaredAnnotations() 等方法,但要写通用、健壮的 API,需统一处理类、方法、字段三类元素,并支持注解继承、重复注解(@Repeatable)和类型安全提取。

统一入口:基于 AnnotatedElement 的泛型封装

类(Class)、方法(Method)、字段(Field)都实现了 AnnotatedElement 接口,这是通用性的基础。可定义一个工具方法:

public static <A extends Annotation> A getAnnotation(AnnotatedElement element, Class<A> annotationType) {
    if (element == null || annotationType == null) return null;
    return element.getAnnotation(annotationType);
}

该方法适用于任意注解目标,调用时无需判断元素类型:

  • getAnnotation(MyConfig.class, EnableLog.class)
  • getAnnotation(method, Timeout.class)
  • getAnnotation(field, NotNull.class)

支持重复注解与批量获取

JDK 8+ 中 @Repeatable 注解需用 getAnnotationsByType() 才能正确获取全部实例(getAnnotation() 只返回一个)。通用 API 应自动适配:

public static <A extends Annotation> A[] getAnnotationsByType(AnnotatedElement element, Class<A> annotationType) {
    if (element == null || annotationType == null) return (A[]) new Annotation[0];
    return element.getAnnotationsByType(annotationType);
}

例如对 @Role("admin") @Role("user"),此方法返回长度为 2 的数组;而 getAnnotation() 仅返回第一个。

递归查找(含继承与超类/接口)

默认反射不查找父类或接口上的注解。若需“语义继承”,需手动遍历:

  • 对 Class:检查自身、所有接口、父类(向上直到 Object)
  • 对 Method:除自身外,检查其在父类/接口中声明的同签名方法
  • 对 Field:通常不继承,但可按需扩展(如检查父类同名字段)

示例(简化版类层级查找):

public static <A extends Annotation> A findAnnotationOnClass(Class<?> clazz, Class<A> annotationType) {
    A ann = clazz.getAnnotation(annotationType);
    if (ann != null) return ann;
    // 查接口
    for (Class<?> intf : clazz.getInterfaces()) {
        ann = findAnnotationOnClass(intf, annotationType);
        if (ann != null) return ann;
    }
    // 查父类
    Class<?> superCls = clazz.getSuperclass();
    if (superCls != null && superCls != Object.class) {
        return findAnnotationOnClass(superCls, annotationType);
    }
    return null;
}

安全包装:避免 NullPointerException 和 ClassCastException

生产环境建议加空值与类型校验:

  • 用 Optional.ofNullable(...).map(...).orElse(null) 避免链式调用 NPE
  • 对返回的 Annotation 实例,用 annotationType.isInstance(ann) 替代强制转型
  • 捕获 TypeNotPresentException(当注解类未加载时)

例如:

public static <A extends Annotation> Optional<A> safeGetAnnotation(AnnotatedElement element, Class<A> annotationType) {
    try {
        Annotation ann = element.getAnnotation(annotationType);
        return ann != null && annotationType.isInstance(ann)
                ? Optional.of(annotationType.cast(ann))
                : Optional.empty();
    } catch (TypeNotPresentException e) {
        return Optional.empty();
    }
}

不复杂但容易忽略细节——统一用 AnnotatedElement、区分 getAnnotation 与 getAnnotationsByType、按需递归、始终做类型与空值防护,就能写出真正通用、可靠的注解提取 API。

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

热门AI工具

更多
豆包大模型

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

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

音述AI
音述AI Hot

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

DeepSeek

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

更多
c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

529

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1658

2024.03.01

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3068

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

4389

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3689

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

386

2026.01.19

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

3316

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

286

2025.12.06

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

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

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