代理一般分为三种:静态代理、JDk动态代理、CGLib动态代理;我们常说的代理模式一般只静态代理;mybatis的mapper接口主要应用JDK动态代理;Spring的AOP主要应用JDk动态代理和CGLib动态代理。本文主要介绍JDK动态代理。
静态代理
原理
静态代理由被代理类,代理类,接口三部分组成。代理类和被代理类都需要实现接口,被代理类实现主要业务方法,代理类通过创建一个业务实现类对象来调用具体的业务方法。
实现
1、定义一个接口,被代理类和代理类都需要实现这个接口
/**
* 定义一个征婚对象接口
*/
public interface staticPerson {
// 寻找真爱
void findLove();
}
2、定义被代理类张三,实现征婚对象接口
public class staticZhangsan implements staticPerson{
private String sex = "女";
private String name = "张三";
//实现接口中的抽象方法
@Override
public void findLove() {
System.out.println("我叫" + this.name + ",性别:" + this.sex + ",我找对象的要求是\n");
System.out.println("高富帅");
System.out.println("有房有车");
System.out.println("身高要求一米八");
}
get/set...
}
3、定义媒婆代理类,通过组合,在代理类中创建一个业务实现类对象来调用具体的业务方法
public class staticMeipo implements staticPerson{
//通过组合,创建一个被代理类对象来调用具体的业务方法
private staticPerson staticPerson = new staticZhangsan();
@Override
public void findLove() {
//预处理操作
System.out.println("我是媒婆:" + "得给你找个男的");
System.out.println("开始进行海选");
System.out.println("--------------------------------");
//调用真正的业务方法
staticPerson.findLove();
//调用后处理
System.out.println("--------------------------------");
System.out.println("如何合适就恋爱");
}
}
4、测试,在使用时,首先创建被代理类对象,然后把被代理类对象作构造参数创建一个代理类对象,最后通过代理类对象进行业务方法的调用。
public static void main(String[] args){
//创建被代理类对象
staticZhangsan staticZhangsan = new staticZhangsan();
//创建代理类对象,并把被代理类对象作为构造函数
staticMeipo staticMeipo = new staticMeipo(staticZhangsan);
//通过代理对象进行业务方法调用
staticMeipo.findLove();
}
我们可以看出静态的优点就是很容易就完成了对一个类的代理操作。但缺点也是很明显的,代理类只能实现一个接口,所以代理类只能为一个类服务,如果需要代理的类很多的,那么就需要定义多个代理类;
而且,如果代理类对业务方法的预处理、调用后操作都是一样的(比如:调用前输出提示、调用后自动关闭连接),则多个代理类就会有很多重复代码。
那么有没有一种方法可以解决这个问题呢?动态代理可以,定义一个代理类,它能代理所有实现类的方法调用:根据传进来的业务实现类和方法名进行具体调用。这就是动态代理。
JDK动态代理
JDK动态代理所用到的代理类在程序调用到代理类对象时才由JVM真正创建,JVM根据传进来的 业务实现类对象 以及 方法名 ,动态地创建了一个代理类的class文件并被字节码引擎执行,然后通过该代理类对象进行方法调用。我们需要做的,只需指定代理类的预处理、调用后操作即可。
为了和静态做一个对比,我们采用和静态相同的结构。
1、定义一个接口,被代理类需要实现这个接口,和静态不同的是,代理了不需要实现这个接口
public interface Person {
// 寻找真爱
void findLove();
}
2、定义被代理类张三,实现征婚对象接口
public class Zhangsan implements Person{
private String sex = "女";
private String name = "张三";
@Override
public void findLove() {
System.out.println("我叫" + this.name + ",性别:" + this.sex + ",我找对象的要求是\n");
System.out.println("高富帅");
System.out.println("有房有车");
System.out.println("身高要求一米八");
}
get/set...
}
3、定义媒婆代理类,通过组合,在代理类中创建一个业务实现类对象来调用具体的业务方法,和静态代理不同的是此处实现的是接口是InvocationHandler
InvocationHandler 是干什么的呢?InvocationHandler 是动态代理的核心。每一个代理类都会有一个关联的调用处理程序(InvocationHandler)。对待代理实例进行调用时,将对方法的调用进行编码并指派到它的调用处理器(InvocationHandler)的invoke方法。所以对代理对象实例方法的调用都是通过InvocationHandler中的invoke方法来完成的,而invoke方法会根据传入的代理对象、方法名称以及参数决定调用代理的哪个方法。
public class Meipo implements InvocationHandler {
//代理人对象
private Person target;
/**
* 绑定业务对象并返回一个代理类
* 通俗理解就是获取被代理人的个人资料
*/
public Object getInstance(Person target){
this.target = target;
/**
* 所有动态代理类的方法调用,都会交由InvocationHandler接口实现类里的invoke()方法去处理。这是动态代理的关键所在。
*
* 第一个参数:ClassLoader 类加载器,用来获取业务实现类的元数据,在包装方法是调用真正的业务方法
* 第二个参数:Class<?>[] interfaces 接口
* 第三个参数:InvocationHandler 由谁代理,也就是代理类meipo
*/
Class clazz = target.getClass(); //用反射获取接口 //1、拿到被代理对象的引用,然后获取他的接口
System.out.println(clazz);
return Proxy.newProxyInstance(clazz.getClassLoader(),clazz.getInterfaces(),this);
}
/**
* 重写包装调用方法:进行预处理、调用后处理
*
* 第一个参数:Object 这个参数指定动态生成的代理类
* 第二个参数:Method 这个参数表示传入接口中的所有Method对象 即InvocationHandler.invoke()方法
* 第三个参数:args 这个参数对应当前method方法中的参数
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//预处理和调用后处理统称为增强操作,在Spring AOP中,典型的应用场景就是在某些敏感方法执行前后进行操作日志记录。
//预处理操作
System.out.println("我是媒婆:" + "得给你找个男的");
System.out.println("开始进行海选");
System.out.println("--------------------------------");
//调用真正的业务方法
this.target.findLove();
//调用后处理
System.out.println("--------------------------------");
System.out.println("如何合适就恋爱");
return null;
}
}
4、测试,定义接口引用(代理生成的对象强转接口)并用代理对象.getInstance(业务实现类对象)的返回值进行赋值。口引用真正指向的是一个绑定了业务类的代理类对象,所以通过接口方法名调用的是被代理的方法们
public static void main(String[] args) throws Exception{
/**
* 此处的代理对象object并不是张三,而是$proxy0(class com.sun.proxy.$Proxy0)
* 张三对象的类应该是:class com.example.demo.proxy.Zhangsan
*/
Person object = (Person) new Meipo().getInstance(new Zhangsan());
//通过接口引用调用业务方法即可
object.findLove();//调用哪个方法就动态代理哪个方法
}
通过对比发现以下几点显著的不同点:
1、实现接口:静态代理的代理类和被代理类都实现征婚对象接口;JDK动态代理的被代理类实现征婚对象接口,而代理类实现了InvocationHandler接口;
2、代理类实现:静态的代理类直接用new出来的被代理类对象调用真正的业务方法;而JDK动态代理是在getInstense方法了通过Proxy.newProxyInstance创建并返回了一个生成的代理类,并在重写的InvocationHandler接口的抽象方法里,用被代理类对象调用业务方法。
3、在使用时:静态代理最后是用代理对象调用业务方法。JDk动态代理最后使用生成的代理类对象用业务方法。
静态代理和JDK动态代理的区别
静态代理是通过直接编码创建的:也就是说在静态代理中我们需要对哪个接口和哪个被代理类创建代理类,所以我们在编译前就需要代理类实现与被代理类相同的接口,并且直接在实现的方法中调用被代理类相应的方法;
JDK动态代理是利用反射机制在运行时创建代理类的:也就是说我们不知道要针对哪个接口,哪个被代理类创建代理类,因为他是在运行时被创建的
代理类是如何动态创建的呢?
在JDK动态代理的Meipo代理类的getInsgetInstance方法里,我们可以发现是通过Proxy.newProxyInstance()来返回生成的代理类,那我们就进去瞧瞧:
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
//如果h为空将抛出异常
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();//拷贝被代理类实现的一些接口,用于后面权限方面的一些检查
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
//在这里对某些安全权限进行检查,确保我们有权限对预期的被代理类进行代理
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
//------------------------------------------
// 下面这个方法将产生代理类
Class<?> cl = getProxyClass0(loader, intfs);
//------------------------------------------
/*
* 使用指定的调用处理程序获取代理类的构造函数对象
*/
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
final Constructor<?> cons = cl.getConstructor(constructorParams);
final InvocationHandler ih = h;
//假如代理类的构造函数是private的,就使用反射来set accessible
if (!Modifier.isPublic(cl.getModifiers())) {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
cons.setAccessible(true);
return null;
}
});
}
//根据代理类的构造函数来生成代理类的对象并返回
return cons.newInstance(new Object[]{h});
} catch (IllegalAccessException|InstantiationException e) {
throw new InternalError(e.toString(), e);
} catch (InvocationTargetException e) {
Throwable t = e.getCause();
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
} else {
throw new InternalError(t.toString(), t);
}
} catch (NoSuchMethodException e) {
throw new InternalError(e.toString(), e);
}
}
所以代理类其实是通过getProxyClass方法来生成的:
/**
* Generate a proxy class. Must call the checkProxyAccess method
* to perform permission checks before calling this.
* 生成代理类。必须调用CheckProxyAccess方法
* 在调用之前执行权限检查。
*/
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// If the proxy class defined by the given loader implementing
// the given interfaces exists, this will simply return the cached copy;
// otherwise, it will create the proxy class via the ProxyClassFactory
//如果由给定加载程序实现定义的代理类
//给定的接口存在,这只会返回缓存副本;
//否则,它将通过proxyClassFactory创建代理类。
return proxyClassCache.get(loader, interfaces);
}
由源码注释我们可以看到,如果在缓存中有对应的代理类,那么直接返回,否则代理类将由 ProxyClassFactory 来创建。那么ProxyClassFactory 是什么呢?
/**
* 里面有一个根据给定ClassLoader和Interface来创建代理类的工厂函数
*
*/
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
// 代理类的名字的前缀统一为“$Proxy”
private static final String proxyClassNamePrefix = "$Proxy";
// 每个代理类前缀后面都会跟着一个唯一的编号,如$Proxy0、$Proxy1、$Proxy2
private static final AtomicLong nextUniqueNumber = new AtomicLong();
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
for (Class<?> intf : interfaces) {
/*
* 验证类加载器加载接口得到对象是否与由apply函数参数传入的对象相同
*/
Class<?> interfaceClass = null;
try {
interfaceClass = Class.forName(intf.getName(), false, loader);
} catch (ClassNotFoundException e) {
}
if (interfaceClass != intf) {
throw new IllegalArgumentException(
intf + " is not visible from class loader");
}
/*
* 验证这个Class对象是不是接口
*/
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
/*
* 验证这个接口是否重复
*/
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
String proxyPkg = null; // 声明代理类所在的package
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
/*
* 记录一个非公共代理接口的包,以便在同一个包中定义代理类。同时验证所有非公共
* 代理接口都在同一个包中
*/
for (Class<?> intf : interfaces) {
int flags = intf.getModifiers();
if (!Modifier.isPublic(flags)) {
accessFlags = Modifier.FINAL;
String name = intf.getName();
int n = name.lastIndexOf('.');
String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
if (proxyPkg == null) {
proxyPkg = pkg;
} else if (!pkg.equals(proxyPkg)) {
throw new IllegalArgumentException(
"non-public interfaces from different packages");
}
}
}
if (proxyPkg == null) {
// 如果全是公共代理接口,那么生成的代理类就在com.sun.proxy package下
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* 为代理类生成一个name package name + 前缀+唯一编号
* 如 com.sun.proxy.$Proxy0.class
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
//---------------------------------------------
/*
* 生成指定代理类的字节码文件
*/
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
//---------------------------------------------
try {
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
/*
* A ClassFormatError here means that (barring bugs in the
* proxy class generation code) there was some other
* invalid aspect of the arguments supplied to the proxy
* class creation (such as virtual machine limitations
* exceeded).
*/
throw new IllegalArgumentException(e.toString());
}
}
}
由以上代码可知,代理类字节码文件是由ProxyGenerate类中的generateProxyClass方法来完成的,generateProxyClass方法最后返回代理类字节码文件。
public static byte[] generateProxyClass(final String var0, Class<?>[] var1, int var2) {
ProxyGenerator var3 = new ProxyGenerator(var0, var1, var2);
// 真正用来生成代理类字节码文件的方法在这里
final byte[] var4 = var3.generateClassFile();
// 保存代理类的字节码文件
if(saveGeneratedFiles) {
AccessController.doPrivileged(new PrivilegedAction() {
public Void run() {
try {
int var1 = var0.lastIndexOf(46);
Path var2;
if(var1 > 0) {
Path var3 = Paths.get(var0.substring(0, var1).replace('.', File.separatorChar),
new String[0]);
Files.createDirectories(var3, new FileAttribute[0]);
var2 = var3.resolve(var0.substring(var1 + 1, var0.length()) + ".class");
} else {
var2 = Paths.get(var0 + ".class", new String[0]);
}
Files.write(var2, var4, new OpenOption[0]);
return null;
} catch (IOException var4x) {
throw new InternalError("I/O exception saving generated file: " + var4x);
}
}
});
}
return var4;
}
下面来看看真正生产代理类字节码文件的generateClassFile()方法
private byte[] generateClassFile() {
//下面一系列的addProxyMethod方法是将接口中的方法和Object中的方法添加到代理方法中(proxyMethod)
this.addProxyMethod(hashCodeMethod, Object.class);
this.addProxyMethod(equalsMethod, Object.class);
this.addProxyMethod(toStringMethod, Object.class);
Class[] var1 = this.interfaces;
int var2 = var1.length;
int var3;
Class var4;
//获得接口中所有方法并添加到代理方法中
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
Method[] var5 = var4.getMethods();
int var6 = var5.length;
for(int var7 = 0; var7 < var6; ++var7) {
Method var8 = var5[var7];
this.addProxyMethod(var8, var4);
}
}
Iterator var11 = this.proxyMethods.values().iterator();
//验证具有相同方法签名的方法的返回类型是否一致
List var12;
while(var11.hasNext()) {
var12 = (List)var11.next();
checkReturnTypes(var12);
}
//后面一系列的步骤用于写代理类Class文件
Iterator var15;
try {
//生成代理类的构造函数
this.methods.add(this.generateConstructor());
var11 = this.proxyMethods.values().iterator();
while(var11.hasNext()) {
var12 = (List)var11.next();
var15 = var12.iterator();
while(var15.hasNext()) {
ProxyGenerator.ProxyMethod var16 = (ProxyGenerator.ProxyMethod)var15.next();
//将代理类字段声明为Method,并且字段修饰符为 private static.
//因为 10 是 ACC_PRIVATE和ACC_STATIC的与运算 故代理类的字段都是 private static Method ***
this.fields.add(new ProxyGenerator.FieldInfo(var16.methodFieldName,
"Ljava/lang/reflect/Method;", 10));
//生成代理类的方法
this.methods.add(var16.generateMethod());
}
}
//为代理类生成静态代码块对某些字段进行初始化
this.methods.add(this.generateStaticInitializer());
} catch (IOException var10) {
throw new InternalError("unexpected I/O Exception", var10);
}
if(this.methods.size() > '\uffff') { //代理类中的方法数量超过65535就抛异常
throw new IllegalArgumentException("method limit exceeded");
} else if(this.fields.size() > '\uffff') {// 代理类中字段数量超过65535也抛异常
throw new IllegalArgumentException("field limit exceeded");
} else {
// 后面是对文件进行处理的过程
this.cp.getClass(dotToSlash(this.className));
this.cp.getClass("java/lang/reflect/Proxy");
var1 = this.interfaces;
var2 = var1.length;
for(var3 = 0; var3 < var2; ++var3) {
var4 = var1[var3];
this.cp.getClass(dotToSlash(var4.getName()));
}
this.cp.setReadOnly();
ByteArrayOutputStream var13 = new ByteArrayOutputStream();
DataOutputStream var14 = new DataOutputStream(var13);
try {
var14.writeInt(-889275714);
var14.writeShort(0);
var14.writeShort(49);
this.cp.write(var14);
var14.writeShort(this.accessFlags);
var14.writeShort(this.cp.getClass(dotToSlash(this.className)));
var14.writeShort(this.cp.getClass("java/lang/reflect/Proxy"));
var14.writeShort(this.interfaces.length);
Class[] var17 = this.interfaces;
int var18 = var17.length;
for(int var19 = 0; var19 < var18; ++var19) {
Class var22 = var17[var19];
var14.writeShort(this.cp.getClass(dotToSlash(var22.getName())));
}
var14.writeShort(this.fields.size());
var15 = this.fields.iterator();
while(var15.hasNext()) {
ProxyGenerator.FieldInfo var20 = (ProxyGenerator.FieldInfo)var15.next();
var20.write(var14);
}
var14.writeShort(this.methods.size());
var15 = this.methods.iterator();
while(var15.hasNext()) {
ProxyGenerator.MethodInfo var21 = (ProxyGenerator.MethodInfo)var15.next();
var21.write(var14);
}
var14.writeShort(0);
return var13.toByteArray();
} catch (IOException var9) {
throw new InternalError("unexpected I/O Exception", var9);
}
}
}
下面是将接口与Object中一些方法添加到代理类中的addProxyMethod方法:
private void addProxyMethod(Method var1, Class<?> var2) {
String var3 = var1.getName();//获得方法名称
Class[] var4 = var1.getParameterTypes();//获得方法参数类型
Class var5 = var1.getReturnType();//获得方法返回类型
Class[] var6 = var1.getExceptionTypes();//异常类型
String var7 = var3 + getParameterDescriptors(var4);//获得方法签名
Object var8 = (List)this.proxyMethods.get(var7);//根据方法前面获得proxyMethod的value
if(var8 != null) {//处理多个代理接口中方法重复的情况
Iterator var9 = ((List)var8).iterator();
while(var9.hasNext()) {
ProxyGenerator.ProxyMethod var10 = (ProxyGenerator.ProxyMethod)var9.next();
if(var5 == var10.returnType) {
ArrayList var11 = new ArrayList();
collectCompatibleTypes(var6, var10.exceptionTypes, var11);
collectCompatibleTypes(var10.exceptionTypes, var6, var11);
var10.exceptionTypes = new Class[var11.size()];
var10.exceptionTypes = (Class[])var11.toArray(var10.exceptionTypes);
return;
}
}
} else {
var8 = new ArrayList(3);
this.proxyMethods.put(var7, var8);
}
((List)var8).add(new ProxyGenerator.ProxyMethod(var3, var4, var5, var6, var2, null));
}
到此,代理类对象生成。