设计模式-结构型-11-代理模式

1. 基本介绍

• 代理模式：为一个对象提供一个替身，以控制对这个对象的访问。即通过代理对象访问目标对象。
• 优点：可以在目标对象实现的基础上，增强额外的功能操作，即扩展目标对象的功能。
• 适用场景：被代理的对象可以是远程对象、创建开销大的对象或需要安全控制的对象。
• 不同形式：
  • 静态代理
  • 动态代理：JDK 代理、接口代理
  • Cglib 代理：可以在内存动态的创建对象，而不需要实现接口，它是属于动态代理的范畴
    

2. 静态代理

2.1 基本介绍

静态代理在使用时，需要定义接口或父类，被代理对象（即目标对象）与代理对象共同实现相同的接口或继承相同的父类。

UML 类图

2.2 应用实例

定义接口

public interface ITeacherDao {void teach();
}

目标对象

public class TeacherDao implements ITeacherDao {@Overridepublic void teach() {System.out.println("老师授课中...");}
}

代理对象

public class TeacherDaoProxy implements ITeacherDao {private ITeacherDao iTeacherDao;public TeacherDaoProxy(ITeacherDao iTeacherDao) {this.iTeacherDao = iTeacherDao;
}@Override
public void teach() {System.out.println("准备授课...");iTeacherDao.teach();System.out.println("结束授课...");
}}

调用代理

// 创建被代理对象
TeacherDao teacherDao = new TeacherDao();
// 创建代理对象，聚合被代理对象
TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teacherDao);
// 通过代理对象，调用被代理对象的方法
teacherDaoProxy.teach();

2.3 静态代理优缺点

• 优点：在不修改目标对象的功能前提下，能通过代理对象对目标功能进行扩展。
• 缺点：代理对象需要与目标对象实现相同的接口，因此会有很多代理类。
• 缺点：一旦接口增加方法，目标对象与代理对象都需要维护。

3. 动态代理

3.1 基本介绍

• 代理对象不需要实现接口，但目标对象需要实现接口，否则不能使用动态代理。
• 代理对象的生成：利用 JDK 的 API 在内存中动态构建代理对象。
• 动态代理也称为：JDK 代理、接口代理。

3.2 JDK 中生成代理对象的 API

• 代理类所在包：java.lang.reflect.Proxy

• 生成代理对象的方法：newProxyInstance 方法

• static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
  

参数说明

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

UML类图

3.3 应用实例

定义接口

/*** 代理接口*/
public interface ITeacherDao {void teach();
}

目标对象

/*** 被代理对象*/
public class TeacherDao implements ITeacherDao {@Overridepublic void teach() {System.out.println("老师授课中...");}
}

代理工厂

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
// ITeacherDao与TeacherDao同上
public class TeacherFactory {private Object target;public TeacherFactory(Object target) {this.target = target;
}public Object newProxyInstance() {return Proxy.newProxyInstance(target.getClass().getClassLoader(),target.getClass().getInterfaces(),new InvocationHandler() {@Overridepublic Object invoke(Object proxy, Method method, Object[] args) throws Throwable {System.out.println("JDK代理授课开始...");Object returnVal = method.invoke(target, args);System.out.println("JDK代理授课结束...");return returnVal;}});
}}

调用代理

public class Client {public static void main(String[] args) {//创建目标对象ITeacherDao teacherDao = new TeacherDao();//通过代理工厂创建代理对象ITeacherDao teacherDaoProxy = (ITeacherDao) new TeacherFactory(teacherDao).newProxyInstance();//class jdk.proxy1.$Proxy0：内存中生成了代理对象System.out.println(teacherDaoProxy.getClass());//通过代理对象调用目标对象方法teacherDaoProxy.teach();}
}

4. Cglib 代理

4.1 基本介绍

• 静态代理和 JDK 代理模式：要求目标对象实现接口，但有时目标对象只是一个单独的对象，并未实现任何接口，此时可以使用目标对象的子类来实现代理——即 Cglib 代理。
• Cglib 代理也称为：子类代理，在内存中构建一个子类对象从而实现对目标对象功能的扩展。
• Cglib 是一个强大的高性能的代码生成包，可以在运行期扩展 Java 类与实现 Java 接口，广泛应用于 AOP 框架，如 Spring AOP。
• 选择代理模式：
  • 目标对象需要实现接口，用 JDK 代理。
  • 目标对象不需要实现接口，用 Cglib 代理。
• Cglib 底层使用字节码处理框架 ASM 来转换字节码并生成新的类。

4.2 实现步骤

1. 引入 Cglib 的 jar 文件。
   

2. 在内存中动态构建子类，注意代理的类不能为 final，否则会报错 java.lang.IllegalArgumentException。

3. 目标对象的方法如果为 final 或 static，则不会被拦截，即不会执行目标对象额外的业务方法。

4.3 应用实例

UML类图

核心代码

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;public class TeacherDao {public String teach() {System.out.println("老师授课中...");return "Good";}
}public class ProxyFactory implements MethodInterceptor {private Object target;public ProxyFactory(Object target) {this.target = target;
}public Object getProxyInstance() {Enhancer enhancer = new Enhancer();enhancer.setSuperclass(target.getClass());enhancer.setCallback(this);return enhancer.create();
}@Override
public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {System.out.println("Cglib代理开始...");Object retVal = method.invoke(target, args);System.out.println("Cglib代理结束...");return retVal;
}
}

调用代理

// 创建目标对象
TeacherDao teacherDao = new TeacherDao();
// 通过代理工厂创建代理对象
TeacherDao proxyInstance = (TeacherDao) 
new ProxyFactory(teacherDao).getProxyInstance();
// 通过代理对象调用目标对象方法
String retVal = proxyInstance.teach();
System.out.println("retVal=" + retVal);

备注： 代理模式测试类

public class Client {
public static void main(String[] args) { System.out.println("---------------静态代理------------------");//创建被代理对象TeacherDao teacherDao = new TeacherDao();//创建代理对象，聚合被代理对象TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teacherDao);//通过代理对象，调用被代理对象的方法teacherDaoProxy.teach();System.out.println("---------------jdk动态代理------------------");//创建目标对象TeacherDaoJdk teacherDaoJdk = new TeacherDaoJdk();//通过代理工厂创建代理对象ITeacherDaoJdk teacherDaoProxyJdk = (ITeacherDaoJdk)new TeacherDaoFactory(teacherDaoJdk).newProxyInstance();//通过代理对象调用目标对象方法teacherDaoProxyJdk.teach();System.out.println("---------------cglib动态代理------------------");//创建目标对象TeacherDaoCglib teacherDaoCglib = new TeacherDaoCglib();//通过代理工厂创建代理对象TeacherDaoCglib proxyInstance = (TeacherDaoCglib) new ProxyFactory(teacherDaoCglib).getProxyInstance();//通过代理对象调用目标对象方法String retVal = proxyInstance.teach();System.out.println("retVal=" + retVal);} 

5. 代理模式的变体

5.1 防火墙代理

内网通过代理穿透防火墙，实现对公网的访问。

5.2 缓存代理

当请求图片文件等资源时，先到缓存代理取，如果取到资源则 OK；如果取不到资源，再到公网或数据库取，然后缓存。

5.3 远程代理

远程对象的本地代表，通过它可以把远程对象当本地对象来调用。远程代理通过网络和真正的远程对象沟通信息。

5.4 同步代理

主要用于多线程编程中，完成多线程间的同步工作。