Java动态代理&&源码分析
要了解动态代理,肯定跳不过静态代理,下面将介绍一下静态代理
1 静态代理
1.1 继承
假设一个系统中有一个Person接口,你需要使用这个接口来实现你自己需要的实体类
Person接口
public interface Person {
void show();
}
系统中出现了一个警察,那我就定义一个警察类实现Person接口
PoliceMan类
public class PoliceMan implements Person{
@Override
public void show() {
System.out.println("我是一名警察");
}
}
又出现了一名商人,嗯,还是按照老方法,定义一个商人类实现Person接口
Trader
public class Trader implements Person {
@Override
public void show() {
System.out.println("我是一个商人");
}
}
突然出现了一个经历丰富的人,他以前是一个商人,但现在是程序员o( ̄︶ ̄)o,那没办法只能新建一个类了
TraderAndProgrammer
public class TraderAndProgrammer extends Trader{
@Override
public void show() {
super.show();
System.out.println("我现在是程序员");
}
}
但是如果照这样下去,出现了一个以前是程序员,现在是商人的人怎么办?如果我们还想增加一个描述,描述他们都是一个普通人怎么办?难道还是新建一个类继承(或实现)父类吗?这样类不是越来越多吗(类爆炸)?
1.2 聚合
OrdinaryPerson
public class OrdinaryPerson implements Person {
private Person person;
//持有一个Person类,根据具体传入的类进行代理
public OrdinaryPerson(Person person) {
this.person = person;
}
@Override
public void show() {
System.out.println("我曾经是一个普通人");
person.show();
}
}
测试类
public class PersonTest {
public static void main(String[] args) {
OrdinaryPerson ordinaryPerson = new OrdinaryPerson(new PoliceMan());
ordinaryPerson.show();
System.out.println("---------------");
OrdinaryPerson ordinaryPerson1 = new OrdinaryPerson(new Trader());
ordinaryPerson1.show();
}
}
使用这种聚合的方式,我就可以给所有人都增加一个描述(一个普通人),而不用重新写类来继承了。
但是如果需要新的功能,还是需要写新的类,还是存在着类爆炸的问题。
并且只能代理一种类型
,如果其他类型需要代理还需要写新的代理类。
代理类和委托类实现了相同的接口
,代理类通过委托类实现了相同的方法。如果接口增加一个方法,除了所有实现类需要实现这个方法外,所有代理类也需要实现此方法
。增加了代码维护的复杂度
2 动态代理
2.1 动态代理例子
interface Subject{
void action(String action);
}
class RealSubject implements Subject {
@Override
public void action(String action) {
System.out.println(action);
}
}
class MyInvocationHandler implements InvocationHandler {
Object object;
public Object bind(Object obj) {
this.object = obj;
return Proxy.newProxyInstance(obj.getClass().getClassLoader(),obj.getClass().getInterfaces(),this);
}
//传递进来的代理对象,用来区分请求的来源
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//注意这里参数是object,使用户传入的实际对象
//如果写成proxy,会循环的调用代理对象的相应方法,会报错
Object invoke = method.invoke(object, args);
return invoke;
}
}
public class TestProxy {
public static void main(String[] args) {
RealSubject realSubject = new RealSubject();
MyInvocationHandler myInvocationHandler = new MyInvocationHandler();
//这里传入的类并不局限于Subject的实现类,也可以是其他接口的实现类
//返回的对象是一个动态生成的代理对象
Subject bind = (Subject)myInvocationHandler.bind(realSubject);
bind.action("action方法执行");
}
}
如果method.invoke()传入proxy,会出现下面这种情况
通过调用静态方法Proxy.newProxyInstance()
可以创建动态代理,这个方法需要的到一个类加载器
,一个希望该代理实现的接口列表(不是类或抽象类)(动态生成的代理类继承了Proxy这个类,根据Java的单继承机制,所以不能再通过继承来实现代理了)
,以及InvocationHandler接口的一个实现
。动态代理可以将所有调用重定向到调用处理器,因此会向调用处理器的构造器传递一个“实际”对象的引用,从而使得调用处理器在执行中介任务时,可以将请求转发给实际对象。
2.2 源码分析
跟踪Proxy.newProxyInstance()方法
@CallerSensitive
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
Objects.requireNonNull(h);
final Class<?>[] intfs = interfaces.clone();
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* Look up or generate the designated proxy class.
*/
//得到代理类的Class,后面根据Class反射生成相应的实例
Class<?> cl = getProxyClass0(loader, intfs);
/*
* Invoke its constructor with the designated invocation handler.
*/
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
//得到相应的构造方法
final Constructor<?> cons = cl.getConstructor(constructorParams);
//将传入的InvocationHandler复制给变量
final InvocationHandler ih = h;
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);
}
}
跟踪进getProxyClass0(),最后到达关键方法
Proxy类
@Override
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
for (Class<?> intf : interfaces) {
/*
* Verify that the class loader resolves the name of this
* interface to the same Class object.
*/
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");
}
/*
* Verify that the Class object actually represents an
* interface.
*/
if (!interfaceClass.isInterface()) {
throw new IllegalArgumentException(
interfaceClass.getName() + " is not an interface");
}
/*
* Verify that this interface is not a duplicate.
*/
if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
throw new IllegalArgumentException(
"repeated interface: " + interfaceClass.getName());
}
}
String proxyPkg = null; // package to define proxy class in
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
/*
* Record the package of a non-public proxy interface so that the
* proxy class will be defined in the same package. Verify that
* all non-public proxy interfaces are in the same package.
*/
//如果不是public修饰的接口,则生成在与接口相同的包下面
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) {
// if no non-public proxy interfaces, use com.sun.proxy package
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
/*
* Choose a name for the proxy class to generate.
*/
//代理类的名字
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;
/*
* Generate the specified proxy class.
*/
//生成代理类的字节码
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());
}
}
}
那我们就利用这个方法来看一下动态生成的代理类长什么样子,利用Java提供的ProxyGenerator.generateProxyClass()方法生成代理类的字节码
public class TestProxy {
public static void main(String[] args) {
RealSubject realSubject = new RealSubject();
//关键的生成代理类字节码的代码
//第一个参数:代理类的名字
//第二个参数:目标类实现的接口(JDK动态代理时,这是用户传入的)
byte[] $Proxy01s = ProxyGenerator.generateProxyClass("$Proxy01", realSubject.getClass().getInterfaces());
try {
FileOutputStream fileOutputStream = new FileOutputStream("E:\\$Proxy01.class");
fileOutputStream.write($Proxy01s);
fileOutputStream.flush();
fileOutputStream.close();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
反编译$Proxy01.class生成的代码如下:
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
import proxy.Subject;
public final class $Proxy01 extends Proxy implements Subject {
private static Method m1;
private static Method m2;
private static Method m0;
private static Method m3;
//在得到$Proxy01的实例时,将InvocationHandler传给了父类Proxy
public $Proxy01(InvocationHandler var1) throws {
super(var1);
}
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 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);
}
}
public final void action() throws {
try {
//this指$Proxy01实例原本这个代理
//m3方法就是实现了Subject这个接口后实现的方法
//(Object[])null是方法的参数,参数可能有多个,用数组接收
//如果参数不为空,则new一个数组出来 new Object[]{var1}
//调用父类Proxy的InvocationHandler的invoke方法,这个InvocationHandler是用户自己实现
//的,通过Proxy.newProxyInstance()传入的。
super.h.invoke(this, m3, (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"));
m2 = Class.forName("java.lang.Object").getMethod("toString");
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
m3 = Class.forName("proxy.Subject").getMethod("action");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}