Java代理模式

作者: 旧城城旧 | 来源:发表于2018-02-04 14:32 被阅读0次

代理模式

代理(Proxy)是一种设计模式,提供了对目标对象另外的访问方式;即通过代理对象访问目标对象.这样做的好处是:可以在目标对象实现的基础上,增强额外的功能操作,即扩展目标对象的功能.
java编程思想：开闭原则，指的是：对修改关闭，扩展开放.
草图一枚：

代理模式访问图.png
使用代理模式的关键点:通过代理对象，访问目标对象，不是直接访问目标对象

举个栗子：

找一个你不认识的人办事，但是直接找那人，人家不给你办呀，那么就需要找关系了，找的那个关系就可以理解成代理人。
对于真正的代理模式，我觉得这个栗子不是很恰当，但是理解间接的完成事情功能就可以了。

代理模式分类

静态代理
动态代理(JDK代理)
cglib代理(字类代理)

下面我们分别阐述哈代理模式

静态代理

静态代理在使用时,需要定义接口或者父类,被代理对象与代理对象一起实现相同的接口或者是继承相同父类.
栗子：
为方法增加日志采集

思路：为dao层每一个方法新增日志采集功能。
定义一个接口，并添加实现类，然后建立代理对象类，增加日志采集功能，调用代理对象。
代码如下：
dao层接口：

  package com.lnlr.logproxy;

/**
 * @author  雷洪飞
 */
public interface ITestDao {

    /**
     * 保存对象
     */
    void save();
}

dao层实现：

package com.lnlr.logproxy;

/**
 * @author 雷洪飞
 */
public class TestDaoImpl implements ITestDao {

    /**
     * 实现保存接口
     */
    @Override
    public void save() {
        System.out.println("保存实体对象");
    }
}

静态代理工厂：

package com.lnlr.logproxy;

/**
 * @author 雷洪飞
 * 静态代理工厂对象
 * 必须实现目标对象相同的接口或者继承目标对象相同的父类
 */
public class StaticProxyFactory implements ITestDao {

    /**
     * 共同的接口
     */
    private ITestDao iTestDao;

    public StaticProxyFactory(ITestDao iTestDao) {
        this.iTestDao = iTestDao;
    }

    @Override
    public void save() {
        System.out.println("添加保存日志");
        iTestDao.save();
        System.out.println("日志采集结束");
    }
}

测试代码：

package com.lnlr.logproxy;

import org.junit.Test;

/**
 * @author 雷洪飞
 */
public class App {
    @Test
    public void staticProxy() {
        ITestDao iTestDao = new TestDaoImpl();
        StaticProxyFactory staticProxy = new StaticProxyFactory(iTestDao);
        staticProxy.save();
    }
}

测试结果:为保存方法新增上了日志采集功能

静态代理.png
思考静态代理：
1.可以做到在不修改目标对象的功能前提下,对目标功能扩展.
2.缺点:

因为代理对象需要与目标对象实现一样的接口,所以会有很多代理类,类太多.同时,一旦接口增加方法,目标对象与代理对象都要维护.

说明这个我们一般不用的啦，不然人都要累死。

动态代理(JDK代理)

原理：利用JDK的API,动态的在内存中构建代理对象，必须是实现接口，不能是继承，动态代理类们无法实现对class的动态代理，原因是多继承在Java中本质上就行不通，可参考彻底理解JAVA动态代理

api: java.lang.reflect.Proxy对象
具体实现方法为：

newProxyInstance(ClassLoader loader,
                   Class<?>[] interfaces,
                   InvocationHandler h)
          throws IllegalArgumentException返回一个指定接口的代理类实例，该接口可以将方法调用指派到指定的调用处理程序。此方法相当于：
      Proxy.getProxyClass(loader, interfaces).
      getConstructor(new Class[] { InvocationHandler.class }).
      newInstance(new Object[] { handler });
      Proxy.newProxyInstance 抛出 IllegalArgumentException，原因与 Proxy.getProxyClass 相同。
      参数：
      loader - 定义代理类的类加载器
      interfaces - 代理类要实现的接口列表
      h - 指派方法调用的调用处理程序
      返回：
      一个带有代理类的指定调用处理程序的代理实例，它由指定的类加载器定义，并实现指定的接口
      抛出：
      IllegalArgumentException - 如果违反传递到 getProxyClass 的参数上的任何限制
      NullPointerException - 如果 interfaces 数组参数或其任何元素为 null，或如果调用处理程序 h 为 null

参数解释:

ClassLoader loader,:指定当前目标对象使用类加载器,获取加载器的方法是固定的
Class<?>[] interfaces,:目标对象实现的接口的类型,使用泛型方式确认类型
InvocationHandler h:事件处理,执行目标对象的方法时,会触发事件处理器的方法,会把当前执行目标对象的方法作为参数传入。

那就来一波代码说明：
与静态一样，下面就只给出动态代理工厂和测试代码即可
代理工厂：

package com.lnlr.logproxy;

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

/**
 * @author 雷洪飞
 * 利用jdk代理实现日志采集
 */
public class DynamicProxyFactory {
        // 目标对象，是一个object
    private Object target;

    public DynamicProxyFactory(Object target) {
        this.target = target;
    }

    public Object getProxyInstance() {
        return Proxy.newProxyInstance(
                target.getClass().getClassLoader(), 
                target.getClass().getInterfaces(),
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        System.out.println("动态代理日志采集");
                        Object invoke = method.invoke(target, args);
                        System.out.println("动态代理日志采集结束");
                        return invoke;
                    }
                }
        );
    }
}

测试代码：

        @Test
    public void dynamicProxy() {
        ITestDao iTestDao = new TestDaoImpl();
        ITestDao proxyInstance = (ITestDao) new DynamicProxyFactory(iTestDao).getProxyInstance();
        proxyInstance.save();
    }

结果：

动态代理

看一下代理类样子：
class com.sun.proxy.$Proxy8 后面的8不知道是不是jdk版本

思考：
动态代理可以代理目标对象父接口中的所有方法，避免了静态代理中的繁琐，也可以对method方法获取到指定的方法进行处理。
在实际开发中，用的也比较多。
缺点：

跟静态代理一样，没有实现接口的类就不能使用！
这里需要注意：我的jdk是1.8的，使用jdk代理必须只能实现接口，不能使用继承，使用继承将出现java.lang.ClassCastException: com.sun.proxy.$Proxy8 cannot be cast to com.lnlr.logproxy.ITestDao

"E:\Program Files\Java\jdk1.8.0_151\bin\java" -ea -Didea.test.cyclic.buffer.size=1048576 "-javaagent:E:\Program Files\JetBrains\IntelliJ IDEA 2017.3.1\lib\idea_rt.jar=52567:E:\Program Files\JetBrains\IntelliJ IDEA 2017.3.1\bin" -Dfile.encoding=UTF-8 -classpath "E:\Program Files\JetBrains\IntelliJ IDEA 2017.3.1\lib\idea_rt.jar;E:\Program Files\JetBrains\IntelliJ IDEA 2017.3.1\plugins\junit\lib\junit-rt.jar;E:\Program Files\JetBrains\IntelliJ IDEA 2017.3.1\plugins\junit\lib\junit5-rt.jar;C:\Users\leihf\.m2\repository\org\junit\platform\junit-platform-launcher\1.1.0-M2\junit-platform-launcher-1.1.0-M2.jar;C:\Users\leihf\.m2\repository\org\apiguardian\apiguardian-api\1.0.0\apiguardian-api-1.0.0.jar;C:\Users\leihf\.m2\repository\org\junit\platform\junit-platform-engine\1.1.0-M2\junit-platform-engine-1.1.0-M2.jar;C:\Users\leihf\.m2\repository\org\junit\platform\junit-platform-commons\1.1.0-M2\junit-platform-commons-1.1.0-M2.jar;C:\Users\leihf\.m2\repository\org\opentest4j\opentest4j\1.0.0\opentest4j-1.0.0.jar;C:\Users\leihf\.m2\repository\org\junit\jupiter\junit-jupiter-engine\5.1.0-M2\junit-jupiter-engine-5.1.0-M2.jar;C:\Users\leihf\.m2\repository\org\junit\jupiter\junit-jupiter-api\5.1.0-M2\junit-jupiter-api-5.1.0-M2.jar;C:\Users\leihf\.m2\repository\org\junit\vintage\junit-vintage-engine\4.12.0\junit-vintage-engine-4.12.0.jar;C:\Users\leihf\.m2\repository\org\junit\platform\junit-platform-engine\1.0.0\junit-platform-engine-1.0.0.jar;C:\Users\leihf\.m2\repository\org\junit\platform\junit-platform-commons\1.0.0\junit-platform-commons-1.0.0.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\charsets.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\deploy.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\access-bridge-64.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\cldrdata.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\dnsns.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\jaccess.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\jfxrt.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\localedata.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\nashorn.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\sunec.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\sunjce_provider.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\sunmscapi.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\sunpkcs11.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\ext\zipfs.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\javaws.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\jce.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\jfr.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\jfxswt.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\jsse.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\management-agent.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\plugin.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\resources.jar;E:\Program Files\Java\jdk1.8.0_151\jre\lib\rt.jar;E:\IDEA_WORK\web-project\jdbc-demo\target\classes;C:\Users\leihf\.m2\repository\commons-dbutils\commons-dbutils\1.7\commons-dbutils-1.7.jar;C:\Users\leihf\.m2\repository\mysql\mysql-connector-java\6.0.6\mysql-connector-java-6.0.6.jar;C:\Users\leihf\.m2\repository\junit\junit\4.12\junit-4.12.jar;C:\Users\leihf\.m2\repository\org\hamcrest\hamcrest-core\1.3\hamcrest-core-1.3.jar;C:\Users\leihf\.m2\repository\org\apache\commons\commons-dbcp2\2.2.0\commons-dbcp2-2.2.0.jar;C:\Users\leihf\.m2\repository\commons-logging\commons-logging\1.2\commons-logging-1.2.jar;C:\Users\leihf\.m2\repository\org\apache\commons\commons-pool2\2.5.0\commons-pool2-2.5.0.jar;C:\Users\leihf\.m2\repository\com\mchange\c3p0\0.9.5.2\c3p0-0.9.5.2.jar;C:\Users\leihf\.m2\repository\com\mchange\mchange-commons-java\0.2.11\mchange-commons-java-0.2.11.jar;C:\Users\leihf\.m2\repository\cglib\cglib\3.2.6\cglib-3.2.6.jar;C:\Users\leihf\.m2\repository\org\ow2\asm\asm\6.0\asm-6.0.jar;C:\Users\leihf\.m2\repository\org\apache\ant\ant\1.9.6\ant-1.9.6.jar;C:\Users\leihf\.m2\repository\org\apache\ant\ant-launcher\1.9.6\ant-launcher-1.9.6.jar" com.intellij.rt.execution.junit.JUnitStarter -ideVersion5 -junit5 com.lnlr.logproxy.App,dynamicProxy

java.lang.ClassCastException: com.sun.proxy.$Proxy8 cannot be cast to com.lnlr.logproxy.ITestDao

    at com.lnlr.logproxy.App.dynamicProxy(App.java:19)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:498)
    at org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:436)
    at org.junit.jupiter.engine.execution.ExecutableInvoker.invoke(ExecutableInvoker.java:115)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeTestMethod$6(TestMethodTestDescriptor.java:170)
    at org.junit.jupiter.engine.execution.ThrowableCollector.execute(ThrowableCollector.java:40)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeTestMethod(TestMethodTestDescriptor.java:166)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:113)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:58)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.lambda$executeRecursively$3(HierarchicalTestExecutor.java:112)
    at org.junit.platform.engine.support.hierarchical.SingleTestExecutor.executeSafely(SingleTestExecutor.java:66)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.executeRecursively(HierarchicalTestExecutor.java:108)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.execute(HierarchicalTestExecutor.java:79)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.lambda$executeRecursively$2(HierarchicalTestExecutor.java:120)
    at java.util.stream.ForEachOps$ForEachOp$OfRef.accept(ForEachOps.java:184)
    at java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:175)
    at java.util.Iterator.forEachRemaining(Iterator.java:116)
    at java.util.Spliterators$IteratorSpliterator.forEachRemaining(Spliterators.java:1801)
    at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481)
    at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471)
    at java.util.stream.ForEachOps$ForEachOp.evaluateSequential(ForEachOps.java:151)
    at java.util.stream.ForEachOps$ForEachOp$OfRef.evaluateSequential(ForEachOps.java:174)
    at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
    at java.util.stream.ReferencePipeline.forEach(ReferencePipeline.java:418)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.lambda$executeRecursively$3(HierarchicalTestExecutor.java:120)
    at org.junit.platform.engine.support.hierarchical.SingleTestExecutor.executeSafely(SingleTestExecutor.java:66)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.executeRecursively(HierarchicalTestExecutor.java:108)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.execute(HierarchicalTestExecutor.java:79)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.lambda$executeRecursively$2(HierarchicalTestExecutor.java:120)
    at java.util.stream.ForEachOps$ForEachOp$OfRef.accept(ForEachOps.java:184)
    at java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:175)
    at java.util.Iterator.forEachRemaining(Iterator.java:116)
    at java.util.Spliterators$IteratorSpliterator.forEachRemaining(Spliterators.java:1801)
    at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481)
    at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471)
    at java.util.stream.ForEachOps$ForEachOp.evaluateSequential(ForEachOps.java:151)
    at java.util.stream.ForEachOps$ForEachOp$OfRef.evaluateSequential(ForEachOps.java:174)
    at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
    at java.util.stream.ReferencePipeline.forEach(ReferencePipeline.java:418)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.lambda$executeRecursively$3(HierarchicalTestExecutor.java:120)
    at org.junit.platform.engine.support.hierarchical.SingleTestExecutor.executeSafely(SingleTestExecutor.java:66)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.executeRecursively(HierarchicalTestExecutor.java:108)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor$NodeExecutor.execute(HierarchicalTestExecutor.java:79)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute(HierarchicalTestExecutor.java:55)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:43)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:170)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:154)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:90)
    at com.intellij.junit5.JUnit5IdeaTestRunner.startRunnerWithArgs(JUnit5IdeaTestRunner.java:65)
    at com.intellij.rt.execution.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:47)
    at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
    at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)


Process finished with exit code -1

cglib代理

解释：静态代理和动态代理模式都是要求目标对象是实现一个接口的目标对象,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候就可以使用以目标对象子类的方式类实现代理,这种方法就叫做:cglib代理(子类代理)
原理：它是在内存中构建一个子类对象从而实现对目标对象功能的扩展.
JDK的动态代理有一个限制,就是使用动态代理的对象必须实现一个或多个接口,如果想代理没有实现接口的类,就可以使用cglib实现.
cglib是一个强大的高性能的代码生成包,它可以在运行期扩展java类与实现java接口.它广泛的被许多AOP的框架使用,例如Spring AOP（在aop中都是使用代理）和synaop,为他们提供方法的interception(拦截)，cglib包的底层是通过使用一个小而快的字节码处理框架ASM来转换字节码并生成新的类.不鼓励直接使用ASM,因为它要求你必须对JVM内部结构包括class文件的格式和指令集都很熟悉.

注意：原理很重要，构建子类对象。
cglib开发流程：

引入cglib包，我使用的是maven 构建的工程，spring 框架中core包中自带，我用的是5.x版本。

maven 引入
   <!-- https://mvnrepository.com/artifact/cglib/cglib -->
        <dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib</artifactId>
            <version>3.2.6</version>
        </dependency>

编写代理工厂
调用cglib代理

代码如下：
工厂：

package com.lnlr.logproxy;

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;

/**
 * @author 雷洪飞
 * cglib代理
 */
public class CglibProxyFactory implements MethodInterceptor {

    private Object target;

    public CglibProxyFactory(Object target) {
        this.target = target;
    }

    /**
     * 过程
     * @return
     */
    public Object getInstances() {
        // 工具类
        Enhancer enhancer = new Enhancer();
        // 设置父类
        enhancer.setSuperclass(target.getClass());
        // 设置回调函数
        enhancer.setCallback(this);
        // 创建子类(代理对象)
        return enhancer.create();
    }


    /**
     * 业务处理方法
     * @param o
     * @param method
     * @param objects
     * @param methodProxy
     * @return
     * @throws Throwable
     */
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        System.out.println("cglib日志采集开始");
        Object invoke = method.invoke(target, objects);
        System.out.println("cglib日志采集结束");
        return invoke;
    }
}

测试代码：

@Test
    public void cglibProxy() {
        ITestDao iTestDao = new TestDaoImpl();
        ITestDao instances = (ITestDao) new CglibProxyFactory(iTestDao).getInstances();
        instances.save();
    }

看一下代理类的样子：
class com.lnlr.logproxy.TestDaoImpl$$EnhancerByCGLIB$$361dc20b

总结cglib代理：
注意到cglib的实现原理，是在内存中创建子类来实现，那么final/static关键字都会有影响。

final不能被继承
static关键字不能被重写，那么就不能被cglib拦截到

Java代理模式

代理模式

举个栗子：

代理模式分类

静态代理

动态代理(JDK代理)

cglib代理

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Java 杂谈