注解

注解声明

声明一个注解类型

Java中所有的注解，默认是实现Annotation接口：

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

    int hashCode();

    String toString();

    Class annotationType();
}

注解的声明使用@interface关键字，一个注解的声明如下：

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface Exciter {
    
}

元注解

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

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

@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。下文会介绍他们不同的应用场景。

例：

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

}

注解类型应用场景

根据注解的保留级别不同，对注解的使用自然存在不同场景。由注解的三个不同保留级别可知，注解作用于：源码、字节码与运行时。

级别	技术	使用场景
源码	APT	在编译期能够获取注解与注解声明的类包括类中所有成员信息，一般用于生成额外的辅助类。
字节码	字节码增强	在编译出Class后，通过修改Class数据以实现修改代码逻辑目的。对于是否需要修改的区分或者修改为不同逻辑的判断可以使用注解。
运行时	反射	在程序运行期间，通过反射技术动态获取注解与其元素，从而完成不同的逻辑判定。

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

SOURCE

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

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

语法检查

在Android开发中，support-annotations与androidx.annotation中均有提供 @IntDef、@DrawableResId等注解，此注解的定义如下：

@Retention(SOURCE)//源码级别注解
@Target({ANNOTATION_TYPE})
public @interface IntDef {
    int[] value() default {};

    boolean flag() default false;
    
    boolean open() default false;
}

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

@IntDef注解的意义在于能够取代枚举，实现如方法入参限制。

比如：定义buyCellPhone方法，接收CellPhone参数，需要在HUAWEI和XIAOMI中选一个，如果使用枚举实现：

public enum CellPhone {
    HUAWEI, XIAOMI
}

public void buyCellPhone(CellPhone phone) {

}

而现在为了优化内存优化，不使用枚举，而改为静态常量：

public static final int HUAWEI = 1;
public static final int XIAOMI = 2;

public void buyCellPhone(int phone) {

}

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

public static final int HUAWEI = 1;
public static final int XIAOMI = 2;

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.PARAMETER)
@IntDef({HUAWEI, XIAOMI})
public @interface CellPhone {
}

此时，再去调用buyCellPhone方法，如果传的不是HUAWEI或者XIAOMI，编译器就会Inspection警告(编译不会报错)：

可以修改此类语法检查级别：

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

APT注解处理器

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

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

CLASS

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

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

RUNTIME

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

反射

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

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

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

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

CLASS

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

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

获得 Class 对象

获取Class对象的三种方式

通过类名获取:类名.class

Class intClass = int.class;
Class integerClass = Integer.class;

通过对象获取:对象名.getClass()

File file = new File("");
Class fileClass = file.getClass();

通过全类名获取:Class.forName(全类名)/classLoader.loadClass(全类名)

public static Class forName(String className)

判断是否为某个类的实例

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

public native boolean isInstance(Object obj);

判断是否为某个类的类型：

public boolean isAssignableFrom(Class cls)

创建实例

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

1、使用Class对象的newInstance()方法来创建Class对象对应类的实例。

注意：此方法已过时。

Class c = String.class;
Object str = c.newInstance();

2、先通过Class对象获取指定的Constructor对象，再调用Constructor对象的newInstance()方法来创建实例。这种方法可以用指定的构造器构造类的实例。

//获取String所对应的Class对象
Class c = String.class;
//获取String类带一个String参数的构造器
Constructor constructor = c.getConstructor(String.class);
//通过构造器创建一个实例
Object str = constructor.newInstance("abc");
System.out.println(str);

获取构造器信息

得到构造器的方法

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);

动态代理原理

动态代理会在运行时再创建代理类和其实例，因此显然效率较低。要完成这个场景，需要在运行期动态创建一个Class。JDK提供了Proxy来完成这件事情。

DEMO

用注解、反射、动态代理实现类似ButterKnife的@OnClick @OnLongClick方法注解。

实现注解

@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface EventType {
    Class listenerType();

    String listenerSetter();
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@EventType(listenerType = View.OnClickListener.class, listenerSetter = "setOnClickListener")
public @interface OnClick {
    int[] value();
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@EventType(listenerType = View.OnLongClickListener.class, listenerSetter = "setOnLongClickListener")
public @interface OnLongClick {
    int[] value();
}

实现注入类

public class InjectUtils {

    public static void injectEvent(Activity activity) {
        Class activityClass = activity.getClass();
        //获取Class中所有方法
        Method[] declaredMethods = activityClass.getDeclaredMethods();

        for (Method method : declaredMethods) {
            //获得方法上的所有注解
            Annotation[] annotations = method.getAnnotations();

            //便利注解
            for (Annotation annotation : annotations) {
                //注解类型
                Class annotationType = annotation.annotationType();
                if (annotationType.isAnnotationPresent(EventType.class)) {
                    EventType eventType = annotationType.getAnnotation(EventType.class);
                    if (eventType == null) {
                        return;
                    }
                    Class listenerType = eventType.listenerType();
                    String listenerSetter = eventType.listenerSetter();

                    try {
                        Method valueMethod = annotationType.getDeclaredMethod("value");
                        int[] viewIds = (int[]) valueMethod.invoke(annotation);

                        method.setAccessible(true);
                        ListenerInvocationHandler handler = new ListenerInvocationHandler<>(activity, method);
                        Object listenerProxy = Proxy.newProxyInstance(listenerType.getClassLoader(),
                                new Class[]{listenerType}, handler);

                        if (viewIds == null) {
                            return;
                        }
                        //遍历注解的值
                        for (int viewId : viewIds) {
                            //获得当前Activity的View
                            View view = activity.findViewById(viewId);
                            //获取指定的方法
                            Method setter = view.getClass().getMethod(listenerSetter, listenerType);
                            //执行setOnXXX里面的回调方法
                            setter.invoke(view, listenerProxy);
                        }
                    } catch (Exception e) {
                        e.printStackTrace();
                    }

                }
            }
        }
    }

    static class ListenerInvocationHandler implements InvocationHandler {
        private final Method method;
        private final T target;

        public ListenerInvocationHandler(T target, Method method) {
            this.method = method;
            this.target = target;
        }

        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            return this.method.invoke(target, args);
        }
    }
}

使用

@OnClick({R.id.btn1, R.id.btn2})
    public void click(View view) {
        if (view.getId() == R.id.btn1) {
            Log.i(TAG, "onClick: button1");
        } else if (view.getId() == R.id.btn2) {
            Log.i(TAG, "onClick: button2");
        }
    }

    @OnLongClick({R.id.btn1, R.id.btn2})
    public boolean longClick(View view) {
        if (view.getId() == R.id.btn1) {
            Log.i(TAG, "onLongClick: button1");
        } else if (view.getId() == R.id.btn2) {
            Log.i(TAG, "onLongClick: button2");
        }
        return false;
    }

关注木水小站 (zhangmushui.cn)和微信公众号【木水Code】，及时获取更多最新技术干货。

Java中的注解&反射

注解

注解声明

声明一个注解类型

元注解

@Target

@Retention

注解类型应用场景

SOURCE

语法检查

APT注解处理器

CLASS

RUNTIME

反射

CLASS

获得 Class 对象

判断是否为某个类的实例

创建实例

获取构造器信息

获取类的成员变量（字段）信息

调用方法

利用反射创建数组

动态代理原理

DEMO

实现注解

实现注入类

使用

你可能感兴趣的:(Java中的注解&反射)