> 文档中心 > Java 中的注解反射

Java 中的注解反射

文章目录

  • 一、注解
    • 1、注解声明
    • 2、元注解
    • 3、注解类型元素
    • 4、注解的应用场景
      • (1)、SOURCE
      • (2)、CLASS
      • (3)、RUNTIME
  • 二、反射
    • 1、Class
    • 2、获得Class 对象

一、注解

Java 注解(Annotation)又称Java 标注,是JDK5.0 引入的一种注释机制。注解是元数据的一种形式,提供有关于程序但不属于程序本身的数据。注解对它们注解的代码的操作没有直接影响。

在这里插入图片描述

1、注解声明

声明一个注解类型

Java 中所有的注解,默认实现Annotation

public interface Annotation {    boolean equals(Object obj);    int hashCode();    String toString();    Class<? extends Annotation> annotationType();}

与声明一个 Class 不同的是,注解的声明使用 @interface 关键字。一个注解的声明如下

public @interface Lance {}

2、元注解

在定义元注解时,注解类也能够使用其他的注解声明。对注解类型进行注解的注解类,我们称之为 mate-annontation(元注解)。一般的,我们在定义注解时,需要知道的元注解有两个:

另外还有@Documented 与 @Inherited 元注解,前者用于被Javac 工具提取成文档,后者表示允许子类继承父类中定义的注解。

@Target
注解标记另一个注解,以限制可以应用注解的Java 元素类型。目标注解指定以下元素类型之一作为其值:

  • @Target(ElementType.ANNOTATION_TYPE) 可以应用于注解类型
  • @Target(ElementType.CONSTRUCTOR) 可以应用于构造函数
  • @Target(ElementType.FIELD) 可以应用于字段或属性
  • @Target(ElementType.LOCAL_VARIABLE) 可以应用于局部变量
  • @Target(ElementType.METHOD) 可以应用于方法级注解
  • @Target(ElementType.PACKAGE) 可以应用于包声明
  • @Target(ElementType.PARAMETER) 可以应用于方法的参数
  • @Target(ElementType.TYPE) 可以应用于类的任何元素

@Retention
注解指定标记注解的存储方式:

  • @Retention(RetentionPolicy.SOURCE) 标记的注解仅保留在源级别中,并被编译器忽略。
  • @Retention(RetentionPolicy.CLASS) 标记的注解在编译时由编译器保留,但Java虚拟机(JVM)会忽略。
  • @Retention(RetentionPolicy.RUNTIME) 标记的注解由JVM保留,因此运行时环境可以使用它

@Retention 三个值中 SOURCE < CLASS < RUNTIME ,即CLASS 包含了SOURCE, RUNTIME
包含了 SOURCE 、CLASS。下文会介绍他们不同的应用场景。

下面来看个例子:

//@Target(ElementType.TYPE)  注解只能在类上标记@Target({ElementType.TYPE, ElementType.FIELD})   // 允许在类与类属性上标记该注解@Retention(RetentionPolicy.SOURCE)   //注解保留在源码中public @interface Lance {}

3、注解类型元素

在上文注解中,允许在使用注解时传递参数。我们也能让自定义的主体包含 Annotation type element(注解类型元素)声明,他们看起来很像方法,可以定义可选的默认值。

@Target({ElementType.TYPE, ElementType.FIELD})   // 允许在类与类属性上标记该注解@Retention(RetentionPolicy.SOURCE)   //注解保留在源码中public @interface Lance {    String value();// 无默认值    int age() default 1;  // 有默认值}

注意:在使用注解时,如果定义的注解中的类型元素无默认值,则必须进行传值

@Lance("帅")  // 如果只存在value 元素,需要传值的情况,则可以省略: 元素名=@Lance(value = "tiger", age = 18) 

4、注解的应用场景

按照@Retention 元注解定义的注解存储方式,注解可以被在三种场景下使用:

(1)、SOURCE

@Retention(RetentionPolicy.SOURCE) ,作用于源码级别的注解,可提供给IDE 语法检查,APT 等场景使用。

在这里插入图片描述

在类中使用SOURCE 级别的注解,其编译之后的class 中会被丢弃

在这里插入图片描述

在Android 开发中,support-annotationsandroidx.anotation 中均有提供@IntDef@DrawableResId 等注解,此注解的定义如下

@Retention(RetentionPolicy.SOURCE)@Target(ElementType.ANNOTATION_TYPE)public @interface IntDef { int[] value() default {};    boolean flag() default false;    boolean open() default false;}

Java 中Enum(枚举)的实质是特殊单例的静态成员变量,在运行期所有枚举类作为单例,全部加载在内存当中。
比常量多5到10倍的内存占用。

此注解的意义在于能够取代枚举,实现如方法入参的限制。
如:定义一个Test 方法,此方法接收参数Teacher需要在:lance、 Alvin 中选择一个。如果使用枚举实现:

public enum Teacher{    LANCE, ALVIN}public void Test(Teacher teacher) {}

而现在为了进行内存优化,不再使用枚举,则方法定义为:

    public static final int LANCE  = 1;    public static final int ALVIN  = 2;    public void Test(int teacher) {     }

然而此时,调用test方法由于采用基本数据类型int,将无法进行类型限定。此时使用@IntDet增加自定义注解:

    public static final int LANCE  = 1;    public static final int ALVIN  = 2; @IntDef(value = {LANCE, ALVIN})     // 限定为 LANCE, ALVIN    @Target(ElementType.PARAMETER)   // 作用于参数的注解    @Retention(RetentionPolicy.SOURCE)  // 源码级别的注解    public @interface Teacher{     }    public void Test(@Teacher int teacher) {    }    

以上注解均为SOURCE级别,本身IDEA/AS 就是由Java 开发的,Lint 工具实现了对Java 语法的检查,借助注解能对被注解的特定语法进行额外检查

APT 注解处理器

APT 全称为:“annotation processor tools”,意为注解处理器。顾名思义,其用于处理注解。编写好的Java 源文件,需要经过javac的编译,翻译为虚拟机能够加载解析的字节码Class 文件。标注为javac 自带的一个工具,用来编译时期扫描处理注解信息。你可以为某些注解注册自己的处理器。注册的注解处理器由javac 调起,并将注解信息传递给注解处理器进行处理。

注解处理器是对注解应用最广泛的场景。在Glide、EventBus3、Butterknifer、Tinker、ARoutrt
等等常用框架中都有注解处理器的身影。但是你可能会发现,这些框架中对注解的定义,并不是SOURCE
级别,更多的是CLASS级别,别忘了:CLASS 包含了SOURCE, RUNTIME包含了CLASS、SOURCE。

(2)、CLASS

定义为CLASS 的注解,会保留在class 文件中,但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合此种注解的应用场景为字节码操作。如:Aspectj、热修复Roubust中应用此场景。

所谓字节码操作即为,直接修改字节码Class 文件以达到修改代码执行逻辑的目的。在程序中有多处需要进行是否登录的判断。

在这里插入图片描述

如果我们使用普通的编程方式,需要在代码中进行if-else的判断,也许存在十个判断点,则需要在每个判断点加入此项判断。此时,我们可以借助AOP(面向切面)思想,将程序中所有功能点划分为:需要登录无需登录两种类型,即两个切面。对于切面的区分即可采用注解。

    @Target(ElementType.METHOD)    // 应用于方法上的注解    @Retention(RetentionPolicy.CLASS) public @interface Login{    }    @Login    public void jumpA(){    }    public void jumpB(){    }

在上面的代码中,jumpA方法需要具备登录身份,而Login 注解的定义被设为Class。因此我们能够在该类所编译的字节码中获得到方法注解Login。在操作字节码时,就能够根据方法是否具备该注解来修过Class 中该方法的内容加入if-else 的代码段:

 @Target(ElementType.METHOD)    // 应用于方法上的注解    @Retention(RetentionPolicy.CLASS)    public @interface Login{ boolean isLogin() default false;    }    @Login    public void jumpA(){ if (isLogin){     this.startActivity(new Intent(this, LoginActivity.class)); }else {//     不需要登录 }    }    public void jumpB(){    }

注解能够设置类型元素(参数),结合参数能实现更为丰富的场景,如:运行期权限判定等。

(3)、RUNTIME

注解保留至运行期,意味着我们能够在运行期间结合反射技术获取注解中的所有信息

二、反射

一般情况下,我们使用某个类时必定知道它是什么类,是用来做什么的,并且能够获得此类的引用。于是我们直接对这个类进行实例化之后使用这个类对象进行操作。

反射是一开始并不知道我要初始化的类是什么,自然也无法使用new 关键字来创建对象了。这时候,我使用JDK 提供的反射API 进行反射调用。**反射就是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意方法和属性;并且能改变它的属性。**是Java被视为动态语言的关键。

Java 反射机制主要提供了以下功能:

  • 在运行时构造任意一个类的对象
  • 在运行时获取或者修改任意一个类所具有的成员变量和方法
  • 在运行时调用任意一个对象的方法(属性)

1、Class

反射始于Class,**class 是一个类,封装了当前对象所对应的类的信息。**一个类中有方法,属性,构造器等,比如说 有一个Person类,一个Order类,一个Book类,这些都是不同的类,现在需要一个类,用来描述类,这就是Class,它应该有类名,属性,方法,构造器等。Class 是用来描述类的类。

Class 是一个对照镜子的结果,对象可以看到自己有哪些属性,方法,构造器,实现了哪些接口等等。对于每个类而言,JRE 都为其保留一个不变的Class 类型对象。一个Class 类型的对象包含了特定某个类的有关信息。对象只能由系统建立对象,一个类(而不是一个对象)在JVM 中只会有一个Class 实例。

2、获得Class 对象

获取Class 对象的三种方式

  1. 通过类名获取 类名.class
  2. 通过对象获取 对象.class
  3. 通过全类名获取 Class.forName(全类名) classLoader.loadClass(全类名)
  • 使用Class 类的forName 获取
    public static Class<?> forName(String className)
  • 直接获取某一个对象的class
    Class<?> klass = int.class;    Class<?> classInt = Integer.TYPE;
  • 调用某个对象的getClass() 方法
    StringBuffer stringBuffer = new StringBuffer("123");    Class<?> klass = stringBuffer.getClass();

判断是否为某个类的实例

一般的,我们用instanceof 关键字来判断是否为某个类的实例。同时我们也可以借助反射中的Class 对象的isIntance() 方法来判断是否为某个类的实例,它是一个native 方法:

public native boolean isInstance(Object obj);

判断是否为某个类的类型

public boolean isAssignableFrom(Class<?> cls);

创建实例

通过反射来生成对象主要有两种方式。

  • 使用Class 对象的newInstance() 方法来创建Class 对象对应的实例
    Class<?> c = String.class;    Object str = c.newInstance();
  • 通过Class 对象获取指定的Constructor 对象,再调用Constructor 对象的newInstance 方法来创建实例。这种方法可以用指定的构造器构造类的实例。
    //    获取String 所对应的Class 对象    Class<?> c = String.class;    //    获取String 类 带一个String 参数的构造器    Constructor constructor = c.getConstructor(String.class);    //    根据构造器创建实例    Object obj = constructor.newInstance("333"); System.out.println(obj);

获取构造器信息

得到构造器的方法

  • Constructor getConstructor(Class[] params) –
    获得使用特殊的参数类型的public构造函数(包括父类)
  • Constructor[] getConstructors() –
    获得类的所有公共构造函数
  • Constructor getDeclaredConstructor(Class[] params) –
    获得使用特定参数类型的构造函数(包括私有)
  • Constructor[] getDeclaredConstructors() –
    获得类的所有构造函数(与接入级别无关)

获取类构造器的用法与上述获取方法的用法类似。主要是通过Class类的getConstructor方法得到Constructor类的 一个实例,而Constructor类有一个newInstance方法可以创建一个对象实例:

public T newInstance(Object ... initargs)

获取类的成员变量(字段)信息

获得字段信息的方法

  • Field getField(String name) – 获得命名的公共字段
  • Field[] getFields() – 获得类的所有公共字段
  • Field getDeclaredField(String name) – 获得类声明的命名的字段
  • Field[] getDeclaredFields() – 获得类声明的所有字段

调用方法
获得方法信息的方法

  • Method getMethod(String name, Class[] params) – 使用特定的参数类型,获得命名的公共方法
  • Method[] getMethods() – 获得类的所有公共方法
  • Method getDeclaredMethod(String name, Class[] params) – 使用特写的参数类型,获得类声明的命名的方法
  • Method[] getDeclaredMethods() – 获得类声明的所有方法

当我们从类中获取了一个方法后,我们就可以用 invoke() 方法来调用这个方法。 invoke 方法的原型为:

public Object invoke(Object obj, Object... args)

利用反射创建数组

数组在Java里是比较特殊的一种类型,它可以赋值给一个Object Reference 其中的Array类为
java.lang.reflect.Array类。我们通过Array.newInstance()创建数组对象,它的原型是:

public static Object newInstance(Class<?> componentType, int length);

反射获取泛型真实类型

当我们对一个泛型类进行反射时,需要的到泛型中的真实数据类型,来完成如json反序列化的操作。此时需要通 过 Type 体系来完成。 Type 接口包含了一个实现类(Class)和四个实现接口,他们分别是:

  • TypeVariable
    泛型类型变量。可以泛型上下限等信息;
  • ParameterizedType
    具体的泛型类型,可以获得元数据中泛型签名类型(泛型真实类型)
  • GenericArrayType
    当需要描述的类型是泛型类的数组时,比如List[],Map[],此接口会作为Type的实现。
  • WildcardType
    通配符泛型,获得上下限信息;

湖北工具网