黑马程序员--08.注解--04【利用反射操作注解对象】

反射应用----1

利用反射操作注解对象

----------- android培训、java培训、java学习型技术博客、期待与您交流！ ------------

1.    利用反射操作注解对象基本知识

1). 利用反射操作注解对象的流程

2). AnnotatedElement接口简介

(1). AnnotatedElement接口的基本知识

[1]. 位置：位于java.lang.reflect反射子包中

[2]. 作用：这个接口专门用于使用反射操作注解

[3]. 源码：

package java.lang.reflect;
import java.lang.annotation.Annotation;
public interface AnnotatedElement {
     boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
   <T extends Annotation> TgetAnnotation(Class<T> annotationClass);
   Annotation[] getAnnotations();
   Annotation[] getDeclaredAnnotations();
}

[4]. 已知实现子类

AccessibleObject (子类 Constructor, Field, Method), Class, Package

【解释】由于注解是一种标记，仅仅是用来修饰其他程序元素的，因此注解不能单独使用，要依附于具体的程序元素才能使用。所以，让相应的程序片段对应的反射的类(AccessibleObject,Constructor, Filed, Method, Class, Package)去实现AnnotatedElement接口表示这些类的对象通过自身就有能力用反射来来判断自身(程序元素)是否含有注解。

2). 常用方法

(1). 判定操作：判定是否存在某一种指定类型的注解

[1]. 源码声明： boolean isAnnotationPresent(Class<?extends Annotation>annotationClass);

[2]. 输入参数：Class<? extends Annotation>由于所有的注解类型都是直接或者间接继承了java.lang.annotation.Annotation这个接口，所以，这个方法输入参数要限定一下传入的必须是注解的类型Class，因此输入参数是Class<?extends Annotation>

(2). 通过注解的Class对象获取指定类型的注解对象

[1]. 源码声明：

<T extends Annotation>T getAnnotation(Class<T> annotationClass)

这是一个泛型方法，这样做的原因是AnnotatedElement和泛型没有关系。

[2]. 输入参数：指定注解接口类型Class对象

T在定义的时候已经限定为 <T extends Annotation>

[3]. 返回值类型：注解类型

(3). 返回出现在这个程序元素上所有的注解(直接或者间接的都算)

[1]. 源码声明：Annotation[]getAnnotations()

[2]. 返回值类型：Annotation[] 数组类型

原因：一个程序元素可以有很多注解来进行修饰，所以这里不能限定<T extends Annotation>。因为虽然这个限定是表示注解类型或者注解类型的子类型，但是一旦T确定之后，就只能是确定的子类注解类型，不能改变，这样不能同时接受一个程序元素上多个不同类型的注解类型。如果想改变，有不能定义泛型数组，可以使用List<? extends Annotation>, 但是方法内部元素的类型就是?，标示符类型是?不满足Java合法标示符的组成原则，编译无法通过。因此，直接使用直接父类类型的数组Annotation[]来做返回值类型。

(4). 返回直接出现在这个程序元素上所有的注解(间接的不算)

[1]. 源码声明：Annotation[]getDeclaredAnnotations();

[2]. 返回值类型：Annotation[ ]

【总结】想判断什么程序元素上含有什么类型的注解，直接使用这个程序元素对应的反射对象来直接调用以上这些方法即可。因为Class、AccessibleObject、Method、Field、Constructor和Package都实现了AnnotatedElement这个接口

2.    使用反射操作注解举例

1). 使用反射操作注解的前提

(1). 使用反射的操作注解的时候，这个注解一定是运行时注解

[1]. 设定运行时注解的方法：对这个注解用元注解@Retention进行修饰，并且把@Retention的成员属性value的值修改成RetentionPolicy.RUNTIME才可以。否则，由于注解默认的是维持到CLASS阶段。这样在ClassLoader装载.class文件的时候，这些注解就要被去掉，反射技术无法访问到这些字节码文件注解。

(2). 操作实例1

[1]. 自定义注解类

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
 
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface ItcastAnnotation {
    Stringcolor() default "blue";
    Stringvalue();
}

[2]. 使用注解类的类

@ItcastAnnotation("Benjamin")
class AnnotationUsedClass {}

[3]. 测试这个注解类是否被AnnotationUsedClass所使用

public class AnnotationTest {
    /*
     * 判定类AnnotationUsedClass是否含有ItcastAnnotaion类型的注解
     * 判定的程序元素是一个类 所以  要使用Class对象+ AnnotatedElement的方法
     */
    public static void main(String[] args) {
       ClassclazzDecoratedByAnnotation =AnnotationUsedClass.class;
       ClassclazzAnnotationUsedClass =ItcastAnnotation.class;
       if(clazzDecoratedByAnnotation.isAnnotationPresent(clazzAnnotationUsedClass)){
           ItcastAnnotation itcastAnnotation =(ItcastAnnotation) clazzDecoratedByAnnotation.getAnnotation(clazzAnnotationUsedClass);
           System.out.println(itcastAnnotation);
       }else{
           System.out.println("We did not find any annotations atall...");
       }
    }
}

【打印结果】We did not find any annotations at all...

【分析原因】由于没有将注解的生命周期设置到JVM运行的内存字节码阶段，所以在反射技术进行访问的时候，注解就已经擦除了。

(3). 操作实例2：修改(2)中的自定义注解的生命周期参数

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ItcastAnnotation {
    Stringcolor() default "blue";
    Stringvalue();
}

【运行结果】@ItcastAnnotation(color=blue, value=Benjamin)

说明反射技术读取到了注解。同时也说明了注解类型重写了Object的toString()方法

2). 应用举例

(1). 通过反射获取注解类型的成员变量的值

思路：

[1].“@注解名(键值对)”这是一种为注解类型为“注解名”的注解(一种接口)进行的匿名内部类实例化过程。由于进行了书写简化，因此写成了键值对的形式。

[2]. 通过反射获取这个注解接口的匿名内部类的实例化对象。

[2]. 根据注解内部定义的成员方法名<---->外部调用的成员属性名，内部定义的成员方法返回值类型<---->外部调用的成员变量的属性值这个特点，得知，只要在非@中【因为@中是简写形式】调用了注解内部的抽象方法，这个方法的返回值就一定是在@中为成员变量赋的值。

【注意】为什么可以调用抽象方法？

这里调用的不再是抽象方法，而是通过@进行了匿名实现注解类的子类的实例化的对象的具体方法。尽管没有写具体的方法体，但是有返回值，那就说明这个方法至少内部有一个return语句，因此这就不是抽象方法，就可以调用

(2). 举例

[1]. 自定义的注解类1

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface InsistOnAnnotation {
    Stringmotto() default "踏踏实实，善始善终！";
}

[2]. 自定义枚举类

public enum Gender {
    male(1), female(0);
    private int genderIndex =-1;
    private Gender(int genderIndex){
       this.genderIndex =genderIndex;
    }
}

[3]. 自定义的注解类2

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ComprehensiveAnnotation {
    Stringvalue();
    Stringname() default "Benjiamin";
    int age() default 18;
   
    //数组类型的属性
    int[] hardTimes() default {2008, 2009, 2010, 2012, 2013};
   
    //枚举类型的属性
    Gendergender() default Gender.male;
   
    //注解类型的属性
    InsistOnAnnotation faith() default @InsistOnAnnotation(motto="坚持就是胜利！！");
}

[4]. 使用注解的对象修饰类

@ComprehensiveAnnotation(name="Benjamin", age=28, gender=Gender.male,
                      hardTimes={2008,2009,2011,2012,2013}, value="Come On!!",
                      faith=@InsistOnAnnotation(motto ="Where there is a will, there is away!"))
class AnnoDecoratedClass{}

[5]. 开始使用反射进行测试注解对象

public class ComprehensiveAnnoTest {
    //获取注解@ComprehensiveAnnotation实例所有的属性
    public static void main(String[] args) {
       ClassannotationClass =ComprehensiveAnnotation.class;
       ClassdecoratedClass =AnnoDecoratedClass.class;
       if(decoratedClass.isAnnotationPresent(annotationClass)){
           //获取注解ComprehensiveAnnotation的实例对象
           ComprehensiveAnnotation cmpAnno =(ComprehensiveAnnotation) decoratedClass.getAnnotation(annotationClass);
          
           //获取name属性
           StringuserName =cmpAnno.name();
          
           System.out.println("用户姓名："+ userName);
          
           //获取age属性
           int userAge =cmpAnno.age();
           System.out.println("用户年龄："+ userAge);
          
           //获取gender属性
           Gendergender =cmpAnno.gender();
           System.out.println("用户性别："+ gender);
          
           //获取艰苦奋斗的时刻
           System.out.print("用户奋斗的年份：");
           int[] userHardTimes =cmpAnno.hardTimes();
          
           for(int year: userHardTimes){
              System.out.print(year +" ");
           }
           System.out.println();
          
           //获取鼓励
           StringencourageWords =cmpAnno.value();
           System.out.println("很多人都鼓励"+ userName+":"+ encourageWords);
          
           //获取注解对象属性 ---格言对象
           InsistOnAnnotation mottoObj = cmpAnno.faith();
           //获取格言
           Stringmotto =mottoObj.motto();
           System.out.println(userName+ "有自己的格言："+ motto);
       }
    }
}

【打印结果】

----------- android培训、java培训、java学习型技术博客、期待与您交流！ ------------