1. 静态代理
首先，要将JDK动态代理，我希望从静态代理讲起，并引出为什么要使用动态代理
(1) 假设我们要做用户查询和增加的业务，那么我们会需要一个UserService接口和一个UserServiceImpl实现类，以及一个名为User的pojo类：
User 类：
public class User {
private Integer userId;
private String username;
private String password;
public Integer getUserId() {
return userId;
}
public void setUserId(Integer userId) {
this.userId = userId;
}
// 以下省略
// 、、、、、、
}
UserService 接口：
public interface UserService {
public User getUser(Integer userId);
public void addUser();
}
UserServiceImpl 实现类：
public class UserServiceImpl implements UserService {
/**查询用户，这里直接建立一个用户并打印和返回用户来模拟查询到用户**/
@Override
public User getUser(Integer userId) {
User user = new User();
user.setUserId(userId);
user.setUsername("lin");
user.setPassword("123456");
System.out.println(user);
return user;
}
/**加入用户**/
@Override
public void addUser() {
System.out.println("加入用户");
}
}
(2) 现在，我们希望在调用方法前后开启事务和提交事务，所以我们需要为这个类做一个代理类，由代理类来添加这个功能：
UserServiceProxy 代理类：
public class UserServiceProxy implements UserService {
private UserService target;
// 注入UserService对象
public UserServiceProxy(UserService target) {
this.target = target;
}
@Override
public User getUser(Integer userId) {
System.out.println("开始事务");
// 调用UserService对象的方法
User user = target.getUser(userId);
System.out.println("结束事务");
return user;
}
@Override
public void addUser() {
System.out.println("开始事务");
// 调用UserService对象的方法
target.addUser();
System.out.println("结束事务");
}
}
(3) 接下来我们来使用这个查询和增加用户的功能：
ProxyTest ：
public class ProxyTest {
public static void main(String[] args) {
UserServiceProxy proxy = new UserServiceProxy(new UserServiceImpl());
proxy.addUser();
proxy.getUser(1);
}
}
可以看到下面的结果，方法前后开启和提交了事务
但是这个过程中我们也可以看到一个问题，那就是这里的代理类和被代理的UserService是紧耦合的，如果你想代理其他接口，向spring一样扫描并对多个Service添加事务功能，那你就要创建多个UserServiceProxy，所以这时候就需要动态代理了
2. JDK动态代理
(1)我们继续使用刚刚的UserService接口和UserServiceImpl实现类，以及名为User的pojo类，这里就不再次列出了
(2) 接下来，不使用UserServiceProxy，我们将实现一个谁都使用的Proxy（代理类），也就是 java.lang.reflect包提供的InvocationHandler的实现：
MyInvocationHandler 实现类（也许叫TransitionalProxy会更好？）：
public class MyInvocationHandler implements InvocationHandler {
private Object target;
// 这里和刚刚一样都是注入UserService对象，只不过这里可以注入任何Object对象
// 而一会也不会像刚才一样直接调用它的方法
public MyInvocationHandler(Object target) {
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("开启事务");
// 通过Java反射调用target，也就是UserService的方法
Object result = method.invoke(target, args);
System.out.println("结束事务");
return result;
}
public Object creatProxyedObj() {
// 1.创建一个代理类对象，类似于刚刚的UserServiceProxy
// 2.这里也会是一会源码解析的重点部分（入口）
return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), this);
}
}
可以看到，这里的target可以是任何对象，所以creatProxyedObj也就能创建任何对象的代理类，而不单单只是UserServiceProxy，可以是任意Proxy
ProxyTest ：
public class ProxyTest {
public static void main(String[] args) {
MyInvocationHandler invocationHandler = new MyInvocationHandler(new UserServiceImpl());
UserService userService = (UserService)invocationHandler.creatProxyedObj();
userService.addUser();
userService.getUser(1);
}
}
可以看到下面的结果，方法前后开启和提交了事务
(3) 既然刚刚说可以传入任何对象，那接下来我们不改变代码，换一个AdminServiceImpl对象试试看：
public class ProxyTest {
public static void main(String[] args) {
MyInvocationHandler invocationHandler = new MyInvocationHandler(new AdminServiceImpl());
AdminService adminService = (AdminService)invocationHandler.creatProxyedObj();
adminService.addAdmin();
}
}
可以看到，这里我们没有添加新MyInvocationHandler，也就是新的xxxServiceProxy代理类，却依然可以在方法前后开启和提交事务
前面讲了这么久，那么接下来就是这篇文章的重头戏了，也就是JDK动态代理的源码分析
3. JDK动态代理源码解析
首先是我们要看的是什么？是哪个部分的源码？
我们要看的是代理类Proxy类是怎么被创建出来的，创建出来是什么样的
(1) 所以我们先看刚刚MyInvocationHandler的creatProxyedObj方法
public Object creatProxyedObj() {
// 1.创建一个代理类对象，类似于刚刚的UserServiceProxy
// 2.这里也会是一会源码解析的重点部分
return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), this);
}
进去Proxy类的newProxyInstance方法里看看：
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
//检验h不为空，h为空抛异常
Objects.requireNonNull(h);
//接口的类对象拷贝一份
final Class<?>[] intfs = interfaces.clone();
//进行一些安全性检查
final SecurityManager sm = System.getSecurityManager();
if (sm != null) {
checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
}
/*
* 查询（在缓存中已经有）或生成指定的代理类的class对象。
*/
Class<?> cl = getProxyClass0(loader, intfs);
try {
if (sm != null) {
checkNewProxyPermission(Reflection.getCallerClass(), cl);
}
//得到代理类对象的构造函数，这个构造函数的参数由constructorParams指定
//参数constructorParames为常量值：private static final Class<?>[] constructorParams = { InvocationHandler.class };
final Constructor<?> cons = cl.getConstructor(constructorParams);
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(loader, intfs)得到代理类的Class对象，然后通过反射从Class对象上得到构造方法，进而创建代理对象。
(2) 就像我们最初说的，我们关注的是代理类怎么创建出来，所以接下来我们看getProxyClass0(loader, intfs)方法：
//此方法也是Proxy类下的方法
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
//意思是：如果代理类被指定的类加载器loader定义了，并实现了给定的接口interfaces，
//那么就返回缓存的代理类对象，否则使用ProxyClassFactory创建代理类。
return proxyClassCache.get(loader, interfaces);
}
接下来我们在进入get(loader, interfaces)方法前先看一眼proxyClassCache：
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
可以看到它是一个WeakCache类的对象
//K代表key的类型，P代表参数的类型，V代表value的类型。
// WeakCache<ClassLoader, Class<?>[], Class<?>> proxyClassCache 说明proxyClassCache存的值是Class<?>对象，正是我们需要的代理类对象。
final class WeakCache<K, P, V> {
private final ReferenceQueue<K> refQueue
= new ReferenceQueue<>();
// 注意一下这里的map
private final ConcurrentMap<Object, ConcurrentMap<Object, Supplier<V>>> map
= new ConcurrentHashMap<>();
private final ConcurrentMap<Supplier<V>, Boolean> reverseMap
= new ConcurrentHashMap<>();
private final BiFunction<K, P, ?> subKeyFactory;
private final BiFunction<K, P, V> valueFactory;
public WeakCache(BiFunction<K, P, ?> subKeyFactory,
BiFunction<K, P, V> valueFactory) {
this.subKeyFactory = Objects.requireNonNull(subKeyFactory);
this.valueFactory = Objects.requireNonNull(valueFactory);
}
其中map变量是实现缓存的核心变量，他是一个双重的Map结构: (key, sub-key) -> value。其中key是传进来的Classloader进行包装后的对象，sub-key是由WeakCache构造函数传人的KeyFactory()生成的。value就是产生代理类的对象，是由WeakCache构造函数传人的ProxyClassFactory()生成的。如下，回顾一下:
private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());
那么为什么这里有Classloader做key却还需要一个sub-key呢？具体可以去看一下附录
产生sub-key的KeyFactory代码如下：
private static final class KeyFactory
implements BiFunction<ClassLoader, Class<?>[], Object>
{
@Override
public Object apply(ClassLoader classLoader, Class<?>[] interfaces) {
switch (interfaces.length) {
case 1: return new Key1(interfaces[0]);
case 2: return new Key2(interfaces[0], interfaces[1]);
case 0: return key0;
default: return new KeyX(interfaces);
}
}
}
这里的Key1，Key2，KeyX方法其实就是根据传入的接口数量选择相应的计算
sub-key的方法，这些方法是使用传入接口对应的hashCode来算出sub-key的
接下来我们回到刚才proxyClassCache.get(loader, interfaces)，get是WeakCache里的方法。源码如下：
//K和P就是WeakCache定义中的泛型，key是类加载器，parameter是接口类数组
public V get(K key, P parameter) {
//检查parameter不为空
Objects.requireNonNull(parameter);
//清除无效的缓存
expungeStaleEntries();
// cacheKey就是(key, sub-key) -> value里的一级key，
Object cacheKey = CacheKey.valueOf(key, refQueue);
//根据一级key得到 ConcurrentMap<Object, Supplier<V>>对象。如果之前不存在，则新建一个ConcurrentMap<Object, Supplier<V>>和cacheKey（一级key）一起放到map中。
ConcurrentMap<Object, Supplier<V>> valuesMap = map.get(cacheKey);
if (valuesMap == null) {
ConcurrentMap<Object, Supplier<V>> oldValuesMap
= map.putIfAbsent(cacheKey,
valuesMap = new ConcurrentHashMap<>());
if (oldValuesMap != null) {
valuesMap = oldValuesMap;
}
}
//这部分就是调用生成sub-key的代码，上面我们已经看过怎么生成的了
Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
//通过sub-key得到supplier
Supplier<V> supplier = valuesMap.get(subKey);
//supplier实际上就是这个factory
Factory factory = null;
while (true) {
//如果缓存里有supplier ，那就直接通过get方法，得到代理类对象，返回，就结束了，一会儿分析get方法。
if (supplier != null) {
// 1.这里是下一部分源码的入口
V value = supplier.get();
if (value != null) {
return value;
}
}
//下面的所有代码目的就是：如果缓存中没有supplier，则创建一个Factory对象，把factory对象在多线程的环境下安全的赋给supplier。
//因为是在while（true）中，赋值成功后又回到上面去调get方法，返回才结束。
if (factory == null) {
factory = new Factory(key, parameter, subKey, valuesMap);
}
if (supplier == null) {
supplier = valuesMap.putIfAbsent(subKey, factory);
if (supplier == null) {
supplier = factory;
}
} else {
if (valuesMap.replace(subKey, supplier, factory)) {
supplier = factory;
} else {
supplier = valuesMap.get(subKey);
}
}
}
}
接下来我们看Factory类中的get方法:
public synchronized V get() {
Supplier<V> supplier = valuesMap.get(subKey);
//重新检查得到的supplier是不是当前对象
if (supplier != this) {
return null;
}
V value = null;
try {
//代理类就是在这个位置调用valueFactory生成的
//valueFactory就是我们传入的 new ProxyClassFactory()
// 可以看到这个value就是最后的返回值
//一会我们分析ProxyClassFactory()的apply方法
value = Objects.requireNonNull(valueFactory.apply(key, parameter));
} finally {
if (value == null) {
valuesMap.remove(subKey, this);
}
}
assert value != null;
//把value包装成弱引用
CacheValue<V> cacheValue = new CacheValue<>(value);
// reverseMap是用来实现缓存的有效性
reverseMap.put(cacheValue, Boolean.TRUE);
if (!valuesMap.replace(subKey, this, cacheValue)) {
throw new AssertionError("Should not reach here");
}
return value;
}
}
最后来到ProxyClassFactory的apply方法，代理类就是在这里生成的：
//这里的BiFunction<T, U, R>是个函数式接口，可以理解为用T，U两种类型做参数，得到R类型的返回值
private static final class ProxyClassFactory
implements BiFunction<ClassLoader, Class<?>[], Class<?>>
{
//所有代理类名字的前缀，一会就会看到生成的代理类的名称都是$Proxy0、$Proxy1这种
private static final String proxyClassNamePrefix = "$Proxy";
//用于生成代理类名字的计数器
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) {
、、、、、、
}
//生成的代理类的包名
String proxyPkg = null;
//代理类访问控制符: public ,final
int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
//验证所有非公共的接口在同一个包内；公共的就无需处理
//生成包名和类名的逻辑，包名默认是com.sun.proxy，类名默认是$Proxy 加上一个自增的整数值
//如果被代理类是 non-public proxy interface ，则用和被代理类接口一样的包名
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) {
proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
}
long num = nextUniqueNumber.getAndIncrement();
//代理类的完全限定名，如com.sun.proxy.$Proxy0.calss
String proxyName = proxyPkg + proxyClassNamePrefix + num;
//核心部分，生成代理类的字节码
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
//把代理类加载到JVM中，至此动态代理过程基本结束了
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
}
最后的最后，我们来看一下生成的Proxy类，
首先用下面的方法在D盘生成class文件，然后直接把class文件拖到idea编辑器或者其他反编译工具中：
public class ProxyTest {
public static void main(String[] args) {
MyInvocationHandler invocationHandler = new MyInvocationHandler(new UserServiceImpl());
UserService userService = (UserService)invocationHandler.creatProxyedObj();
userService.addUser();
System.out.println();
userService.getUser(1);
String path = "D:/$Proxy0.class";
byte[] classFile = ProxyGenerator.generateProxyClass("$Proxy0", UserServiceImpl.class.getInterfaces());
FileOutputStream out = null;
try {
out = new FileOutputStream(path);
out.write(classFile);
out.flush();
} catch (Exception e) {
e.printStackTrace();
} finally {
try {
out.close();
} catch (IOException e) {
e.printStackTrace();
}
}
System.out.println(new UserServiceImpl().getClass().getClassLoader());
}
}
这是反编译后的代码，可以看到它和我们刚刚说到的一样，名称叫$Proxy0：
public final class $Proxy0 extends Proxy implements UserService {
private static Method m1;
private static Method m3;
private static Method m2;
private static Method m0;
private static Method m4;
public $Proxy0(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);
}
}
// 被代理的方法，这里就是用反射调用InvocationHandler中的invoke方法的地方
public final User getUser(Integer var1) throws {
try {
return (User)super.h.invoke(this, m3, 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 addUser() throws {
try {
super.h.invoke(this, m4, (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"));
m3 = Class.forName("com.jdk.UserService").getMethod("getUser", Class.forName("java.lang.Integer"));
m2 = Class.forName("java.lang.Object").getMethod("toString");
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
m4 = Class.forName("com.jdk.UserService").getMethod("addUser");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
4. 附录
这里我们来讲下为什么有Classloader做key却还需要一个sub-key
原因我不说你也知道，肯定是Classloader不唯一（即不同的类共用一个Classloader），接下来我们做一个实验来验证一下：
public class ProxyTest {
public static void main(String[] args) {
System.out.println(new UserServiceImpl().getClass().getClassLoader()
== new UserServiceImpl2().getClass().getClassLoader());
}
}
结果为true
所以这两个不同的类使用的是同一个类加载器
这里再顺便说一下类加载器，（很多人都会误以为自己吃透了JVM，但是在遇到相应的场景代码时他们却永远都联想不到这里，只流于背概念，也没有实际去写demo验证过，只能说周志明大佬的书写的太好让大多数人看完产生了蜜汁自信）
Java采用的是双亲委派机制，也就是：
如果一个类加载器收到了类加载请求，它并不会自己先去加载，而是把这个请求委托给父类的加载器去执行，如果父类加载器还存在其父类加载器，则进一步向上委托，依次递归，请求最终将到达顶层的启动类加载器，如果父类加载器可以完成类加载任务，就成功返回，倘若父类加载器无法完成此加载任务，子加载器才会尝试自己去加载
如图：
启动类加载器(Bootstrap ClassLoader)：这个类加载器负责将放置在<JAVA_HOME>\lib目录中的，或者被-Xbootclasspath参数所指定路径中的，并且是虚拟机能识别的(仅按照文件名识别，如rt.jar，名字不符合的类库即使放置在lib目录中也不会被加载)类库加载到虚拟机内存中。启动类加载器无法被Java程序直接使用。
扩展类加载器(Extension ClassLoader)：这个类加载器由sun.misc.Launcher$ ExtClassLoader实现，它负责加载<JAVA_HOME>\lib\ext目录中的，或者被java.ext.dirs系统变量所指定的路径中的所有类库，开发者可以直接使用扩展类加载器。
应用程序类加载器(Application ClassLoader)：这个类加载器由sum.misc.Launcher.$AppClassLoader来实现。由于这个类加载器是ClassLoader中的getSystemClassLoader()方法的返回值，所以一般也被称为系统类加载器。它负责加载用户类路径上所指定的类库，开发者可以直接使用这个类加载器，如果应用程序中没有自定义过自己的类加载器，一般情况下这个就是程序中默认的类加载器。
也就是说只要没有自定义类加载器，就都是默认使用Application ClassLoader，接下来我们打印出来验证一下：
public class ProxyTest {
public static void main(String[] args) {
System.out.println(new UserServiceImpl().getClass().getClassLoader());
}
}
结果如下：
那么问题来了，为什么这里要用ClassLoader做key呢？
在刚刚的ProxyClassFactory的apply方法中有这样一段代码
//把代理类加载到JVM中，至此动态代理过程基本结束了
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
这里把代理类的class加入JVM中是需要ClassLoader的，也就是loader
而这里的loader是怎么来的呢？
答案就在刚刚Factory类中的get方法中的这一行：
value = Objects.requireNonNull(valueFactory.apply(key, parameter));
这里调用的apply用的正是ClassLoader这个key
JDK动态代理源码解析部分参考自 https://www.jianshu.com/p/269afd0a52e6
双亲委派模型图来自 https://www.jianshu.com/p/9df9d318e838
640
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
