JAVA基础|JDK动态代理

个人理解:
就是当你写了一个接口,里面有方法,然后写了实现类实现方法,完成方法逻辑,然后有一天,想对这个方法进行修改,但是不想改源码,所以有两种方式可以实现。第一种是静态代理,创建一个类继承实现类,然后对方法进行修改,这样太局限,因为只能针对特定的类增强方法,有100个实现类就要创建100个子类去实现。第二种方式是动态代理,可以动态地生成代理类,这是可以接受的。
这篇文章记录的JDK动态代理
1.使用步骤 1.创建需要被代理的接口(必须要有)和实现类

public interface service { public void reduceStock(); }

public class ServiceImpl implements service { //业务方法 @Override public void reduceStock() { System.out.println("扣减库存开始"); } }

2.创建代理类
需要实现InvocationHandler接口,重写invoke方法,这里可以对方法进行增强。
public class Dynamicproxy implements InvocationHandler { private Object targetObject; public Dynamicproxy(Object targetObject) { this.targetObject = targetObject; }@Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { System.out.println("日志开始"); Object invoke = method.invoke(targetObject, args); System.out.println("日志结束"); return invoke; } }

3.创建动态代理对象
//生成代理类文件 在根目录的同级目录,com下 System.getProperties().put("sun.misc.ProxyGenerator.saveGeneratedFiles", "true"); //实现了接口的业务类 ServiceImpl iservice = new ServiceImpl(); //获取Class对象 Class iserviceClass = iservice.getClass(); //代理类 实现需要实现InvocationHandler接口,重写invoke方法 传入业务实现类对象 Dynamicproxy dynamicproxy = new Dynamicproxy(iservice); //创建代理类对象 service so = (service)Proxy.newProxyInstance(iserviceClass.getClassLoader(), iserviceClass.getInterfaces(), dynamicproxy);

4.调用接口方法
so.reduceStock();

【JAVA基础|JDK动态代理】这样简单的动态代理就实现了。看下生成的代理类对象。
生成的这个代理类对象就是JDK动态代理的灵魂
JAVA基础|JDK动态代理
文章图片

不知道为啥没有方法内容。。
看了下别人的方法体
JAVA基础|JDK动态代理
文章图片

可以发现调用的是刚刚创建的代理类的invoke方法,super就是Proxy类,.h就是InvocationHandler接口,方法就是我们实现的invoke方法了。
后面源码介绍的newProxyInstance方法生成的就是这个东西,先根据我们传入的接口数组和类加载器调用getProxyClass0获取这个代理类的Class对象,然后通过Class对象获取有参构造(传入我们写的代理类,实现了InvocationHandler 接口),然后通过有参构造方法newInstance生成对象。
上图可以看出实现了我们自己写的接口,然后调用了接口中的方法,这样就起到了代理的作用
JAVA基础|JDK动态代理
文章图片

所以调用方法的逻辑是:
1.代理类的proxy方法
2.method.invoke方法
3.实现类的方法
这是接口有实现类的动态代理,还有一种是只有接口没有实现类的JDK动态代理,例如mybatis的mapper接口没有实现类,也是通过JDK动态代理实现的方法执行。
区别是重写invoke方法时,返回invoke方法的返回值,有实现类的时候是返回实现类方法的返回值。
2.Proxy类源码 JDK动态代理的重要方法是这个:
//创建代理类对象 service so = (service)Proxy.newProxyInstance(iserviceClass.getClassLoader(), iserviceClass.getInterfaces(), dynamicproxy);

所以肯定要看下这个类,
1.获取到代理类的Class对象
2.获取到代理类的构造器
3.调用构造方法创建对象
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. */ //1.获取到代理类 Class cl = getProxyClass0(loader, intfs); /* * Invoke its constructor with the designated invocation handler. */ try { if (sm != null) { checkNewProxyPermission(Reflection.getCallerClass(), cl); } //2.获取到代理类的构造器 final Constructor cons = cl.getConstructor(constructorParams); final InvocationHandler ih = h; if (!Modifier.isPublic(cl.getModifiers())) { AccessController.doPrivileged(new PrivilegedAction() { public Void run() { cons.setAccessible(true); return null; } }); } //3.调用构造方法创建对象 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); } }

最关键的肯定是第一步了,怎么获取这个代理类的Class呢
JAVA基础|JDK动态代理
文章图片

可以看到传入了实现类的接口数组和实现类的类加载器。
1.getProxyClass0方法
见名知义:获取代理类
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 return proxyClassCache.get(loader, interfaces); }

proxyClassCache是WeakCache类型的
见名知义:代理类缓存,意思是先从缓存中获取。
JAVA基础|JDK动态代理
文章图片

2.WeakCache类的get方法
核心代码:V value = https://www.it610.com/article/supplier.get();
也就是是内部类Factory的get()方法,第一次调用时value会为空
//K为类加载器 P是接口数组 public V get(K key, P parameter) { Objects.requireNonNull(parameter); expungeStaleEntries(); //缓存的key 是类加载器 Object cacheKey = CacheKey.valueOf(key, refQueue); // lazily install the 2nd level valuesMap for the particular cacheKey ConcurrentMap> valuesMap = map.get(cacheKey); if (valuesMap == null) { ConcurrentMap> oldValuesMap = map.putIfAbsent(cacheKey, valuesMap = new ConcurrentHashMap<>()); if (oldValuesMap != null) { valuesMap = oldValuesMap; } }// create subKey and retrieve the possible Supplier stored by that // subKey from valuesMap //通过subkeyfactory创建key对象 Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter)); Supplier supplier = valuesMap.get(subKey); Factory factory = null; while (true) { if (supplier != null) { // supplier might be a Factory or a CacheValue instance //4.实际调用了内部类Factory的get()方法,创建了一个代理类 V value = https://www.it610.com/article/supplier.get(); if (value != null) { return value; } } // else no supplier in cache // or a supplier that returned null (could be a cleared CacheValue // or a Factory that wasn't successful in installing the CacheValue)// lazily construct a Factory if (factory == null) { factory = new Factory(key, parameter, subKey, valuesMap); }if (supplier == null) { supplier = valuesMap.putIfAbsent(subKey, factory); if (supplier == null) { // successfully installed Factory supplier = factory; } // else retry with winning supplier } else { if (valuesMap.replace(subKey, supplier, factory)) { // successfully replaced // cleared CacheEntry / unsuccessful Factory // with our Factory supplier = factory; } else { // retry with current supplier supplier = valuesMap.get(subKey); } } } }

这个supplier是WeakCache类的内部类Factory,Factory的get方法如下
3.Factory的get方法
@Override public synchronized V get() { // serialize access // re-check Supplier supplier = valuesMap.get(subKey); if (supplier != this) { // something changed while we were waiting: // might be that we were replaced by a CacheValue // or were removed because of failure -> // return null to signal WeakCache.get() to retry // the loop return null; } // else still us (supplier == this)// create new value V value = https://www.it610.com/article/null; try { //这个value就是Class类了,根据他获取构造器,然后创建对象 value = Objects.requireNonNull(valueFactory.apply(key, parameter)); } finally { if (value == null) { // remove us on failure valuesMap.remove(subKey, this); } } // the only path to reach here is with non-null value assert value != null; // wrap value with CacheValue (WeakReference) CacheValue cacheValue = https://www.it610.com/article/new CacheValue<>(value); // try replacing us with CacheValue (this should always succeed) if (valuesMap.replace(subKey, this, cacheValue)) { // put also in reverseMap reverseMap.put(cacheValue, Boolean.TRUE); } else { throw new AssertionError("Should not reach here"); }// successfully replaced us with new CacheValue -> return the value // wrapped by it return value; } }

核心代码:valueFactory.apply(key, parameter)
valueFatory:在创建WeakCache时就已经创建了,是ProxyClassFactory类型的(代理类工厂)。
JAVA基础|JDK动态代理
文章图片

4.proxy类的内部类ProxyClassFactory的apply方法
这个方法最终就会生成代理对象了。
包括给代理对象命名,生成字节码,将字节码转为Class对象
private static final class ProxyClassFactory implements BiFunction[], Class> { // prefix for all proxy class names //代理类的前缀 private static final String proxyClassNamePrefix = "$Proxy"; //代理类计数器 // next number to use for generation of unique proxy class names private static final AtomicLong nextUniqueNumber = new AtomicLong(); @Override public Class apply(ClassLoader loader, Class[] interfaces) {Map, 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 { //获取Class对象 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,则所有包都可以使用 // 当接口是非public,则生成的代理类必须和接口在与非public接口同一个包下 // 如果非public的接口均在同一个包下,则生成的代理类放在非public接口同一个包下 // 而如果非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"); } } } 如果都是公有的接口,则代理类默认放在com.sun.proxy包下 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()); } } }

回头再看下这三个方法
发现WeakCache类的get方法和Factory的get方法都是和缓存相关的,最终的处理还是在proxy类的内部类ProxyClassFactory的apply方法中。
仿真看下这个方法
JAVA基础|JDK动态代理
文章图片

JAVA基础|JDK动态代理
文章图片

JAVA基础|JDK动态代理
文章图片

最终的名字
JAVA基础|JDK动态代理
文章图片

JAVA基础|JDK动态代理
文章图片

最后:使用传进来的classLoader将代理类字节码加载到JVM中
5.回到newProxyInstance方法
到现在为止,newProxyInstance的第一个方法就执行完了。得到了这么一个东西
JAVA基础|JDK动态代理
文章图片

然后就是通过Class对象调用构造器,这里是有参构造,传入了InvocationHandler
JAVA基础|JDK动态代理
文章图片

h是我们调用newProxyInstance方法是传入的最后一个参数,我们自己写的代理类,实现了InvocationHandler 接口
JAVA基础|JDK动态代理
文章图片

JAVA基础|JDK动态代理
文章图片

最后调用newInstance方法,创建了对象
JAVA基础|JDK动态代理
文章图片

有了这个代理对象,就可以调用我们自己接口中的方法了,然后会调用代理类中的invoke方法,也就是我们想要增强的方法
参考链接
参考链接

    推荐阅读