- 什么是代理?
- 静态代理与动态代理
- 静态代理实例
- JDK动态代理实例
- CGLib 简介
- CGLib 与JDK动态代理的区别
1. 代理模式是Java中常见的一种模式,不多说,直接上代码。
静态代理UML类图
Subject:抽象主题角色,抽象主题类可以是抽象类,也可以是接口,是一个最普通的业务类型定义,无特殊要求。
RealSubject:具体主题角色,也叫被委托角色、被代理角色。是业务逻辑的具体执行者。
Proxy:代理主题角色,也叫委托类、代理类。它把所有抽象主题类定义的方法给具体主题角色实现,并且在具体主题角色处理完毕前后做预处理和善后工作。(最简单的比如打印日志):
2.静态代理与动态代理
按照代理创建的时期,可以分为动态代理和静态代理:
静态代理:由程序员或者自动生成工具生成代理类,然后进行代理类的编译和运行。在代理类、委托类运行之前,代理类已经以.class的格式存在。
动态代理:在程序运行时,由反射机制动态创建而成。
3.静态代理实例
静态代理实例:
首先需要一个接口:
- public interface Count {
- public void queryCount();
- public void updateCount();
- }
然后是真正实现类:
- public class CountImpl implements Count {
- @Override
- public void queryCount() {
- System.out.println("查看账户方法...");
- }
- @Override
- public void updateCount() {
- System.out.println("修改账户方法...");
- }
- }
最后是代理类:
- public class CountProxy implements Count {
- private CountImpl countImpl;
- public CountProxy(CountImpl countImpl) {
- this.countImpl = countImpl;
- }
- @Override
- public void queryCount() {
- System.out.println("事务处理之前");
- countImpl.queryCount();
- System.out.println("事务处理之后");
- }
- @Override
- public void updateCount() {
- System.out.println("事务处理之前");
- countImpl.updateCount();
- System.out.println("事务处理之后");
- }
- }
运行:
- package com.mahoutchina.pattern.proxy;
- public class CountTest {
- public static void main(String[] args) {
- CountImpl countImpl = new CountImpl();
- CountProxy countProxy = new CountProxy(countImpl);
- countProxy.updateCount();
- countProxy.queryCount();
- }
- }
从静态代理中可以看出:
1.接口:代理类需要实现一个接口,这个接口和委托类的接口是一样的,这样proxy才能和委托类行为表现一致
2. 方法(Method):由于接口限制,proxy类中也要有interface中的各个方法,这就造成了代码重复
4.动态代理实例
动态代理类克服了proxy需要继承专一的interface接口,并且要实现相应的method的缺陷。
java动态代理类位于java.lang.reflect包下,一般主要涉及到以下两个类:
- Interface InvocationHandler:该接口中仅定义了一个方法Object:invoke(Object obj,Method method, Object[] args)。在实际使用时,第一个参数obj一般是指代理 类,method是被代理的方法,如上例中的request(),args为该方法的参数数组。 这个抽 象方法在代理类中动态实现。
- Proxy:该类即为动态代理类,作用类似于上例中的ProxySubject。
- Protected Proxy(InvocationHandler h):构造函数,估计用于给内部的h赋值。
- Static Class getProxyClass (ClassLoader loader, Class[] interfaces):获得一个 代理类,其中loader是类装载器,interfaces是真实类所拥有的全部接口的数组。
- Static Object newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h):返回代理类的一个实例,返回后的代理类可以当作被代理类使用 (可使用被代理类的在Subject接口中声明过的方法)。
在使用动态代理类时,我们必须实现InvocationHandler, 以上面的代码为例:
Subject:
- public interface Subject {
- abstract public void request();
- }
具体Subject:
- public class RealSubject implements Subject {
- public RealSubject() {}
- public void request() {
- System.out.println( " From real subject. " );
- }
- }
代理处理器(ProxyHandler):
- import java.lang.reflect.Method;
- import java.lang.reflect.InvocationHandler;
- public class DynamicSubject implements InvocationHandler {
- private Object sub;
- public DynamicSubject() {}
- public DynamicSubject(Object obj) {
- sub = obj;
- }
- public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
- System.out.println( " before calling " + method);
- method.invoke(sub,args);
- System.out.println( " after calling " + method);
- return null ;
- }
- }
该代理类的内部属性为Object类,实际使用时通过该类的构造函数DynamicSubject(Object obj)对其赋值;此外,在该类还实现了invoke方法,该方法中的method.invoke(sub,args);其实就是调用被代理对象的将要被执行的方法,方法参数sub是实际的被代理对象,args为执 行被代理对象相应操作所需的参数。通过动态代理类,我们可以在调用之前或之后执行一些 相关操作。
- // 客户端:
- import java.lang.reflect.InvocationHandler;
- import java.lang.reflect.Proxy;
- import java.lang.reflect.Constructor;
- import java.lang.reflect.Method;
- public class Client {
- static public void main(String[] args) throws Throwable {
- RealSubject rs = new RealSubject(); // 在这里指定被代理类
- InvocationHandler ds = new DynamicSubject(rs);
- Class cls = rs.getClass();
- // 以下是一次性生成代理
- Subject subject = (Subject) Proxy.newProxyInstance(cls.getClassLoader(), cls.getInterfaces(),ds );
- subject.request();
- }
- }
通过这种方式,被代理的对象(RealSubject)可以在运行时动态改变,需要控制的接口 (Subject接口)可以在运行时改变,控制的方式(DynamicSubject类)也可以动态改变,从而实 现了非常灵活的动态代理关系。
5 CGLib 简介
JDK的动态代理机制只能代理实现了接口的类,而不能实现接口的类就不能实现JDK的动态代理,cglib是针对类来实现代理的,他的原理是对指定的目标类生成一个子类,并覆盖其中方法实现增强,但因为采用的是继承,所以不能对final修饰的类进行代理。
示例
业务类:
- public interface BookFacade {
- public void addBook();
- }
- public class BookFacadeImpl1 {
- public void addBook() {
- System.out.println("增加图书的普通方法...");
- }
- }
- /**
- * 使用cglib动态代理
- */
- public class BookFacadeCglib implements MethodInterceptor {
- private Object target;
- /**
- * 创建代理对象
- *
- * @param target
- * @return
- */
- public Object getInstance(Object target) {
- this.target = target;
- Enhancer enhancer = new Enhancer();
- enhancer.setSuperclass(this.target.getClass());
- // 回调方法
- enhancer.setCallback(this);
- // 创建代理对象
- return enhancer.create();
- }
- @Override
- // 回调方法
- public Object intercept(Object obj, Method method, Object[] args,
- MethodProxy proxy) throws Throwable {
- System.out.println("事物开始");
- proxy.invokeSuper(obj, args);
- System.out.println("事物结束");
- return null;
- }
- }
- public class TestCglib {
- public static void main(String[] args) {
- BookFacadeCglib cglib=new BookFacadeCglib();
- BookFacadeImpl1 bookCglib=(BookFacadeImpl1)cglib.getInstance(new BookFacadeImpl1());
- bookCglib.addBook();
- }
- }