如何在运行时获取一个类的注解信息？

小咪咪 2024-04-25 08:53 100阅读 0赞

> 【文章序言】：hello你好，很高兴能在茫茫人海中与你相遇在此篇文章中！  
>   
> 博客来源于项目以及编程中遇到的问题总结，偶尔会有读书分享，我会陆续更新Java前端、后台、数据库、项目案例等相关知识点总结，感谢你的阅读和关注，希望我的博客能帮助到更多的人，分享获取新知，大家一起进步!  
>   
> 吾等采石之人，应怀大教堂之心，愿我们奔赴在各自的热爱里…

### 基础案例 ###

![在这里插入图片描述][da92575c370d4909bb3504468e7fef77.png]

在Java中，可以使用反射机制来获取一个类的注解信息。下面是获取一个类的注解信息的步骤：

1.  获取目标类的Class对象：可以使用Class.forName()方法传入类的全限定名来获取Class对象，或者使用类名.class的形式获取。
2.  调用Class对象的getAnnotation(Class annotationClass)方法来获取指定类型的注解对象。这个方法返回的是一个注解对象，或者返回null。
3.  判断注解对象是否为空，如果不为空，可以通过注解对象的方法来获取注解信息。

下面是一个简单的示例代码，演示如何获取一个类的注解信息：

import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    
    @MyAnnotation(value = "Hello", count = 5)
    public class MyClass {
        
        public static void main(String[] args) {
        
            Class<MyClass> clazz = MyClass.class;
            
            //获取注解对象
            MyAnnotation annotation = clazz.getAnnotation(MyAnnotation.class);
            
            if (annotation != null) {
        
                //获取注解信息
                String value = annotation.value();
                int count = annotation.count();
                
                System.out.println("value: " + value);
                System.out.println("count: " + count);
            }
        }
    }
    
    //定义一个注解
    @Retention(RetentionPolicy.RUNTIME)
    @interface MyAnnotation {
        
        String value() default "default value";
        int count() default 0;
    }

在上面的示例中，首先定义了一个名为MyAnnotation的注解，并指定了它的生命周期为运行时级别。然后在MyClass类上使用了这个注解，并给它的value和count属性赋了值。最后在MyClass的main方法中获取了MyClass类的注解对象，并输出了注解的value和count属性值。

--------------------

### 拓展学习 ###

在Java中，要运行时获取一个类、方法或属性的注解信息，你需要使用反射API，并确保被检查的注解具有正确的@Retention策略。具体步骤如下：

演示如何获取类级别的注解、方法级别的注解以及字段级别的注解：

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    import java.lang.reflect.Field;
    import java.lang.reflect.Method;
    
    @MyClassAnnotation("Class Annotation")
    public class MyClass {
        
    
        @MyFieldAnnotation("Field Annotation")
        private String myField;
    
        @MyMethodAnnotation("Method Annotation")
        public void myMethod() {
        
    
        }
    
        public static void main(String[] args) throws NoSuchFieldException, NoSuchMethodException {
        
            Class<MyClass> clazz = MyClass.class;
    
            // 获取类级别的注解
            MyClassAnnotation classAnnotation = clazz.getAnnotation(MyClassAnnotation.class);
            if (classAnnotation != null) {
        
                System.out.println("Class Annotation: " + classAnnotation.value());
            }
    
            // 获取方法级别的注解
            Method myMethod = clazz.getMethod("myMethod");
            MyMethodAnnotation methodAnnotation = myMethod.getAnnotation(MyMethodAnnotation.class);
            if (methodAnnotation != null) {
        
                System.out.println("Method Annotation: " + methodAnnotation.value());
            }
    
            // 获取字段级别的注解
            Field myField = clazz.getDeclaredField("myField");
            MyFieldAnnotation fieldAnnotation = myField.getAnnotation(MyFieldAnnotation.class);
            if (fieldAnnotation != null) {
        
                System.out.println("Field Annotation: " + fieldAnnotation.value());
            }
        }
    }
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @interface MyClassAnnotation {
        
        String value();
    }
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    @interface MyMethodAnnotation {
        
        String value();
    }
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.FIELD)
    @interface MyFieldAnnotation {
        
        String value();
    }

在这个示例中，我们定义了一个类级别的注解`@MyClassAnnotation`，一个方法级别的注解`@MyMethodAnnotation`，以及一个字段级别的注解`@MyFieldAnnotation`。在`MyClass`类中，我们分别在类、方法和字段上使用了这些注解。

在`main`方法中，我们使用反射获取了`MyClass`类的注解信息。首先，我们通过`getAnnotation`方法获取了类级别的注解。然后，我们使用`getMethod`方法获取了`myMethod`方法，并通过`getAnnotation`方法获取了方法级别的注解。最后，我们使用`getDeclaredField`方法获取了`myField`字段，并通过`getAnnotation`方法获取了字段级别的注解。如果注解不为空，我们打印出注解的值。  
![在这里插入图片描述][cb0984475bfe477289d4d765ce0ba130.png]

运行这个示例代码，将会输出以下结果：

Class Annotation: Class Annotation
    Method Annotation: Method Annotation
    Field Annotation: Field Annotation

这样我们就成功地获取到了类级别的注解、方法级别的注解以及字段级别的注解信息。

--------------------

**关于Class类中此方法学习**  
![在这里插入图片描述][58826807020546748d96be4544cb7ba2.png]

--------------------

?☕️?????  
?非常感谢你阅读到这里，如果这篇文章对你有帮助，希望能留下你的点赞? 关注❤️ 分享? 留言?thanks！！！

?愿我们奔赴在各自的热爱里！

[da92575c370d4909bb3504468e7fef77.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/5e20d2ad78ac45d7878f5a30952b4a85.png
[cb0984475bfe477289d4d765ce0ba130.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/a8d61af1da2a4a78ad3aa936d612d923.png
[58826807020546748d96be4544cb7ba2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/af6f062d3d9a4fed8e97dd478d32c5fa.png