Java高级特性——注解与反射

注解

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

注解声明

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

package java.lang.annotation;
public interface Annotation {
    boolean equals(Object var1);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

声明一个注解

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

public @interface MyAnnotation {
}

元注解

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

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

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

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

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

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

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

注解类型元素

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

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

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

public class Test {
    @MyAnnotation("s")
    private String string;
    @MyAnnotation(value ="s",id = 1)
    private short aShort;
    public static void main(String[] args) {
    }
}

注解应用场景

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

1.SOURCE

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

在Android开发中, support-annotations 与 androidx.annotation) 中均有提供 @IntDef 注解,此注解的定义如下:

@Retention(SOURCE)
@Target({ANNOTATION_TYPE})
public @interface IntDef {
    /** Defines the allowed constants for this element */
    int[] value() default {};

    /** Defines whether the constants can be used as a flag, or just as an enum (the default) */
    boolean flag() default false;
}

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

此注解的意义在于能够取代枚举,实现如方法入参限制。比如说我们创建一个设置星期的方法。

    public static void setCurrentDay(int currentDay) {//不能限制传入的参数值
        mCurrentDay = currentDay;
    }
    //定义一个枚举对象,每一个成员就是一个Wek对象
    enum WeekDay {
        SUNDAY, MONDAY
    }
    public static void setCurrentDay(WeekDay currentDay) {//可以限制方法入参
        mCurrentDay = currentDay;
   }
    private static final int SUNDAY = 0;
    private static final int MONDAY = 1;
    //以注解的方式,先定义一个注解
    @IntDef({SUNDAY, MONDAY})//设置注解的值范围
    @Target({ElementType.FIELD, ElementType.PARAMETER})
    @Retention(RetentionPolicy.SOURCE)
    @interface WekDay {  //注解
    }
    public static void setCurrentDay(@WekDay int currentDay) {//通过注解限制方法的入参
        mCurrentIntDay = currentDay;
    }

IDEA/AS 就是由Java开发的,工具实现了对Java语法的检查,借助注解能对被注 解的特定语法进行额外检查。

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

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

我们可以在AS中创建一个名为compiler的模块


compiler工程

代码内容为

@SupportedAnnotationTypes({"com.enjoy.annotation.MyAnnotation"})
public class MyProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        Messager messager = processingEnv.getMessager();
        messager.printMessage(Diagnostic.Kind.NOTE, "================================:"+set.size());
        }
        //xxxx可以做任何操作,包括获取注解信息,通过注解生成相关类
        // http
        //
        return false;
    }
}
注解处理器运行结果

2.ClASS

定义为 CLASS 的注解,会保留在class文件中,但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合此种注解的应用场景为字节码操作(字节码增强)。如:AspectJ、热修复Roubust中应用此场景。所谓字节码操作即为,直接修改字节码Class文件以达到修改代码执行逻辑的目的。在程序中有多处需要进行是否 登录的判断。

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

//Java源码 @Target(ElementType.METHOD) @Retention(RetentionPolicy.CLASS) public @interface Login {
}
@Login
public void jumpA(){
startActivity(new Intent(this,AActivity.class));
}
public void jumpB(){
startActivity(new Intent(this,BActivity.class));
}

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

//Class字节码
@Login
public void jumpA() { 
  if (this.isLogin) {
      this.startActivity(new Intent(this, LoginActivity.class)); }
 else {
      this.startActivity(new Intent(this, AActivity.class)); }
}
public void jumpB() {
       startActivity(new Intent(this,BActivity.class));
}

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

3.RUNTIME

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


反射

一般情况下,我们使用某个类时必定知道它是什么类,是用来做什么的,并且能够获得此类的引用。于是我们直接 对这个类进行实例化,之后使用这个类对象进行操作。
反射则是一开始并不知道我要初始化的类对象是什么,自然也无法使用 new 关键字来创建对象了。这时候,我们 使用 JDK 提供的反射 API 进行反射调用。反射就是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和 方法;对于任意一个对象,都能够调用它的任意方法和属性;并且能改变它的属性。是Java被视为动态语言的关键。

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

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

Class

反射始于Class,Class是一个类,封装了当前对象所对应的类的信息。一个类中有属性,方法,构造器等,比如说 有一个Person类,一个Order类,一个Book类,这些都是不同的类,现在需要一个类,用来描述类,这就是 Class,它应该有类名,属性,方法,构造器等。Class是用来描述类的类。
Class类是一个对象照镜子的结果,对象可以看到自己有哪些属性,方法,构造器,实现了哪些接口等等。对于每 个类而言,JRE 都为其保留一个不变的 Class 类型的对象。一个 Class 对象包含了特定某个类的有关信息。 对象只 能由系统建立对象,一个类(而不是一个对象)在 JVM 中只会有一个Class实例。

获得 Class 对象

获取Class对象的三种方式

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

判断是否为某个类的实例

一般地,我们用 instanceof 关键字来判断是否为某个类的实例。同时我们也可以借助反射中 Class 对象的
isInstance() 方法来判断是否为某个类的实例,它是一个 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("23333"); 
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
    通配符泛型,获得上下限信息;
TypeVariable
 public class TestType <K extends Comparable & Serializable, V> {
    K key;
    V value;
    public static void main(String[] args) throws Exception {
          // 获取字段的类型
          Field fk = TestType.class.getDeclaredField("key");
          Field fv = TestType.class.getDeclaredField("value");
          TypeVariable keyType = (TypeVariable)fk.getGenericType(); 
          TypeVariable valueType = (TypeVariable)fv.getGenericType(); 
          // getName 方法
          System.out.println(keyType.getName()); //K
          System.out.println(valueType.getName());//V
          //getGenericDeclaration 方法 
          System.out.println(keyType.getGenericDeclaration());//class com.test.TestType 
          System.out.println(valueType.getGenericDeclaration()); // class com.test.TestType
          // getBounds 方法
          System.out.println("K 的上界:");// 有两个
          for (Type type : keyType.getBounds()) {  // interface java.lang.Comparable
                System.out.println(type);  // interface java.io.Serializable
            }
          System.out.println("V 的上界:"); // 没明确声明上界的, 默认上界是 Object
          for (Type type : valueType.getBounds()) {
              System.out.println(type); }
          } 
}
ParameterizedType
 
public class TestType {
    Map<String, String> map;
    public static void main(String[] args) throws Exception {
      Field f = TestType.class.getDeclaredField("map"); 
      System.out.println(f.getGenericType()); // java.util.Map<java.lang.String,java.lang.String>
      ParameterizedType pType = (ParameterizedType) f.getGenericType();          
      System.out.println(pType.getRawType()); // interface java.util.Map 
      for (Type type : pType.getActualTypeArguments()) {
          System.out.println(type); // 打印两遍: class java.lang.String
     }
    }
 }
GenericArrayType
 
public class TestType<T> {
    List<String>[] lists;
     public static void main(String[] args) throws Exception {
         Field f = TestType.class.getDeclaredField("lists");
        GenericArrayType genericType = (GenericArrayType) f.getGenericType();     
        System.out.println(genericType.getGenericComponentType());
} }
WildcardType
public class TestType {
    private List<? extends Number> a; // 上限 private List<? super String> b; //下限

    public static void main(String[] args) throws Exception {
        Field fieldA = TestType.class.getDeclaredField("a");
        Field fieldB = TestType.class.getDeclaredField("b"); // 先拿到范型类型
        ParameterizedType pTypeA = (ParameterizedType) fieldA.getGenericType();
        ParameterizedType pTypeB = (ParameterizedType) fieldB.getGenericType(); // 再从范型里拿到通配符类型
        WildcardType wTypeA = (WildcardType) pTypeA.getActualTypeArguments()[0];
        WildcardType wTypeB = (WildcardType) pTypeB.getActualTypeArguments()[0]; // 方法测试
        System.out.println(wTypeA.getUpperBounds()[0]); // class java.lang.Number 
        System.out.println(wTypeB.getLowerBounds()[0]); // class java.lang.String
         // 看看通配符类型到底是什么, 打印结果为: ? extends java.lang.Number
        System.out.println(wTypeA);
    }
}
Gson反序列化
static class Response<T> {
        T data;
        int code;
        String message;

        @Override
        public String toString() {
            return "Response{" +
                    "data=" + data +
                    ", code=" + code +
                    ", message='" + message + '\'' +
                    '}';
        }

        public Response(T data, int code, String message) {

            this.data = data;
            this.code = code;
            this.message = message;
        }
    }

    static class Data {
        String result;

        public Data(String result) {
            this.result = result;
        }

        @Override
        public String toString() {
            return "Data{" +
                    "result=" + result +
                    '}';
        }
    }

    static class ChildTypeRefrence{
        Response<Data>  t;
    }

    public static void main(String[] args) {
        Response<Data> dataResponse = new Response(new Data("数据"), 1, "成功");

        Gson gson = new Gson();
        String json = gson.toJson(dataResponse);
        System.out.println(json);

        //反序列化......

        /**
         *  有花括号: 代表是匿名内部类,创建一个匿名内部类的实例对象
         *  没花括号:创建实例对象
            因为只有定义为抽象类或者接口,这样在使用时,需要创建对应的实现类,此时确定泛      
            型类型,编译才能够将泛型 signature信息记录到Class元数据中。
         */
        Type type = new TypeRefrence<Response<Data>>(){}.getType();

        Response<Data> response = gson.fromJson(json, type);
        System.out.println(response.data.getClass());
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容