seata源码分析(03)_创建代理的过程

seata提供了ProxyUtil工具类为事务组件创建代理对象，在spring环境中，seata提供了GlobalTransactionScanner类和SeataAutoDataSourceProxyCreator为组件创建AOP代理，本文重点分析这两个类。

ProxyUtil

io.seata.integration.tx.api.util.ProxyUtil类。

public class ProxyUtil {private static final Map<Object, Object> PROXYED_SET = new HashMap<>();public static <T> T createProxy(T target) {return createProxy(target, target.getClass().getName());}public static <T> T createProxy(T target, String beanName) {try {synchronized (PROXYED_SET) {if (PROXYED_SET.containsKey(target)) {return (T) PROXYED_SET.get(target);}// 使用InterfaceParser获取与target对应的ProxyInvocationHandler// 1. GlobalTransactionalInterceptorHandler// 2. TccActionInterceptorHandler// 内部检查@GlobalTransactional、@GlobalLock、// @TwoPhaseBusinessAction等注解，来判断是否需要创建代理ProxyInvocationHandler proxyInvocationHandler =DefaultInterfaceParser.get().parserInterfaceToProxy(target, beanName);if (proxyInvocationHandler == null) {return target;}// 创建代理对象// 把proxyInvocationHandler注入到拦截逻辑中// DefaultInvocationHandler实现了java InvocationHandler接口// invoke方法会执行proxyInvocationHandler的代理逻辑T proxy = (T) new ByteBuddy().subclass(target.getClass()).method(isDeclaredBy(target.getClass())).intercept(InvocationHandlerAdapter.of(new DefaultInvocationHandler(proxyInvocationHandler, target))).make().load(target.getClass().getClassLoader()).getLoaded().getDeclaredConstructor().newInstance();PROXYED_SET.put(target, proxy);return proxy;}} catch (Throwable t) {throw new RuntimeException("error occurs when create seata proxy", t);}}
}

DefaultInvocationHandler

public class DefaultInvocationHandler implements InvocationHandler {private ProxyInvocationHandler proxyInvocationHandler;private Object delegate;public DefaultInvocationHandler(ProxyInvocationHandler proxyInvocationHandler, Object delegate) {this.proxyInvocationHandler = proxyInvocationHandler;this.delegate = delegate;}// 动态代理逻辑@Overridepublic Object invoke(Object proxy, Method method, Object[] args) throws Throwable {InvocationWrapper invocation = new DefaultInvocationWrapper(proxy, delegate, method, args);Object result;if (proxyInvocationHandler != null) {result = proxyInvocationHandler.invoke(invocation);} else {result = invocation.proceed();}return result;}
}

GlobalTransactionScanner

继承了spring的AbstractAutoProxyCreator类：

初始化TM和RM客户端
为seata的事务组件创建AOP代理

initClient方法创建TM和RM客户端

使用seata提供的TMClient和RMClient工具栏初始化TM、RM客户端：

private void initClient() {// ...if (StringUtils.isNullOrEmpty(applicationId) || StringUtils.isNullOrEmpty(txServiceGroup)) {throw new IllegalArgumentException(String.format("applicationId: %s, txServiceGroup: %s", applicationId, txServiceGroup));}// 创建TmNettyRemotingClientTMClient.init(applicationId, txServiceGroup, accessKey, secretKey);// 创建RmNettyRemotingClientRMClient.init(applicationId, txServiceGroup);// 优雅关闭客户端registerSpringShutdownHook();
}

wrapIfNecessary方法创建AOP代理

protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) {// do checkersif (!doCheckers(bean, beanName)) {return bean;}try {synchronized (PROXYED_SET) {if (PROXYED_SET.contains(beanName)) {return bean;}interceptor = null;// 和ProxyUtil工具类一样ProxyInvocationHandler proxyInvocationHandler =DefaultInterfaceParser.get().parserInterfaceToProxy(bean, beanName);// 如果proxyInvocationHandler为null表示不需要AOP代理if (proxyInvocationHandler == null) {return bean;}// AdapterSpringSeataInterceptor实现了MethodInterceptor接口// 用来封装spring aop的代理拦截逻辑// 这是spring aop的原理，此处不展开分析interceptor = new AdapterSpringSeataInterceptor(proxyInvocationHandler);if (!AopUtils.isAopProxy(bean)) {// 如果bean不是一个代理对象则使用父类方法创建代理对象bean = super.wrapIfNecessary(bean, beanName, cacheKey);} else {// 如果bean已经是一个代理对象// 则需要将事务拦截逻辑添加到代理通知集AdvisedSupport advised = SpringProxyUtils.getAdvisedSupport(bean);Advisor[] advisor = buildAdvisors(beanName, getAdvicesAndAdvisorsForBean(null, null, null));int pos;for (Advisor avr : advisor) {pos = findAddSeataAdvisorPosition(advised, avr);advised.addAdvisor(pos, avr);}}PROXYED_SET.add(beanName);return bean;}} catch (Exception exx) {throw new RuntimeException(exx);}
}

AdapterSpringSeataInterceptor

public class AdapterSpringSeataInterceptor implements MethodInterceptor, SeataInterceptor, Ordered {private ProxyInvocationHandler proxyInvocationHandler;public AdapterSpringSeataInterceptor(ProxyInvocationHandler proxyInvocationHandler) {this.proxyInvocationHandler = proxyInvocationHandler;}@Overridepublic Object invoke(MethodInvocation invocation) throws Throwable {AdapterInvocationWrapper adapterInvocationWrapper = new AdapterInvocationWrapper(invocation);Object result = proxyInvocationHandler.invoke(adapterInvocationWrapper);return result;}@Overridepublic int getOrder() {return proxyInvocationHandler.getOrder();}@Overridepublic void setOrder(int order) {proxyInvocationHandler.setOrder(order);}@Overridepublic SeataInterceptorPosition getPosition() {return proxyInvocationHandler.getPosition();}@Overridepublic String toString() {return proxyInvocationHandler.getClass().getName();}
}

SeataAutoConfiguration配置类

用来装配GlobalTransactionScanner组件。

SeataAutoDataSourceProxyCreator

在spring环境中，将原始的DataSource保证为SeataDataSourceProxy对象。

SeataDataSourceAutoConfiguration配置类

用来装配SeataAutoDataSourceProxyCreator组件。

ProxyInvocationHandler

用来封装代理的拦截逻辑。

接口定义

public interface ProxyInvocationHandler extends SeataInterceptor {Set<String> getMethodsToProxy();// 代理拦截逻辑Object invoke(InvocationWrapper invocation) throws Throwable;SeataInterceptorPosition getPosition();
}

实现类

ProxyInvocationHandler|-- AbstractProxyInvocationHandler|-- GlobalTransactionalInterceptorHandler|-- TccActionInterceptorHandler

AbstractProxyInvocationHandler

使用模板方法封装通用的代理检查逻辑：

public abstract class AbstractProxyInvocationHandler implements ProxyInvocationHandler {// 子类实现具体的代理逻辑protected abstract Object doInvoke(InvocationWrapper invocation) throws Throwable;protected int order = Integer.MAX_VALUE;@Overridepublic Object invoke(InvocationWrapper invocation) throws Throwable {if (CollectionUtils.isNotEmpty(getMethodsToProxy()) &&!getMethodsToProxy().contains(invocation.getMethod().getName())) {return invocation.proceed();}return doInvoke(invocation);}// 其他方法 略
}