运用动态代理来提高代码的灵活性

前言

本文会简单介绍下 Java 中动态代理模式的使用，然后着重分享下动态代理如何在提高代码灵活性方面大展身手。文中会列举两个实例，一个是在 MVP 中如何巧妙解决 Presenter 中频繁使用 if (getView() != null) { } 这种重复代码的问题；另一个是在项目中如何让多个 modules 间解耦更加灵活、更加纯粹的问题。

动态代理的基本使用

要使用动态代理，主要涉及到两个类，一个是 Proxy 类，一个是 InvocationHandler 类。在介绍如何使用之前，需要明确的是：动态代理的代理对象只能是 Interface，不能是 Class ，也不能是 abstract class。这是因为所有动态生成的代理类都继承自 Proxy。而 java 是单继承的，所以只有接口对象能被动态代理。

回到刚才介绍的两个类，Proxy 描述了一个代理对象，同时它提供了创建并实例化一个代理对象的静态方法。InvocationHandler 是一个代理对象的调用处理器，它只有一个 invoke 方法，所有被代理的对象的方法调用都会通过这个方法执行，我们的代理行为也就是在这个方法里面实现的。下面给出一个很简单的示例：

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

public class DemonstrationProxy {

    interface A {
        void method();
    }


    static class AIpml implements A {

        @Override
        public void method() {
            System.out.println("method in AIpml");
        }
    }

    //动态代理对象
    static class AProxy implements InvocationHandler {
        
        //被代理的对象实例
        final Object origin;

        AProxy(Object origin) {
            this.origin = origin;
        }

        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            System.out.println("start to invoke method " + method.getName() + " proxy is " + proxy.getClass().getCanonicalName());
            //执行实际对象的方法
            return method.invoke(origin, args);
        }
    }

    public static void main(String[] args) {
        final A a = new AIpml();
        final InvocationHandler handler = new AProxy(a);
        final A proxyA = (A) Proxy.newProxyInstance(a.getClass().getClassLoader(), a.getClass().getInterfaces(), handler);
        proxyA.method();
    }
}

编译运行后你将看到如下输出：

start to invoke method proxy is $Proxy0
method in AIpml

MVP 中如何精简不必要的代码

在 MVP 的开发模式中，Presenter 持有 View 的引用，当我们需要与 View 进行交互时，通过 getView() 方法获得 View 对象。为了避免内存泄漏，在不需要 Presenter 的时候（比如在 Activity 的 onDestroyed() 生命周期）将 View 对象置空。然而此时可能一些异步任务没有结束，当它们结束后，getView() 就会返回 null 。为了避免 NPE，通常的做法是在所有异步任务里需要访问 View 的地方，都要进行 if(getView() != null) { } 这样的检查。当你写了好几个 Presenter 之后，便会发现这是一件很烦的事情，不仅仅是因为每次要写同样的东西，还有就是：

It's always a bad sign when the else branch is missing.

关于这个问题，在 Medium 上也有讨论，上面也列出了一些解决方案。比如用 ThirtyInch 这个第三方 MVP 框架，它把所有对 View 的操作封装为一个个的 ViewAction，TiPresenter 内部会管理这些 ViewAction 的运行。只有在 View attach 到 Presenter 的时候，才会执行 ViewAction，否则会保留 ViewAction 直到 View 再次 attach 到 Presenter。还有就是用 WeakReference 或者 Optional 来管理 View 。对于第一个，算是一个不错的解决方案，但它作为一个框架，使用它有一定的引入成本，还有另一个弊端就是 Presenter 和 View 的生命周期绑定得更加紧密，增加了 ViewAction 的维护成本 。对于第二个方案，感觉像是转移话题一样，并没有解决什么根本问题。

其实这个问题的源头在于 getView() 方法是 nullable 的，如果该方法返回的 View 能确保非空，而且不存在内存泄漏问题，且无论是 View 处于哪种生命周期代码都能得到正确的调用，那么问题就解决了。

此时就轮到动态代理出场了，当 View 还没结束的时候，getView() 对象返回的是真实的 View 对象，而当 View 的生命周期结束后，getView() 对象只需要返回一个代理 View 即可，这样就确保了 getView() 不会返回一个空的对象，自然就不需要反复检查，而且代理对象并不会对真实的 View 有任何的影响，所以代码逻辑也不会有任何问题。

Talk is cheap. Show me the code.

public class AbsPresenter implements IPresenter {

    private View mView;
    private Class mViewClass;

    public AbsPresenter(@NonNull View iView) {
        this.mView = iView;
        this.mViewClass = iView.getClass();
        if (this.mViewClass.getInterfaces().length == 0) {
            throw new IllegalArgumentException("iView must implement IView interface");
        }
    }

    public void detach() {
        this.mView = null;
    }

    public @NonNull View getView() {
        if (mView == null) {
            return ViewProxy.newInstance(mViewClass);
        }
        return mView;
    }

    private static final class ViewProxy implements InvocationHandler {

        public static  View newInstance(Class clazz) {
            return (View) Proxy.newProxyInstance(clazz.getClassLoader(), clazz.getInterfaces(), new ViewProxy());
        }

        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            Type type = method.getReturnType();
            if (type == boolean.class) {
                return false;
            } else if (type == int.class) {
                return 0;
            } else if (type == short.class) {
                return (short)0;
            } else if(type == char.class) {
                return (char)0;
            } else if (type == byte.class) {
                return (byte)0;
            } else if(type == long.class) {
                return 0L;
            } else if (type == float.class) {
                return 0f;
            } else if (type == double.class) {
                return 0D;
            } else {
                return null;
            }
        }
    }
}

这就是我在流利说项目里抽象出的 Presenter，主要展示了 getView() 方法是怎么利用动态代理保证返回值为非空。如此一来，就大可放心地在 Presenter 中使用 getView() 方法，而不用担心 NPE ，也不用担心内存泄漏，代码还能更干净，一举三得！

模块间结构如何更加灵活，更加精简

流利说项目里有很多代表不同功能的模块，为了将模块间解耦，我们在一个公共的模块中定义各个功能模块对外开放的接口，并在各自模块中实现。此外还需要一个类 (以下称作 ModuleProvider) 管理这些模块接口，它需要向外提供接口的 set 和 get 方法。在 Application 初始化的时候，通过反射将这些接口实例化，然后各个模块便可以通过 ModuleProvider 的 get 方法获取其他模块的接口。一切看起来既美好又和谐，可是这里有个问题，如果我正在开发 A 模块，为了更快的编译速度，我在 build.gradle 中去掉了 B 模块，ModuleProvider.getB() 将会返回为 null ，那么 A 模块中很多地方都会出现 NPE 。当然这可以通过判空解决，但显然很蠢，而且如此一来，代码岂不是解耦地不彻底？

一开始的做法是对于所有的接口都有一个默认的空实现，对应到上面的例子就是 ModuleProvider.getB() 会有两个不同的返回结果，一个是在 B 模块内对接口的实现，另一个是在公共模块的一个空实现 。如此一来，ModuleProvider.getB()方法就变成了这样：

public static B getB() {
    if (b == null) {
      b = new EmptyB();
    }
    return b;
  }

现在随意去掉不想要的模块也能愉快地敲代码了。

这样的实现看起来已经很不错了，可还是有优化的空间。问题在于每一个接口都有两个实现，每次要对接口作修改的时候，要同时维护两个实现类，而且其中一个实现并没有实际的作用，更多地是只想把精力放在模块中的实现上。这个时候动态代理又可以大显身手了。既然只是一个空实现，那么当模块不存在时返回一个接口的动态代理不就好了吗？最重要的是，现在不需要同时维护两个实现，可以集中精力在有意义的改动上。为此我在项目中提供了一个生成接口代理的工具类：

import com.xxx.xxx.annotations.SpecifyBooleanValue;
import com.xxx.xxx.annotations.SpecifyClassValue;
import com.xxx.xxx.annotations.SpecifyIntegerValue;
import com.xxx.xxx.annotations.SpecifyStringValue;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;


public class EmptyModuleProxy implements InvocationHandler {

    public static  T newInstance(Class clazz) {
        return (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class[]{clazz}, new EmptyModuleProxy());
    }

   @Override
   public Object invoke(Object o, Method method, Object[] objects) throws Throwable {
       final SpecifyClassValue specifyClassValue = method.getAnnotation(SpecifyClassValue.class);
       if (specifyClassValue != null) return specifyClassValue.returnValue();
       final SpecifyIntegerValue specifyIntegerValue = method.getAnnotation(SpecifyIntegerValue.class);
       if (specifyIntegerValue != null) return specifyIntegerValue.returnValue();
       final SpecifyStringValue specifyStringValue = method.getAnnotation(SpecifyStringValue.class);
       if(specifyStringValue != null) return specifyStringValue.returnValue();
       final SpecifyBooleanValue specifyBooleanValue = method.getAnnotation(SpecifyBooleanValue.class);
       if(specifyBooleanValue != null) return specifyBooleanValue.returnValue();
       return defaultValueByType(method.getReturnType());
   }

   private Object defaultValueByType(Class type) {
       if (type == boolean.class) {
           return false;
       } else if (type == int.class) {
           return 0;
       } else if (type == short.class) {
           return (short)0;
       } else if(type == char.class) {
           return (char)0;
       } else if (type == byte.class) {
           return (byte)0;
       } else if(type == long.class) {
           return 0L;
       } else if (type == float.class) {
           return 0f;
       } else if (type == double.class) {
           return 0D;
       } else {
           return null;
       }
   }
}

这样一来ModuleProvider.getB() 方法就变成这样：

public static B getB() {
    if (b == null) {
      b = EmptyModuleProxy.newInstance(B.class);
    }
    return b;
  }

至此，通过动态代理完美地解决了问题。注意到 EmptyModuleProxy 中还有很多注解，这是因为当一些模块没有引入的时候，希望它的某些接口能返回一些指定的值以方便测试，所以额外定义了一些注解来解决这个问题。比如 B 接口里面定义了一个 getBoolean() 方法，默认返回的是 false ，但实际上我希望在没有引入 B 模块的时候返回 true。那么 B 接口就可以做如下声明：

public interface B {

    @SpecifyBooleanValue(returnValue = true)
    Class getBoolean();
}

总结

通过 MVP 和模块间解耦这两个实际项目中的例子，能够充分地说明动态代理技术的运用，能够给我们的代码带来很多灵活性，让一些实现变得更加简洁、也更加优雅。当然动态代理能带给我们的不仅仅是灵活性。比如 Retrofit 就通过动态代理将我们声明的各种 Service 接口转换为一个个的 ServiceMethod ，然后交给 OkHttp 执行具体的网络操作，从而让网络请求变得如此优雅自然。所以说合理地运用这项技术，能让你把代码敲地更嗨！