Java注解、反射、动态代理笔记

Java 知识是作为 Android 开发的语言基础，虽然现在已经推出了 kotlin ，但是基于以下原因我们还是需要好好牢牢掌

握 java ：

1. SDK还是java，kotlin也需要编译成为java运行；
2. Java语言应用不仅仅在Android，就是在后台开发中也是一个最流行的语言；
3. 大公司面试都要求我们有扎实的Java语言基础。

所以，请大家不要轻视提高自己 Java 基础的机会，请大家认真学习，做好笔记，争取取得更大的进步。

1 注解

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

1.1 注解声明

1.1.1 声明一个注解类型

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 Donny {
}

1.1.2 元注解

在定义注解时，注解类也能够使用其他的注解声明(也就是说，元注解是声明在注解上的注解)。对注解类型进行注解的注解类，我们称之为 meta-annotation（元注解）。一般的，我们在定义自定义注解时，需要指定的元注解有两个（另外还有@Documented 与 @Inherited 元注解，前者用于被javadoc工具提取成文档，后者表示允许子类继承父类中定义的注解。） ：

@Target

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

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

@Retention

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

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

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

下面来看例子：

package com.coy.annotationdemo;

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

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

1.1.3 注解类型元素

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

package com.coy.annotationdemo;

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

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

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

package com.coy.annotationdemo;

public class AnnotationCaller {
//    @Donny("痞帅") //如果只存在value元素需要传值的情况，则可以省略:元素名=
    @Donny(value = "痞帅", age = 24)
    int a = 1;
}

1.2 注解应用场景

根据注解的保留级别不同，对注解的使用自然存在不同场景。由注解的三个不同保留级别可知，注解作用于： 源码、字节码与运行时。按照@Retention 元注解定义的注解存储方式，注解可以被在三种场景下使用：

1.2.1 SOURCE

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

添加一个注解Test:

package com.coy.annotationdemo;

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}

使用该注解与Donny注解做一个对比

package com.coy.annotationdemo;

@Donny()
public class AnnotationCaller {

    @Test
    public void test() {
        System.out.println("AnnotationCaller test()");
    }
}

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

IDE语法检查

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

@Retention(SOURCE) //源码级别注解
@Target({ANNOTATION_TYPE})
public @interface IntDef {
    /** Defines the constant prefix for this element */
    String[] prefix() default {};
    /** Defines the constant suffix for this element */
    String[] suffix() default {};

    /** 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倍的内存占用。此注解的意义在于能够取代枚举，实现如方法入参限制。

如：我们定义方法 test ，此方法接收参数 teacher 需要在：TEACHER_MATH、TEACHER_ENGLISH中选择一个。如果使用枚举能够实现为：

package com.coy.annotationdemo;

package com.coy.annotationdemo;

public class TeacherEnum {
    public enum Teacher {
        TEACHER_MATH, TEACHER_ENGLISH
    }

    public void test(Teacher teacher) {
    }
}

而现在为了进行内存优化，我们现在不再使用枚举，则方法定义为：

package com.coy.annotationdemo;

public class TeacherEnum {
    public static final int TEACHER_MATH = 0;
    public static final int TEACHER_ENGLISH = 1;

    public static String getTeacherName(int teacher) {
        switch (teacher) {
            case TEACHER_MATH:
                return "Math Teacher";
            case TEACHER_ENGLISH:
                return "English Teacher";
            default:
                return "Unknown Teacher";
        }
    }
}

然而此时，调用 test 方法由于采用基本数据类型 int ，将无法进行类型限定。比如：

public class AnnotationCaller {
    public void test() {
        TeacherEnum.getTeacherName(4); // 实际上我们只支持0和1也就是TEACHER_MATH和TEACHER_ENGLISH，但此时传入4我们没办法真实处理的
    }
}

此时使用 @IntDef 增加自定义注解：

package com.coy.annotationdemo;

import androidx.annotation.IntDef;

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

@IntDef(value = {
        TeacherEnum.TEACHER_MATH,
        TeacherEnum.TEACHER_ENGLISH
}) // 限定为数学老师，英语老师
@Target(ElementType.PARAMETER) //作用于参数的注解
@Retention(RetentionPolicy.SOURCE) //注解在源代码中有效，编译后不保留
public @interface Teacher {
}

然后修改方法：

package com.coy.annotationdemo;

public class TeacherEnum {
    public static final int TEACHER_MATH = 0;
    public static final int TEACHER_ENGLISH = 1;

    public static String getTeacherName(@Teacher int teacher) {
        switch (teacher) {
            case TEACHER_MATH:
                return "Math Teacher";
            case TEACHER_ENGLISH:
                return "English Teacher";
            default:
                return "Unknown Teacher";
        }
    }
}

此时，我们再去调用 getTeacherName方法，如果传递的参数不是 TEACHER_MATH 或者 TEACHER_ENGLISH则会显示 Inspection 警告 ( 编译不会报 错) 。

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

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

APT注解处理器

APT 全称为： "Anotation Processor Tools" ，意为注解处理器。顾名思义，其用于处理注解。编写好的 Java 源文 件，需要经过 javac 的编译，翻译为虚拟机能够加载解析的字节码 Class 文件。 注解处理器是 javac 自带的一个工具，用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器(也就是说，APT的注解保持到源码阶段就足够了，因为在Javac将java文件编译成class文件时，就已经拉起注解处理器对注解进行处理了，也就是说APT是编译阶段就执行的任务)。 注册的注解处理器由 javac 调起，并将注解信息传递给注解处理器进行处理。

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

这里先简单的介绍一下注解处理处理器如何简单实现：

首先我们要创建了注解，那么要想注解产生作用，那就要创建对应的注解处理器也就是APT：

1. 首先我们创建一个lib库(一定要创建java lib库，否则引用不到相关的依赖)，

2. 创建Donny注解的处理器文件：

package com.coy.compiler;

import java.util.Set;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Messager;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;

public class DonnyProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        Messager messager = processingEnv.getMessager();
        // 打印log
        messager.printMessage(Diagnostic.Kind.NOTE, "================================");
        return false;
    }
}

AbstractProcessor是由JDK提供的，我们直接继承就可以，只有继承自AbstractProcessor，javac才认为是一个注解处理器。AbstractProcessor你可以理解android中的activity类。

写好了这个处理器之后，需要我们需要声明DonnyProcessor，就像MainActivity继承了activity之后，我们的要到manifest文件中对MainActivity进行声明，不然MainActivity对于AMS来讲，AMS也不是认识MainActivity的。所以我们为了让javac能够认识DonnyProcessor需要做个声明：DonnyProcessor的声明的格式也比较固定就是在lib库的main目录下创建resources->META-INF->services->javax.annotation.ocessing.Processor，然后在javax.annotation.ocessing.Processor文件中写上注解处理程序的全类名：

3. 我们的程序中会有很多的注解，那么DonnyProcessor如何知道处理哪一个注解呢？那就需要我们在注解处理程序中进行指定，也就是说DonnyProcessor只处理我们指定的注解：

package com.coy.compiler;

import java.util.Set;

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Messager;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;

@SupportedAnnotationTypes("com.coy.annotationdemo.Donny") // 指定支持的注解类型
public class DonnyProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        Messager messager = processingEnv.getMessager();
        // 打印log
        messager.printMessage(Diagnostic.Kind.NOTE, "================================");

        // 省略具体注解处理逻辑.....
        return false;
    }
}

到此我们的注解处理程序已经写完了，那么接下里就是我们在模块中的引用了:

annotationProcessor project(':compiler')

1.2.2 CLASS

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

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

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

package com.coy.annotationdemo.clazz;

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
public @interface Login {
}

package com.coy.annotationdemo;

import com.coy.annotationdemo.clazz.Login;
import com.coy.annotationdemo.source.Donny;
import com.coy.annotationdemo.source.TeacherEnum;
import com.coy.annotationdemo.source.Test;


public class AnnotationCaller {
    
    @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));
}

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

其实说到这里就不得不说一下题外话 ASM 字节码插桩 的技术了：ASM字节码插桩

1.2.3 RUNTIME

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

2 反射

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

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

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

2.1 Class

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

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

2.2 获得 Class 对象

获取 Class对象的三种方式

1.  通过类名获取 类名.class
2.  通过对象获取 对象名.getClass()
3.  通过全类名获取 Class.forName(全类名) classLoader.loadClass(全类名)

• 使用 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();

3.3 判断是否为某个类的实例

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

public native boolean isInstance(Object obj);

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

public boolean isAssignableFrom(Class<?> cls)

3.4 创建实例

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

• 使用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)

3.5 获取构造器信息

得到构造器的方法

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

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

public T newInstance(Object ... initargs)

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

获得字段信息的方法

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

3.7 调用方法

获得方法信息的方法

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)

3.8 利用反射创建数组

数组在 Java 里是比较特殊的一种类型，它可以赋值给一个 Object Reference 其中的 Array 类为

java.lang.reflflect.Array 类。我们通过 Array.newInstance() 创建数组对象，它的原型是 :

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

3.9 反射获取泛型真实类型

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

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

3.9.1 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()) { // class java.lang.Object
            System.out.println(type);
        }
    }
}

3.9.2 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
        }
    }
}

3.9.3 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());
    }
}

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

3.9.5 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 + '}';
    }
}

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);
    //为什么TypeToken要定义为抽象类？
    Response<Data> resp = gson.fromJson(json, new TypeToken<Response<Data>>() {
    }.getType());
    System.out.println(resp.data.result);
}

在进行 GSON 反序列化时，存在泛型时，可以借助 TypeToken 获取 Type 以完成泛型的反序列化。但是为什么TypeToken 要被定义为抽象类呢？

因为只有定义为抽象类或者接口，这样在使用时，需要创建对应的实现类，此时确定泛型类型，编译才能够将泛型signature信息记录到 Class 元数据中。

3 动态代理原理

有动态代理，固然就有静态代理，循序渐进，先看一下静态代理：

3.1 静态代理

代理模式给某一个对象提供一个代理对象，并由代理对象控制对原对象的引用。通俗的来讲代理模式就是我们生活中常见的中介。比如你按照小卡片上的电话打过去寻求服务，一般不是由本人，可能是一个成年雄性接听电话，然而真正做事情的可能是另一个小姐姐。

目的：

1. 通过引入代理对象的方式来间接访问目标对象，防止直接访问目标对象给系统带来的不必要复杂性；
2. 通过代理对象对访问进行控制；

代理模式一般会有三个角色：

抽象角色 ：指代理角色和真实角色对外提供的公共方法，一般为一个接口

真实角色 ：需要实现抽象角色接口，定义了真实角色所要实现的业务逻辑，以便供代理角色调用。也就是真正的业务逻辑在此。

代理角色 ：需要实现抽象角色接口，是真实角色的代理，通过真实角色的业务逻辑方法来实现抽象方法，并可以附加自己的操作。将统一的流程控制都放到代理角色中处理！

静态代理在使用时 , 需要定义接口或者父类 , 被代理对象与代理对象一起实现相同的接口或者是继承相同父类。一般来说，被代理对象和代理对象是一对一的关系，当然一个代理对象对应多个被代理对象也是可以的。

静态代理，一对一则会出现时静态代理对象量多、代码量大，从而导致代码复杂，可维护性差的问题，一对多则代理对象会出现扩展能力差的问题。

举个简单的例子：

现在一个房东有一个住宅和商铺需要出租，但是房东又不想自己去直接找客户，那就可以委托给中介进行操作，但实际上真正的操作还是房东在做，我们来看一下具体的实现：

整天看一下结构：

首先是2个接口类：

package com.coy.annotationdemo.StaticProxy.inter;

/**
 * 住宅接口
 */
public interface Housing {
    /**
     * 租房
     */
    void rent();

    /**
     * 退租
     */
    void back();

    /**
     * 装修
     */
    void decoration();

    /**
     * 维修
     */
    void repair();
}

package com.coy.annotationdemo.StaticProxy.inter;

/**
 * 商铺接口
 */
public interface Shops {
    /**
     * 商铺名称
     */
    String getName();

    /**
     * 商铺地址
     */
    String getAddress();

    /**
     * 商铺电话
     */
    String getPhone();

    /**
     * 商铺营业时间
     */
    String getOpenTime();

    /**
     * 商铺打折信息
     */
    String getDiscount();
}

接着就是代理对象：

package com.coy.annotationdemo.StaticProxy.proxy;

import com.coy.annotationdemo.StaticProxy.inter.Housing;

public class HousingProxy implements Housing {

    private Housing housing;

    public HousingProxy(Housing housing) {
        this.housing = housing;
    }

    @Override
    public void rent() {
        System.out.println("代理租房");
        housing.rent();
    }

    @Override
    public void back() {
        System.out.println("房屋代理人：房屋归还中...");
        housing.back();
        System.out.println("房屋代理人：房屋归还完成");
    }

    @Override
    public void decoration() {
        System.out.println("房屋代理人：房屋装修中...");
        housing.decoration();
        System.out.println("房屋代理人：房屋装修完成");
    }

    @Override
    public void repair() {
        System.out.println("房屋代理人：房屋维修中...");
        housing.repair();
        System.out.println("房屋代理人：房屋维修完成");
    }
}

package com.coy.annotationdemo.StaticProxy.proxy;

import com.coy.annotationdemo.StaticProxy.inter.Shops;

/**
 * 商铺代理类
 */
public class ShopsProxy implements Shops {

    private Shops shops;

    public ShopsProxy(Shops shops) {
        this.shops = shops;
    }

    @Override
    public String getName() {
        System.out.println("ShopsProxy getName");
        return shops.getName();
    }

    @Override
    public String getAddress() {
        System.out.println("ShopsProxy getAddress");
        return shops.getAddress();
    }

    @Override
    public String getPhone() {
        System.out.println("ShopsProxy getPhone");
        return shops.getPhone();
    }

    @Override
    public String getOpenTime() {
        System.out.println("ShopsProxy getOpenTime");
        return shops.getOpenTime();
    }

    @Override
    public String getDiscount() {
        System.out.println("ShopsProxy getDiscount");
        return shops.getDiscount();
    }
}

真实对象：

package com.coy.annotationdemo.StaticProxy.real;

import com.coy.annotationdemo.StaticProxy.inter.Housing;
import com.coy.annotationdemo.StaticProxy.inter.Shops;

public class LandLord implements Housing, Shops {
    @Override
    public void rent() {
        System.out.println("房东出租房子");
    }

    @Override
    public void back() {
        System.out.println("房东收回房子");
    }

    @Override
    public void decoration() {
        System.out.println("房东装修房子");
    }

    @Override
    public void repair() {
        System.out.println("房东维修房子");
    }

    @Override
    public String getName() {
        return "房东";
    }

    @Override
    public String getAddress() {
        return "房东地址";
    }

    @Override
    public String getPhone() {
        return "房东电话";
    }

    @Override
    public String getOpenTime() {
        return "房东营业时间";
    }

    @Override
    public String getDiscount() {
        return "房东折扣";
    }
}

调用者：

package com.coy.annotationdemo.StaticProxy;

import com.coy.annotationdemo.StaticProxy.proxy.HousingProxy;
import com.coy.annotationdemo.StaticProxy.proxy.ShopsProxy;
import com.coy.annotationdemo.StaticProxy.real.LandLord;

public class StaticProxy {
    public static void main(String[] args) {
        // 创建住宅对象
        LandLord realSubject = new LandLord();
        // 创建住宅代理对象
        HousingProxy proxySubject = new HousingProxy(realSubject);
        // 调用代理方法
        proxySubject.rent();

        // 创建商铺对象
        LandLord realShop = new LandLord();
        // 创建商铺代理对象
        ShopsProxy proxyShop = new ShopsProxy(realShop);
        // 调用代理方法
        proxyShop.getAddress();

    }
}

从上面这个简单的例子就可以看出来，有一个接口就会多一个对应的代理对象，从而形成一对一的关系，导致代码量偏大，那你可能就会问了，那代理能不能代理多个接口呢？答案当然是可以的，使用动态代理就可以代理多个接口。

3.2 动态代理

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

//抽象角色
interface Api {
    void test(String a);
}

//真实角色
class ApiImpl {
    @Override
    public void test(String a) {
        System.out.println("真实实现：" + a);
    }
}

//创建真实角色实例
ApiImpl api = new ApiImpl();
//JDK动态代理:
Proxy.newProxyInstance(getClass().getClassLoader(),new Class[]{Api.class}/*JDK实现只能代理接口*/, new InvocationHandler() {
    @Override
    public Object invoke (Object proxy, Method method, Object[]args) throws Throwable {
        //执行真实对象方法
        return method.invoke(api, args);
    }
});

实际上， Proxy.newProxyInstance 会创建一个 Class ，与静态代理不同，这个 Class 不是由具体的 .java 源文件编译而来，即没有真正的文件，只是在内存中按照Class 格式生成了一个 Class 。

private static void proxy() throws Exception {
	String name = Api.class.getName() + "$Proxy0"; // Api为接口类，你的接口类是什么，这个位置就可以替换成什么
	//生成代理指定接口的Class数据
	byte[] bytes = ProxyGenerator.generateProxyClass(name, new Class[]{Api.class});
	FileOutputStream fos = new FileOutputStream("lib/" + name + ".class");
	fos.write(bytes);
	fos.close();
}

然后可以在生成的文件中查看我们的代理类：

在初始化时，获得 method 备用。而这个代理类中所有方法的实现变为：

这里的 h 其实就是 InvocationHandler 接口，所以我们在使用动态代理时，传递的 InvocationHandler 就是一个监听，在代理对象上执行方法，都会由这个监听回调出来。