缘由
Spring Cloud 作为微服务框架,工作当中必用。原因也很简单,Spring cloud 依托Springboot,背靠Spring Framework,又有Eureka 和 Alibaba 两个大厂的支持,大多数的互联网公司会优先选择以此作为后端开发框架。微服务架构下每个服务都会有一个数据库,不同的数据库、不同的服务实例都会产生事务问题。
简述
微服务架构下的功能开发会遇到分布式事务问题,有2PC 3PC TCC等解决方案,基于性能考虑,公司会考虑使用Seata作为分布式事务解决方案,其中提供了基于2PC的AT模式、TCC模式、Saga模式等等,不过最常用的还是AT模式,只需要一个GlobalTransaction注解即可,无业务侵入性。
引入Seata
-
pom引入
com.alibaba.cloud spring-cloud-starter-alibaba-seata -
服务配置
seata.enabled=false seata.application-id=${spring.application.name} seata.tx-service-group=default_tx_group seata.registry.type=nacos seata.registry.nacos.application=seata-server seata.registry.nacos.server-addr=localhost:8848 seata.registry.nacos.namespace=41eddc87-5fc2-4fdf-8d4f-e16118a143e0 seata.registry.nacos.group=SEATA_GROUP seata.config.type=nacos seata.config.nacos.server-addr=localhost:8848 seata.config.nacos.group=SEATA_GROUP seata.config.nacos.namespace=41eddc87-5fc2-4fdf-8d4f-e16118a143e0 seata.config.nacos.data‐id=seataServer.properties
-
nacos配置
配置项 内容 Data ID service.vgroupMapping.default_tx_group Group SEATA_GROUP 配置内容 default / / Data ID seataServer.properties Group SEATA_GROUP 配置内容 default seataServer.properties 配置参考,不同手敲,文档中有脚本的执行方式,
sh ${SEATAPATH}/script/config-center/nacos/nacos-config.sh -h localhost -p 8848 -g SEATA_GROUP -t 5a3c7d6c-f497-4d68-a71a-2e5e3340b3ca
- 功能上开启@GlobalTransaction 注解即可
SpringBoot 集成Seata
分析Seata的集成方式,还是要从 spring-cloud-starter-alibaba-seata 开始,此maven依赖引入:
io.seata
seata-spring-boot-starter
1.3.0
compile
Seata的集成逻辑在Seata-spring-boot-starter当中。以下是依赖源文件中的 spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=
io.seata.spring.boot.autoconfigure.SeataDataSourceAutoConfiguration,
io.seata.spring.boot.autoconfigure.SeataAutoConfiguration,
io.seata.spring.boot.autoconfigure.HttpAutoConfiguration,
io.seata.spring.boot.autoconfigure.SeataSagaAutoConfiguration
SeataAutoConfiguration
- 默认有maven依赖就会加载,可以通过配置关闭Seata: seata.enabled=false.
- 引入默认实现的FailureHandler。
- 引入 GlobalTransactionScanner。
GlobalTransactionScanner 实现了 InitializingBean ApplicationContextAware DisposableBean,在对应的Bean周期完成对Seata的操作,集成 AbstractAutoProxyCreator 实现Aop的逻辑,使得方法上标注@GlobalTransaction注解就能开启分布式事务功能。
- 实例化后执行客户端初始化 initClient,创建TM客户端 RM客户端
- Bean销毁时执行Seata扩展的销毁机制,可以触发TMClient RMClient 中的关闭方法调用。
- 重写的wrapIfNecessary()方法中完成代理类的创建。可以处理GlobalTransaction注解,也是分析的入口。
初始化TM RM 客户端
初始化TM客户端,首先会创建一个 TmNettyRemotingClient 对象,创建对象需要一个线程池,可以通过参数配置线程池。初始化的逻辑比较有意思,里面封装了Netty作为客户端连接工具。
创建过程:
-
创建父类AbstractNettyRemotingClient
- 创建父类 AbstractNettyRemoting,将客户端的 messageExecutor 与Bean销毁关联。
- AbstractNettyRemotingClient 构造方法中创建一些关键对象
- 创建 NettyClientBootstrap 对象,创建Netty客户端的细节就在其中。
- 创建 ChannelDuplexHandler 实现类 io.seata.core.rpc.netty.AbstractNettyRemotingClient.ClientHandler,把Netty的channel方法比如 channelRead(),和Seata注册对应的处理器关联起来,有对应的消息后,就会调用对应的处理器,channelInactive() exceptionCaught() userEventTriggered() 维护着 Seata 中的 channel 的存活和心跳,维护连接池中的有效性。
- 创建 NettyClientChannelManager 对象,使用apache common pools池化netty Channel,避免每次与Seata服务交互都要建立连接。连接的建立和删除逻辑就在其中。
- seata可以通过SPI扩展功能,比如 AuthSigner。
- 读取是否可以批量请求的配置。并设置监听器监听此配置
- 单例对象
初始化过程:
- 注册TC的响应处理器 ClientOnResponseProcessor
- 注册心跳消息处理器 ClientHeartbeatProcessor
- 执行父类 AbstractNettyRemotingClient 初始化,定时刷新注册中心指定分组的Seata服务实例,将实例地址拿到后,建立连接并放入连接池 NettyClientChannelManager。若允许批量请求,则创建合并请求的线程池,合并请求的处理逻辑在 MergedSendRunnable 中。
- 执行父类 AbstractNettyRemoting 初始化,单线程定时执行清理哪些超时的异步请求
- 启动Netty。
初始化RM客户端,创建和初始化过程与TM基本一致。
初始化过程:
- 注册分支事务提交处理器 RmBranchCommitProcessor
- 注册分支事务回滚处理器 RmBranchRollbackProcessor
- 注册undo log 处理器 RmUndoLogProcessor
- 注册TC的响应处理器 ClientOnResponseProcessor
- 注册心跳消息处理器 ClientHeartbeatProcessor
- …
GlobalTransaction注解
Bean初始化完成后调用初始化后的postProcessors,applyBeanPostProcessorsAfterInitialization(),Seata 注册了一个 GlobalTransactionScanner,继承了AbstractAutoProxyCreator,具备了创建代理的能力,每个Bean初始化后都有机会进入GlobalTransactionScanner.wrapIfNecessary()。
进入 wrapIfNecessary()
protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) {
try {
synchronized (PROXYED_SET) {
if (PROXYED_SET.contains(beanName)) {
return bean;
}
interceptor = null;
//check TCC proxy
if (TCCBeanParserUtils.isTccAutoProxy(bean, beanName, applicationContext)) {
// 创建TccActionInterceptor
//TCC interceptor, proxy bean of sofa:reference/dubbo:reference, and LocalTCC
interceptor = new TccActionInterceptor(TCCBeanParserUtils.getRemotingDesc(beanName));
ConfigurationCache.addConfigListener(ConfigurationKeys.DISABLE_GLOBAL_TRANSACTION,
(ConfigurationChangeListener)interceptor);
} else {
Class> serviceInterface = SpringProxyUtils.findTargetClass(bean);
Class>[] interfacesIfJdk = SpringProxyUtils.findInterfaces(bean);
// 非 GlobalTransactional GlobalLock 标注的类或者方法 跳过处理
if (!existsAnnotation(new Class[]{serviceInterface})
&& !existsAnnotation(interfacesIfJdk)) {
return bean;
}
if (interceptor == null) {
if (globalTransactionalInterceptor == null) {
// 创建 GlobalTransactionalInterceptor
globalTransactionalInterceptor = new GlobalTransactionalInterceptor(failureHandlerHook);
ConfigurationCache.addConfigListener(
ConfigurationKeys.DISABLE_GLOBAL_TRANSACTION,
(ConfigurationChangeListener)globalTransactionalInterceptor);
}
interceptor = globalTransactionalInterceptor;
}
}
LOGGER.info("Bean[{}] with name [{}] would use interceptor [{}]", bean.getClass().getName(), beanName, interceptor.getClass().getName());
if (!AopUtils.isAopProxy(bean)) {
// 调用父类的wrapIfNecessary,创建代理类
bean = super.wrapIfNecessary(bean, beanName, cacheKey);
} else {
AdvisedSupport advised = SpringProxyUtils.getAdvisedSupport(bean);
Advisor[] advisor = buildAdvisors(beanName, getAdvicesAndAdvisorsForBean(null, null, null));
for (Advisor avr : advisor) {
advised.addAdvisor(0, avr);
}
}
PROXYED_SET.add(beanName);
return bean;
}
} catch (Exception exx) {
throw new RuntimeException(exx);
}
}
// AbstractAutoProxyCreator
protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) {
// ...
// Create proxy if we have advice.
// 调用子类的 getAdvicesAndAdvisorsForBean 返回 GlobalTransactionalInterceptor 对象。
// 将seata功能织入Bean代理类中
Object[] specificInterceptors = getAdvicesAndAdvisorsForBean(bean.getClass(), beanName, null);
if (specificInterceptors != DO_NOT_PROXY) {
this.advisedBeans.put(cacheKey, Boolean.TRUE);
Object proxy = createProxy(
bean.getClass(), beanName, specificInterceptors, new SingletonTargetSource(bean));
this.proxyTypes.put(cacheKey, proxy.getClass());
return proxy;
}
this.advisedBeans.put(cacheKey, Boolean.FALSE);
return bean;
}
标注 GlobalTransactional GlobalLock 注解的类或者方法的Bean已经创建了代理,那么在Bean方法调用的时候就会进入 GlobalTransactionalInterceptor的 invoke() 方法中执行Seata的逻辑。
@Override
public Object invoke(final MethodInvocation methodInvocation) throws Throwable {
// 获取目标类
Class> targetClass =
methodInvocation.getThis() != null ? AopUtils.getTargetClass(methodInvocation.getThis()) : null;
// 获取目标方法,比如:Foo.bar()
Method specificMethod = ClassUtils.getMostSpecificMethod(methodInvocation.getMethod(), targetClass);
if (specificMethod != null && !specificMethod.getDeclaringClass().equals(Object.class)) {
// 获取原生方法 bar()
final Method method = BridgeMethodResolver.findBridgedMethod(specificMethod);
// 解析出注解
final GlobalTransactional globalTransactionalAnnotation =
getAnnotation(method, targetClass, GlobalTransactional.class);
final GlobalLock globalLockAnnotation = getAnnotation(method, targetClass, GlobalLock.class);
// disable 代表是否禁用service.disableGlobalTransaction,默认是启用状态
boolean localDisable = disable || (degradeCheck && degradeNum >= degradeCheckAllowTimes);
if (!localDisable) {
if (globalTransactionalAnnotation != null || this.aspectTransactional != null) {
AspectTransactional transactional;
if (globalTransactionalAnnotation != null) {
// 构建 AspectTransactional对象,将注解中的参数解析到 对象中
transactional = new AspectTransactional(globalTransactionalAnnotation.timeoutMills(),
globalTransactionalAnnotation.name(), globalTransactionalAnnotation.rollbackFor(),
globalTransactionalAnnotation.rollbackForClassName(),
globalTransactionalAnnotation.noRollbackFor(),
globalTransactionalAnnotation.noRollbackForClassName(),
globalTransactionalAnnotation.propagation(),
globalTransactionalAnnotation.lockRetryInterval(),
globalTransactionalAnnotation.lockRetryTimes());
} else {
transactional = this.aspectTransactional;
}
// 进入GlobalTransaction处理流程
return handleGlobalTransaction(methodInvocation, transactional);
} else if (globalLockAnnotation != null) {
// 进入GlobalLock处理流程
return handleGlobalLock(methodInvocation, globalLockAnnotation);
}
}
}
return methodInvocation.proceed();
}
以上方法是代理类的增强逻辑入口,主要是解析出当前方法的注解,进入GlobalTransaction的处理流程。
Object handleGlobalTransaction(final MethodInvocation methodInvocation,
final AspectTransactional aspectTransactional) throws Throwable {
boolean succeed = true;
try {
// 全局事务的执行是在 transactionalTemplate 对象中进行
return transactionalTemplate.execute(new TransactionalExecutor() {
@Override
public Object execute() throws Throwable {
return methodInvocation.proceed();
}
public String name() {
String name = aspectTransactional.getName();
if (!StringUtils.isNullOrEmpty(name)) {
return name;
}
return formatMethod(methodInvocation.getMethod());
}
// 把注解中的参数解析为 TransactionInfo 对象
@Override
public TransactionInfo getTransactionInfo() {
// reset the value of timeout
int timeout = aspectTransactional.getTimeoutMills();
if (timeout rollbackRules = new LinkedHashSet();
for (Class> rbRule : aspectTransactional.getRollbackFor()) {
rollbackRules.add(new RollbackRule(rbRule));
}
for (String rbRule : aspectTransactional.getRollbackForClassName()) {
rollbackRules.add(new RollbackRule(rbRule));
}
for (Class> rbRule : aspectTransactional.getNoRollbackFor()) {
rollbackRules.add(new NoRollbackRule(rbRule));
}
for (String rbRule : aspectTransactional.getNoRollbackForClassName()) {
rollbackRules.add(new NoRollbackRule(rbRule));
}
transactionInfo.setRollbackRules(rollbackRules);
return transactionInfo;
}
});
} catch (TransactionalExecutor.ExecutionException e) {
TransactionalExecutor.Code code = e.getCode();
// 异常处理机制
switch (code) {
case RollbackDone:
throw e.getOriginalException();
case BeginFailure:
succeed = false;
failureHandler.onBeginFailure(e.getTransaction(), e.getCause());
throw e.getCause();
case CommitFailure:
succeed = false;
failureHandler.onCommitFailure(e.getTransaction(), e.getCause());
throw e.getCause();
case RollbackFailure:
failureHandler.onRollbackFailure(e.getTransaction(), e.getOriginalException());
throw e.getOriginalException();
case RollbackRetrying:
failureHandler.onRollbackRetrying(e.getTransaction(), e.getOriginalException());
throw e.getOriginalException();
default:
throw new ShouldNeverHappenException(String.format("Unknown TransactionalExecutor.Code: %s", code));
}
} finally {
if (degradeCheck) {
EVENT_BUS.post(new DegradeCheckEvent(succeed));
}
}
}
以上会把 GlobalTransaction 注解中的参数转换为一个事务,另创建一个事务执行器,在事务模板中执行事务。
/**
* Execute object.
*
* @param business the business
* @return the object
* @throws TransactionalExecutor.ExecutionException the execution exception
*/
public Object execute(TransactionalExecutor business) throws Throwable {
// 1. Get transactionInfo 获取事务
TransactionInfo txInfo = business.getTransactionInfo();
if (txInfo == null) {
throw new ShouldNeverHappenException("transactionInfo does not exist");
}
// 1.1 Get current transaction, if not null, the tx role is 'GlobalTransactionRole.Participant'. 获取当前全局事务,若有空则是事务参与者
GlobalTransaction tx = GlobalTransactionContext.getCurrent();
// 1.2 Handle the transaction propagation. 按照传播行文处理事务
Propagation propagation = txInfo.getPropagation();
SuspendedResourcesHolder suspendedResourcesHolder = null;
try {
switch (propagation) {
case NOT_SUPPORTED:// 不支持事务,将当前事务挂起,以无事务的方式执行
// If transaction is existing, suspend it.
if (existingTransaction(tx)) {
suspendedResourcesHolder = tx.suspend();
}
// Execute without transaction and return.
return business.execute();
case REQUIRES_NEW:// 需要新事务,挂起当前事务,开始一个新事务
// If transaction is existing, suspend it, and then begin new transaction.
if (existingTransaction(tx)) {
suspendedResourcesHolder = tx.suspend();
tx = GlobalTransactionContext.createNew();
}
// Continue and execute with new transaction
break;
case SUPPORTS:// 支持事务或者无事务运行,没有事务则直接执行方法
// If transaction is not existing, execute without transaction.
if (notExistingTransaction(tx)) {
return business.execute();
}
// Continue and execute with new transaction
break;
case REQUIRED:// 需要事务,当前事务有则是五当前事务,若没有创建一个事务
// If current transaction is existing, execute with current transaction,
// else continue and execute with new transaction.
break;
case NEVER:// 不支持事务
// If transaction is existing, throw exception.
if (existingTransaction(tx)) {
throw new TransactionException(
String.format("Existing transaction found for transaction marked with propagation 'never', xid = %s"
, tx.getXid()));
} else {
// Execute without transaction and return.
return business.execute();
}
case MANDATORY: // 必须要一个事务
// If transaction is not existing, throw exception.
if (notExistingTransaction(tx)) {
throw new TransactionException("No existing transaction found for transaction marked with propagation 'mandatory'");
}
// Continue and execute with current transaction.
break;
default:
throw new TransactionException("Not Supported Propagation:" + propagation);
}
// 1.3 If null, create new transaction with role 'GlobalTransactionRole.Launcher'.
if (tx == null) {
tx = GlobalTransactionContext.createNew();
}
// set current tx config to holder
GlobalLockConfig previousConfig = replaceGlobalLockConfig(txInfo);
try {
// 2. If the tx role is 'GlobalTransactionRole.Launcher', send the request of beginTransaction to TC,
// else do nothing. Of course, the hooks will still be triggered.
// 发起全局事务注册
beginTransaction(txInfo, tx);
Object rs;
try {
// Do Your Business 执行本地方法,作为事务发起者,本地方法中发生的任何远程调用都将携带XID
rs = business.execute();
} catch (Throwable ex) {
// 发起回滚请求,TC收到后,会逐个通知子事务回滚
// 3. The needed business exception to rollback.
completeTransactionAfterThrowing(txInfo, tx, ex);
throw ex;
}
// 4. everything is fine, commit. 提交事务
commitTransaction(tx);
return rs;
} finally {
//5. clear 清理阶段
resumeGlobalLockConfig(previousConfig);
triggerAfterCompletion();
cleanUp();
}
} finally {
// If the transaction is suspended, resume it. 恢复挂起的事务
if (suspendedResourcesHolder != null) {
tx.resume(suspendedResourcesHolder);
}
}
}
GlobalTransactionRole 全局事务角色分为发起者和参与者,以上下文是否有GlobalTransaction对象来判断。
本地方法执行后,远程调用也全部成功,发起者就向Seata发起提交事务的请求。
全局事务ID的传递
Seata支持的远程调用:SpringMvc Dubbbo sofa motan hsf grpc dubbo brpc.
SpringMvc中自定义一个 HandlerInterceptor,在调用preHandle是绑定 seata的 rpcId。向Spring 注入一个 WebMvcConfigurer 实现类将自定义的 HandlerInterceptor 放入MVC中。
Dubbo 会自定义一个Filter扩展,绑定 seata的 rpcId。
其他的远程调用支持,可以自行查看,逻辑比较简单,调用前绑定 rpcId,发生异常需要清除rpcId
以上就是全局事务管理器的大致内容。具体事务的控制在RM端,TM客户端的的操作大多数在上面使用到。
数据源代理
SeataDataSourceAutoConfiguration 会引入 SeataAutoDataSourceProxyCreator,此对象将会创建一个数据库代理,代理类中增强了RM的逻辑,事务提交前要处理RM的逻辑。
SeataAutoDataSourceProxyCreator也是一个 AbstractAutoProxyCreator 子类,会被Spring 作为 AOP处理,重写的wrapIfNecessary()中,将数据库对象进行增强,创建代理类 DataSourceProxy ,具体的创建代理逻辑在 super.wrapIfNecessary() 中。
DataSourceProxy.getConnection() 会创建一个 ConnectionProxy,组合了targetDataSource.getConnection(),不会影响原有数据库连接的使用。
ConnectionProxy 代理的commit方法中,就会GlobalTransaction进行了逻辑处理:注册本地事务,创建undo log 执行本地提交。TC向 RM客户端发出提交或者回滚请求后,处理undolog即可。
@Override
public void commit() throws SQLException {
try {
lockRetryPolicy.execute(() -> {
// 执行提交
doCommit();
return null;
});
} catch (SQLException e) {
if (targetConnection != null && !getAutoCommit() && !getContext().isAutoCommitChanged()) {
rollback();
}
throw e;
} catch (Exception e) {
throw new SQLException(e);
}
}
// 根据上下文判断执行哪种提交
private void doCommit() throws SQLException {
if (context.inGlobalTransaction()) {
processGlobalTransactionCommit();
} else if (context.isGlobalLockRequire()) {
processLocalCommitWithGlobalLocks();
} else {
targetConnection.commit();
}
}
// 全局事务提交
private void processGlobalTransactionCommit() throws SQLException {
try {
// 注册分支事务
register();
} catch (TransactionException e) {
recognizeLockKeyConflictException(e, context.buildLockKeys());
}
try {
// undo log 出场 UndoLogManagerFactory.getUndoLogManager(this.getDbType()).flushUndoLogs(this);
// 真正的业务提交
targetConnection.commit();
} catch (Throwable ex) {
LOGGER.error("process connectionProxy commit error: {}", ex.getMessage(), ex);
report(false);
throw new SQLException(ex);
}
if (IS_REPORT_SUCCESS_ENABLE) {
report(true);
}
context.reset();
}
总结
Seata作为一款分布式的框架,提供了分布式事务的解决方案,其中的实现原理值得分析,以上是对Seata客户端的部分进行了解说,Seata服务端的内容同样精彩,敬请期待。
服务器托管,北京服务器托管,服务器租用 http://www.fwqtg.net