Java 注解自定义注解 ( 注解解析 )

Posted 2021-05-22 韩曙亮

文章目录

• 一、定义注解
• 二、使用注解
• 三、解析注解
• 四、通过注解对象获取注解属性的原理

在 【Java 注解】自定义注解 ( 注解属性定义与赋值 ) 博客中讲解了 注解属性 ;

在 【Java 注解】自定义注解 ( 元注解 ) 博客中讲解了注解中的元注解如何描述注解 ;

本篇博客开始讲解注解在程序中如何进行 解析 和 使用 ;

注解中定义了 若干 注解属性 , 那么就需要在某个阶段 , 将 注解属性 的值拿出来 , 在某个场合让其发挥出作用 ;

解析注解 : 获取 注解属性 的值 ;

一、定义注解

---

定义一个注解 :

package annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 描述 类名, 以及类名下的方法名
 * 该注解作用于类上
 * 注解保留到运行时
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Property {
    /**
     * 注解属性 : 需要反射的类名
     * @return
     */
    String name();

    /**
     * 注解属性 : 需要反射的方法名
     * @return
     */
    int age();
}

二、使用注解

---

使用上述 Property 注解 :

@Property(name = "Tom", age = 18)
public class Main {
    public static void main(String[] args) {
    }
}

三、解析注解

---

在 main 函数中解析 Main 类上的 @Property(name = "Tom", age = 18) 注解 ;

首先 , 获取该 Main 类的字节码对象 ; 在哪个类上添加了注解 , 就获取哪个类的字节码文件 ;

// 1. 获取该 Main 类的字节码对象,
//    哪个类上添加了注解 , 就获取哪个类的字节码文件
Class<Main> clazz = Main.class;

然后 , 获取字节码上的注解对象 , 通过调用 getAnnotation 获取指定注解类型的对象 , 也可以调用 getAnnotations 方法 , 获取作用在该字节码类上的所有注解 ;

// 2. 获取字节码上的注解对象
Property propertyAnnotation = clazz.getAnnotation(Property.class);

最后 , 从注解对象中 , 获取注解属性 , 调用 注解属性 对应的抽象方法即可获取 注解属性 值 ;

// 3. 调用 注解对象 中的抽象方法, 获取其返回值
//    注解的本质就是接口, 其中的注解属性本质是 抽象方法
//    注解对象可以直接调用注解超抽象方法,
//      是因为在内存中生成了该 注解 接口的子类对象, 实现了 name 和 age 方法
// 获取注解属性 name
String name = propertyAnnotation.name();
// 获取注解属性 age
int age = propertyAnnotation.age();

System.out.println("注解属性值 : name = " + name + " , age = " + age);

完整代码如下 :

package annotation;

@Property(name = "Tom", age = 18)
public class Main {

    public static void main(String[] args) {

        // 解析注解

        // 1. 获取该 Main 类的字节码对象,
        //    哪个类上添加了注解 , 就获取哪个类的字节码文件
        Class<Main> clazz = Main.class;

        // 2. 获取字节码上的注解对象
        Property propertyAnnotation = clazz.getAnnotation(Property.class);

        // 3. 调用 注解对象 中的抽象方法, 获取其返回值
        //    注解的本质就是接口, 其中的注解属性本质是 抽象方法
        //    注解对象可以直接调用注解超抽象方法,
        //      是因为在内存中生成了该 注解 接口的子类对象, 实现了 name 和 age 方法
        // 获取注解属性 name
        String name = propertyAnnotation.name();
        // 获取注解属性 age
        int age = propertyAnnotation.age();

        System.out.println("注解属性值 : name = " + name + " , age = " + age);
    }
}

四、通过注解对象获取注解属性的原理

---

通过注解对象获取注解属性的原理 :

注解的本质就是接口, 其中的注解属性本质是 抽象方法 , 注解对象可以直接调用注解超抽象方法 , 是因为在内存中生成了该 注解 接口的子类对象, 实现了 name 和 age 方法 , 返回值就是本类注解中的 注解属性值 ;

在 Main 类上标注了 @Property(name = "Tom", age = 18) 注解 , 该 Main 类运行时 , 则在内存中生成的 注解 接口的子类对象 , 大概形式如下 :

public class PropertyImpl implements Property {
    @Override
    public String name() {
        return "Tom";
    }

    @Override
    public int age() {
        return 18;
    }
}

因此 , 通过注解属性 , 调用 name 和 age 方法 , 可以获取到注解的 注解属性 值 ;