Java动态代理

作者: R7_Perfect | 来源:发表于2019-07-29 11:11 被阅读1次

    动态代理是指在运行时动态生成代理类。即,代理类的字节码将在运行时生成并载入当前代理的 ClassLoader。与静态处理类相比,动态类有诸多好处。

    ①不需要写一个形式上完全一样的封装类;

    ②使用一些动态代理的生成方法甚至可以在运行时制定代理类的执行逻辑,从而大大提升系统的灵活性。

    java.lang.reflect.Proxy:这是生成代理类的主类,通过 Proxy 类生成的代理类都继承了 Proxy 类。
    Proxy提供了用户创建动态代理类和代理对象的静态方法,它是所有动态代理类的父类。
    java.lang.reflect.InvocationHandler:这里称他为"调用处理器",它是一个接口。当调用动态代理类中的方法时,将会直接转接到执行自定义的InvocationHandler中的invoke()方法。即我们动态生成的代理类需要完成的具体内容需要自己定义一个类,而这个类必须实现 InvocationHandler 接口,通过重写invoke()方法来执行具体内容。

    Proxy提供了如下两个方法来创建动态代理类和动态代理实例。
    static Class<?> getProxyClass(ClassLoader loader, Class<?>... interfaces) 返回代理类的java.lang.Class对象。第一个参数是类加载器对象(即哪个类加载器来加载这个代理类到 JVM 的方法区),第二个参数是接口(表明你这个代理类需要实现哪些接口),第三个参数是调用处理器类实例(指定代理类中具体要干什么),该代理类将实现interfaces所指定的所有接口,执行代理对象的每个方法时都会被替换执行InvocationHandler对象的invoke方法。

    **static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) **返回代理类实例。参数与上述方法一致。

    public class ProxyDemo {
        public static void main(String args[]){
            RealSubject subject = new RealSubject();
            Proxy p = new Proxy(subject);
            p.request();
        }
    }
    
    interface Subject{
        void request();
    }
    
    class RealSubject implements Subject{
        public void request(){
            System.out.println("request");
        }
    }
    
    class Proxy implements Subject{
        private Subject subject;
        public Proxy(Subject subject){
            this.subject = subject;
        }
        public void request(){
            System.out.println("PreProcess");
            subject.request();
            System.out.println("PostProcess");
        }
    }
    

    对应上述两种方法创建动态代理对象的方式:

     //创建一个InvocationHandler对象
            InvocationHandler handler = new MyInvocationHandler(.args..);
            //使用Proxy生成一个动态代理类
            Class proxyClass = Proxy.getProxyClass(RealSubject.class.getClassLoader(),RealSubject.class.getInterfaces(), handler);
            //获取proxyClass类中一个带InvocationHandler参数的构造器
            Constructor constructor = proxyClass.getConstructor(InvocationHandler.class);
            //调用constructor的newInstance方法来创建动态实例
            RealSubject real = (RealSubject)constructor.newInstance(handler);
    
    //创建一个InvocationHandler对象
            InvocationHandler handler = new MyInvocationHandler(.args..);
            //使用Proxy直接生成一个动态代理对象
            RealSubject real =Proxy.newProxyInstance(RealSubject.class.getClassLoader(),RealSubject.class.getInterfaces(), handler);
    

    newProxyInstance这个方法实际上做了两件事:第一,创建了一个新的类【代理类】,这个类实现了Class[] interfaces中的所有接口,并通过你指定的ClassLoader将生成的类的字节码加载到JVM中,创建Class对象;第二,以你传入的InvocationHandler作为参数创建一个代理类的实例并返回。

    动态代理模式的简单实现

    public class DynamicProxyDemo {
        public static void main(String[] args) {
            //1.创建目标对象
            RealSubject realSubject = new RealSubject();    
            //2.创建调用处理器对象
            ProxyHandler handler = new ProxyHandler(realSubject);    
           //3.动态生成代理对象
            Subject proxySubject = (Subject)Proxy.newProxyInstance(RealSubject.class.getClassLoader(),
                                                            RealSubject.class.getInterfaces(), handler);   
            //4.通过代理对象调用方法   
            proxySubject.request();    
        }
    }
    
    /**
     * 主题接口
     */
    interface Subject{
        void request();
    }
    
    /**
     * 目标对象类
     */
    class RealSubject implements Subject{
        public void request(){
            System.out.println("====RealSubject Request====");
        }
    }
    /**
     * 代理类的调用处理器
     */
    class ProxyHandler implements InvocationHandler{
        private Subject subject;
        public ProxyHandler(Subject subject){
            this.subject = subject;
        }
        @Override
        public Object invoke(Object proxy, Method method, Object[] args)
                throws Throwable {
            //定义预处理的工作,当然你也可以根据 method 的不同进行不同的预处理工作
            System.out.println("====before====");
           //调用RealSubject中的方法
            Object result = method.invoke(subject, args);
            System.out.println("====after====");
            return result;
        }
    }
    

    Retrofit 分析

    动态代理,让Retrofit将我们的接口变为具体的类

    public <T> T create(final Class<T> service) {
        //做一些安全判断,判断是否为接口,不是接口java原生的动态代理会报错
        Utils.validateServiceInterface(service);
        if (validateEagerly) {
          eagerlyValidateMethods(service);
        }
    
        //create其实就是通过Java的动态代理将接口中定义的方法转给了InvocationHandler的invoke方法
        //在通过loadServiceMethod调用invoke,来发起网络请求(下篇文章会讲)
        return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service }
                , new InvocationHandler() {
                  private final Platform platform = Platform.get();
                  private final Object[] emptyArgs = new Object[0];
    
                  @Override
                  public @Nullable Object invoke(Object proxy, Method method,
                                                 @Nullable Object[] args) throws Throwable {
                    // If the method is a method from Object then defer to normal invocation.
                    //如果该方法是Object自带的方法,那么我们直接反射出来这些方法就可以了
                    //比如说是.equest() 、 toString()
                    if (method.getDeclaringClass() == Object.class) {
                      return method.invoke(this, args);
                    }
                    // .isDefaultMethod是Java8的特性
                    //它的意思是接口中定义的方法,因为java8支持了接口定义默认方法(default)这一特性
                    //也就是说,这里的if是判断上述特性,如果是就直接调用
                    //如果不是,就使用loadServiceMethod来获取方法
                    if (platform.isDefaultMethod(method)) {
                      return platform.invokeDefaultMethod(method, service, proxy, args);
                    }
                    //返回了 封装了请求参数的一个接口,它知道怎么发起网络请求
                   ServiceMethod<Object, Object> serviceMethod =
                    (ServiceMethod<Object, Object>) loadServiceMethod(method);
                OkHttpCall<Object> okHttpCall = new OkHttpCall<>(serviceMethod, args);
                  return serviceMethod.callAdapter.adapt(okHttpCall);
                  }
                });
      }
    

    newProxyInstance 看看它到底是怎么将接口进行代理,生成接口的代理类

    //newProxyInstance传入了ClassLoader 还有接口,我们可以想象得到
    //他是通过ClassLoader来生成代理类的。
    public static Object newProxyInstance(ClassLoader loader,
                                              Class<?>[] interfaces,
                                              InvocationHandler h)
            throws IllegalArgumentException
        {
            ...
            /*
             * Look up or generate the designated proxy class.
                具体实现类代理的方法 getProxyClass0
             */
            Class<?> cl = getProxyClass0(loader, intfs);
    
            return cons.newInstance(new Object[]{h});
           ...
        }
    
    private static Class<?> getProxyClass0(ClassLoader loader,
                                               Class<?>... interfaces) {
            if (interfaces.length > 65535) {
                throw new IllegalArgumentException("interface limit exceeded");
            }
    
            // If the proxy class defined by the given loader implementing
            // the given interfaces exists, this will simply return the cached copy;
            // otherwise, it will create the proxy class via the ProxyClassFactory
            return proxyClassCache.get(loader, interfaces);
        }
    ...
    proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
    
    private static final class ProxyClassFactory
            implements BiFunction<ClassLoader, Class<?>[], Class<?>>{
            // prefix for all proxy class names
            private static final String proxyClassNamePrefix = "$Proxy";
    
            // next number to use for generation of unique proxy class names
            private static final AtomicLong nextUniqueNumber = new AtomicLong();
    
            @Override
            public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
    
                Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
                for (Class<?> intf : interfaces) {
                    /*
                     * Verify that the class loader resolves the name of this
                     * interface to the same Class object.
                     */
                    Class<?> interfaceClass = null;
                    try {
                        interfaceClass = Class.forName(intf.getName(), false, loader);
                    } catch (ClassNotFoundException e) {
                    }
                    if (interfaceClass != intf) {
                        throw new IllegalArgumentException(
                            intf + " is not visible from class loader");
                    }
                    /*
                     * Verify that the Class object actually represents an
                     * interface.
                     */
                    if (!interfaceClass.isInterface()) {
                        throw new IllegalArgumentException(
                            interfaceClass.getName() + " is not an interface");
                    }
                    /*
                     * Verify that this interface is not a duplicate.
                     */
                    if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
                        throw new IllegalArgumentException(
                            "repeated interface: " + interfaceClass.getName());
                    }
                }
    
                String proxyPkg = null;     // package to define proxy class in
                int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
    
                /*
                 * Record the package of a non-public proxy interface so that the
                 * proxy class will be defined in the same package.  Verify that
                 * all non-public proxy interfaces are in the same package.
                 */
                for (Class<?> intf : interfaces) {
                    int flags = intf.getModifiers();
                    if (!Modifier.isPublic(flags)) {
                        accessFlags = Modifier.FINAL;
                        String name = intf.getName();
                        int n = name.lastIndexOf('.');
                        String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
                        if (proxyPkg == null) {
                            proxyPkg = pkg;
                        } else if (!pkg.equals(proxyPkg)) {
                            throw new IllegalArgumentException(
                                "non-public interfaces from different packages");
                        }
                    }
                }
    
                if (proxyPkg == null) {
                    // if no non-public proxy interfaces, use the default package.
                    proxyPkg = "";
                }
    
                {
                    // Android-changed: Generate the proxy directly instead of calling
                    // through to ProxyGenerator.
                    List<Method> methods = getMethods(interfaces);
                    Collections.sort(methods, ORDER_BY_SIGNATURE_AND_SUBTYPE);
                    validateReturnTypes(methods);
                    List<Class<?>[]> exceptions = deduplicateAndGetExceptions(methods);
    
                    Method[] methodsArray = methods.toArray(new Method[methods.size()]);
                    Class<?>[][] exceptionsArray = exceptions.toArray(new Class<?>[exceptions.size()][]);
    
                    /*
                     * Choose a name for the proxy class to generate.
                     */
                    long num = nextUniqueNumber.getAndIncrement();
                    String proxyName = proxyPkg + proxyClassNamePrefix + num;
    
                    return generateProxy(proxyName, interfaces, loader, methodsArray,
                                         exceptionsArray);
                }
            }
        }
    

    generateProxy(proxyName, interfaces, loader, methodsArray, exceptionsArray)是一个native方法

    相关文章

      网友评论

        本文标题:Java动态代理

        本文链接:https://www.haomeiwen.com/subject/zbmvrctx.html