基本介绍
1、代理(Proxy)模式:为对象提供一个替身,以控制这个对象的访问。即通过代理对象访问目标对象,这样做的好处是:可以在目标对象实现的基础上,增强额外的功能操作,即扩展目标对象的功能。
2、被代理的对象可以是远程对象,创建开销大的对象,或者需要安全控制的对象。
3、代理模式有不同的形式,主要有三种:静态代理、动态代理(接口代理,JDK代理)和Cglib代理(可以在内存中动态的创建对象而不需要实现接口,它是属于动态代理的一个范畴)。
代理模式简要类图如下:
使用代理对象访问目标对象。
静态代理
静态代理基本介绍:
静态代理在使用时,需要定于接口或者父类,被代理对象(即目标对象)与代理对象一起实现相同的接口或者继承相同的父类。
小案例:
1、定义一个接口:Teacher
2、目标对象TargetTeacher实现Teacher接口
3、使用静态代理方式,代理类ProxyTeacher也实现Teacher接口
4、调用的时候通过ProxyTeacher代理对象的方法来调用目标对象
5、注意事项:代理对象与目标对象实现相同的接口,然后通过调用相同的方法来调用目标对象。
大致类图描述:
代码实现:
package com.example.pattern.proxy;
/**
* 静态代理
*/
interface Teacher { // 接口
void teach();
}
class ProxyTeacher implements Teacher { // 代理对象
private Teacher teacher;
public ProxyTeacher(Teacher teacher) {
this.teacher = teacher;
}
@Override
public void teach() {
System.out.println("开始代理");
teacher.teach();
System.out.println("提交。。。。。");
}
}
class TargetTeacher implements Teacher { // 目标对象
@Override
public void teach() {
System.out.println("开始授课。。。。");
}
}
public class Client { // 客户端
public static void main(String[] args) {
// 创建目标对象 被代理对象
TargetTeacher teacher = new TargetTeacher();
// 创建代理对象,同时将被代理对象传递给代理对象
ProxyTeacher proxyTeacher = new ProxyTeacher(teacher);
// 通过代理对象,调用被代理对象的方法
// 即:只需的是代理对象的方法,代理对象再去调用目标对象的方法
proxyTeacher.teach();
}
}
优缺点分析:
优点:在不修改目标对象的功能前提下,通过代理对象将目标对象进行功能扩展。
缺点:因为代理对象需要与目标对象实现一样的接口,所以可能有很多代理类。一旦增加方法,目标对象和代理对小都需要维护。
动态代理
动态代理基本介绍:
1、代理对象不需要实现接口,但是目标对象需要实现接口,否则不能使用动态代理
2、代理对象的生产是利用JDK的API,动态的在内存中构件代理对象。
3、动态代理也叫做JDK代理、接口代理。
JDK中生成代理对象API
1、代理类所在包 java.lang.reflect.Proxy
2、JDK代理需要使用到newProxyInstance()方法,该方法需要接收三个参数
static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// ClassLoader loader 指定当前目标对象使用的类加载器,获取加载器的方法固定
// Class<?>[] interfaces 目标对象实现的接口类型,使用泛型方法确认类型
// InvocationHandler h 事件处理,执行目标对象的方法时,会触发事件处理器方法,会把当前执行的目标对象方法作为参数传入
......
}
将上面的需要改成动态代理,类图如下:
代码实现
package com.example.pattern.proxy.dynamic;
import java.lang.reflect.Proxy;
/**
* 动态代理
*/
interface Teacher {
void teach();
void sayHello(String name);
}
class TargetTeacher implements Teacher { // 目标类
@Override
public void teach() {
System.out.println("开始授课......");
}
@Override
public void sayHello(String name) {
System.out.println(name);
}
}
class ProxyFactory { // 动态代理类
// 维护一个目标对象 target
private Object target;
// 构造器 对 target 进行初始化
public ProxyFactory(Object target) {
this.target = target;
}
// 给目标对象生成一个代理对象
public Object getProxyInstance() {
// ClassLoader loader 指定当前目标对象使用的类加载器,获取加载器的方法固定
// Class<?>[] interfaces 目标对象实现的接口类型,使用泛型方法确认类型
// InvocationHandler h 事件处理,执行目标对象的方法时,会触发事件处理器方法,会把当前执行的目标对象方法作为参数传入
return Proxy.newProxyInstance(
target.getClass().getClassLoader(),
target.getClass().getInterfaces(),
(proxy, method, args) -> {
System.out.println("JDK 代理开始");
// 通过反射机制调用目标对象方法
Object invoke = method.invoke(target, args);
System.out.println("JDK 代理提交");
return invoke;
}
//new InvocationHandler() {
// @Override
// public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
// System.out.println("JDK 代理开始");
// // 通过反射机制调用目标对象方法
// return method.invoke(target, args);
// }
// }
);
}
}
public class Client {
public static void main(String[] args) {
// 创建目标对象
TargetTeacher targetTeacher = new TargetTeacher();
// 给目标对象创建代理对象
Object instance = new ProxyFactory(targetTeacher).getProxyInstance();
// 类型强转 Teacher
Teacher teacher;
if (instance instanceof Teacher) {
teacher = (Teacher) instance;
} else {
throw new ClassCastException("类型转换异常!!!");
}
// 内存中动态生成了代理对象
System.out.println("teacher:" + teacher.getClass());
// 通过代理对象调用目标对象的方法
// teacher.teach();
teacher.sayHello("TOM");
}
}
Cglib代理
基本介绍
1、静态代理和JDK代理模式都要求目标对象实现一个接口,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候可以使用目标对象子类来实现代理–这就是Cglib代理。
2、Cglib代理也叫做子类代理,它是在内存中构建一个子类对象从而实现对目标对象功能扩展,Cglib代理也可以划分到动态代理。
3、Cglib是一个强大的高性能代码生成包,它可以在运行期扩展Java类与实现Java接口,它广泛的被许多AOP框架使用,例如Spring AOP,实现方法拦截。
4、在AOP的编程中如何选择代理模式:
4.1 目标对象需要实现接口,使用JDK代理
4.2 目标对象不需要实现接口,使用Cglib代理
5、Cglib包的底层是通过字节码处理框架ASM来转换字节码并生成新的类。
6、Cglib代理类不能声明成为final,否则会报错。目标对象的方法如果是final/static,那么就不会被拦截,即不会执行目标对象额外的业务方法。
类图实现如下
代码实现
package com.example.pattern.proxy.cglib;
import org.springframework.cglib.proxy.Enhancer;
import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
/**
* @author zjt
* @date 2020-12-28
*/
public class TargetTeacher {
public TargetTeacher() {
}
public String teach() {
System.out.println("授课中.....");
return "授课中.....";
}
}
class ProxyFactory implements MethodInterceptor {
// 维护一个目标对象
private Object target;
public ProxyFactory(Object obj) {
this.target = obj;
}
// 返回一个代理对象 即目标对象的代理对象
public Object getProxyInstance() {
// 1、创建一个工具类
Enhancer enhancer = new Enhancer();
// 2、设置父类
enhancer.setSuperclass(target.getClass());
// 3、设置回调函数
enhancer.setCallback(this);
// 4、创建子类对象即代理类
return enhancer.create();
}
// 重写intercept 方法,会调用目标对象的方法
@Override
public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
System.out.println("cglib 代理模式开始");
Object invoke = method.invoke(target, args);
System.out.println("cglib 代理提交");
return invoke;
}
}
class Client {
public static void main(String[] args) {
//创建目标对象
TargetTeacher targetTeacher = new TargetTeacher();
// 获取到代理对象 并且将目标对象传递给代理对象
ProxyFactory proxyFactory = new ProxyFactory(targetTeacher);
Object instance = proxyFactory.getProxyInstance();
if (instance instanceof TargetTeacher) {
TargetTeacher teacher = (TargetTeacher) instance;
// 执行代理对象的方法,触发intercept()方法,从而实现对目标对象的调用
String teach = teacher.teach();
System.out.println(teach);
}
}
}
扩展
动态代理也叫做JDK代理、接口代理。目标类为什么必须要实现一个接口?
在调用方法中添加System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
如过没有保存文件请参考博客
public static void main(String[] args) {
// 创建目标对象
TargetTeacher targetTeacher = new TargetTeacher();
System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
// 给目标对象创建代理对象
Object instance = new ProxyFactory(targetTeacher).getProxyInstance();
// 类型强转 Teacher
Teacher teacher;
if (instance instanceof Teacher) {
teacher = (Teacher) instance;
} else {
throw new ClassCastException("类型转换异常!!!");
}
// 内存中动态生成了代理对象
System.out.println("teacher:" + teacher.getClass());
// 通过代理对象调用目标对象的方法
// teacher.teach();
teacher.sayHello("TOM");
}
运行之后获取到IDEA反编译出的的动态代理类
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.example.pattern.proxy.dynamic;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
// 代理类需要实现Teacher中的方法
// 目标类必须实现Teacher接口
final class $Proxy0 extends Proxy implements Teacher {
private static Method m1;
private static Method m4;
private static Method m2;
private static Method m3;
private static Method m0;
public $Proxy0(InvocationHandler var1) throws {
super(var1); // Proxy代理类中的 InvocationHandler被初始化
}
public final boolean equals(Object var1) throws {
try {
return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final void sayHello(String var1) throws {
try {
super.h.invoke(this, m4, new Object[]{var1});
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final void teach() throws { // 实现Teacher接口生成 teach方法
try {
//此时的h是 Proxy 的 InvocationHandler 相当于 ProxyFactory方法中new 出来的
// new InvocationHandler()中实现的方法
super.h.invoke(this, m3, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final String toString() throws {
try {
return (String)super.h.invoke(this, m2, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final int hashCode() throws {
try {
return (Integer)super.h.invoke(this, m0, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m4 = Class.forName("com.example.pattern.proxy.dynamic.Teacher").getMethod("sayHello", Class.forName("java.lang.String"));
m2 = Class.forName("java.lang.Object").getMethod("toString");
m3 = Class.forName("com.example.pattern.proxy.dynamic.Teacher").getMethod("teach");
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}