将cglib动态代理思想带入Android开发

Posted 2023-03-01 zhangke3016

动态代理在android实际开发中用的并不是很多，但在设计框架的时候用的就比较多了，最近在看J2EE一些东西，像Spring，Hibernate等都有通过动态代理来实现方法增强、方法拦截等需要，通过代理的方式优雅的实现AOP编程。我们今天来看看这个代理究竟是什么样子，在Android开发中如何使用它，以及将cglib动态代理思想在Android中看看如何实现。

项目地址：MethodInterceptProxy

一、什么是代理

通常我们说的代理，在生活中就像中介、经纪人的角色。

目标对象/被代理对象 —— 房主：真正的租房的方法
代理对象 ——- 黑中介：有租房子的方法（调用房主的租房的方法）
执行代理对象方法的对象 —- 租房的人

流程：我们要租房—–>中介（租房的方法）——>房主（租房的方法）
抽象：调用对象—–>代理对象——>目标对象

二、静态代理

先看看比较常见的静态代理，也就是装饰设计模式：
首先建一个Star接口：

public interface Star 

    void singSong();

然后建Star子类SuperStar

public class SuperStar implements Star 

    @Override
    public void singSong() 
        System.out.println("唱歌啦--------");
    

最后我们创建SuperStar的代理类SuperStarProxy

public class SuperStarProxy implements Star 

    private Star star;

    SuperStarProxy(Star star)
        this.star = star;
    

    @Override
    public void singSong() 
        System.out.println("before-------------");
        star.singSong();
        System.out.println("after-------------");
    


    public static void main(String[] args) 
        Star star = new SuperStarProxy(new SuperStar());
        star.singSong();
    

我们将需要代理的对象传进来生成代理对象，之后只需要使用代理对象来处理相关业务就可以了。

三、动态代理

静态代理需要为每一个需要代理的类写一个代理类，为每一个需要代理的方法重写代理方法，如果有上百个类或者类里方法很多，那重复的工作量也是很可观的。JDK提供了动态代理方式，可以简单理解为在JVM可以在运行时帮我们动态生成一系列的代理类，这样我们就不需要手写每一个静态的代理类了。

        final Star star = new SuperStar();
        Star st = (Star) Proxy.newProxyInstance(Star.class.getClassLoader(), star.getClass().getInterfaces(), new InvocationHandler() 

            @Override
            public Object invoke(Object proxy, Method method, Object[] args)
                    throws Throwable 
                System.out.println("before---------");
                Object object = method.invoke(star, args);
                System.out.println("after---------");

                return object;
            
        );
        st.singSong();

newProxyInstance(ClassLoader loader, Class

四、cglib

cglib是一个功能强大，高性能的代码生成包。它为没有实现接口的类提供代理，为JDK的动态代理提供了很好的补充。通常可以使用Java的动态代理创建代理，但当要代理的类没有实现接口或者为了更好的性能，cglib是一个好的选择。
但是但是但是，一个很致命的缺点是：cglib底层采用ASM字节码生成框架，使用字节码技术生成代理类，也就是生成的.class文件，而我们在android中加载的是优化后的.dex文件，也就是说我们需要可以动态生成.dex文件代理类，cglib在android中是不能使用的。但后面我们会根据dexmaker框架来仿照动态生成.dex文件，实现cglib的动态代理功能。
好了，我们先来看下cglib的强大吧～
举个例子，boss安排要实现一个人员管理的增删改查功能，那这个简单，三两下就搞定：

public class PeopleService 

    public void add()
        System.out.println("add-----------");
    
    public void delete()
        System.out.println("delete-----------");
    
    public void update()
        System.out.println("update-----------");
    
    public void select()
        System.out.println("select-----------");
    

OK,搞定～但是呢，需求是不断变化的，过了几天，boss又发话了，说不是每个人都可以使用这个增删改查功能的，要指定人员才可以使用，那。。我们就改吧～最直接的方式，在每个方法上都加上判断条件，但这么做多少有点太挫了，如果有五十个方法，那我们这么多方法就要都加一遍，用cglib我们可以这么做：

        final String name = "张si";
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(PeopleService.class);
        //目标对象拦截器，实现MethodInterceptor 
        //Object object为目标对象 
        //Method method为目标方法 
        //Object[] args 为参数， 
        //MethodProxy proxy CGlib方法代理对象 
        enhancer.setCallback(new MethodInterceptor() 
            @Override
            public Object intercept(Object object, Method method, Object[] args,
                    MethodProxy proxy) throws Throwable 
                Object obj = null;
                if(name.equals("张三"))
                     obj = proxy.invokeSuper(object, args); ;
                else
                    System.out.println("----对不起，您没有权限----");
                
                return obj;
            
        );
        PeopleService ps = (PeopleService) enhancer.create();
        ps.add();

只需添加一个拦截器，就可以拦截所有增删改查操作，从切面进行统一管理，代码量也不多。
又过了几天，boss又发话了，我们的增删改查不是都要有限制，只有查找才对特定人员有限制，那我们就继续改喽～
这个时候我们就可以加入过滤器CallbackFilter：

final String name = "张武";
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(PeopleService.class);
        //目标对象拦截器，实现MethodInterceptor 
        //Object object为目标对象 
        //Method method为目标方法 
        //Object[] args 为参数， 
        //MethodProxy proxy CGlib方法代理对象 
        MethodInterceptor interceptor = new MethodInterceptor() 
            @Override
            public Object intercept(Object object, Method method, Object[] args,
                    MethodProxy proxy) throws Throwable 
                Object obj = null;
                if(name.equals("张三"))
                     obj = proxy.invokeSuper(object, args); ;
                else
                    System.out.println("----对不起，您没有权限----");
                
                return obj;
            
        ;
        //NoOp.INSTANCE：这个NoOp表示no operator，即什么操作也不做，代理类直接调用被代理的方法不进行拦截
        enhancer.setCallbacks(new Callback[]interceptor,NoOp.INSTANCE);
        enhancer.setCallbackFilter(new CallbackFilter() 
            //过滤方法 
            //返回的值为数字，代表了Callback数组中的索引位置，要到用的Callback 
            @Override
            public int accept(Method method) 
                if(method.getName().equals("select"))
                    return 0;
                
                return 1;
            
        );
        PeopleService ps = (PeopleService) enhancer.create();
        ps.add();

我们没有修改一行原有的增删改查代码，通过传递代理对象的方式轻松解决方法拦截、方法增强的业务需求。
但遗憾的是，cglib不支持android平台。。。那我们就自己实现咯～在dexmaker和cglib-for-android库的基础上，修改部分代码后形成我们的类似cglib框架 MethodInterceptProxy ，实现上面需求只需这样写，和cglib写法一致:

        final String name = "张五";
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(PeopleService.class);
        //目标对象拦截器，实现MethodInterceptor 
        //Object object为目标对象 
        //Method method为目标方法 
        //Object[] args 为参数， 
        //MethodProxy proxy CGlib方法代理对象 
        MethodInterceptor interceptor = new MethodInterceptor() 
            @Override
            public Object intercept(Object object, Object[] args, MethodProxy methodProxy) throws Throwable 
                Object obj = null;
                if(name.equals("张三"))
                     obj = methodProxy.invokeSuper(object, args); ;
                else
                    System.out.println("----对不起，您没有权限----");
                
                return obj;
            
        ;
        //NoOp.INSTANCE：这个NoOp表示no operator，即什么操作也不做，代理类直接调用被代理的方法不进行拦截
        enhancer.setCallbacks(new MethodInterceptor[]interceptor,NoOp.INSTANCE);
        enhancer.setCallbackFilter(new CallbackFilter() 
            //过滤方法 
            //返回的值为数字，代表了Callback数组中的索引位置，要到用的Callback 
            @Override
            public int accept(Method method) 
                if(method.getName().equals("select"))
                    return 0;
                
                return 1;
            
        );
        PeopleService ps = (PeopleService) enhancer.create();
        ps.add();

项目地址：MethodInterceptProxy