前言:
本文以搭建SEATA官方的sample过程,结合官网介绍的原理和流程,用实际案例来说明SEATA的使用方法和各个组件之间的交互流程,达到让读者一目了然。
目录
1.安装nacos
下载页面
https://github.com/alibaba/nacos/releases/tag/2.1.0
下载nacos-server-2.1.0.tar.gz
解压到192.168.70.204的/usr/local/nacos
编辑/usr/local/nacos/conf/application.properties
说明:这里使用nacos默认端口8848
nacos客户端2.x版本以后,新增了gRPC的通信方式,新增了两个端口。这两个端口在nacos原先的端口上(默认8848),进行一定偏移量自动生成。
端口 | 与主端口的偏移量 | 描述 |
9848 | 1000 | 客户端gRPC请求服务端端口,用于客户端向服务端发起连接和请求 |
9849 | 1001 | 服务端gRPC请求服务端端口,用于服务间同步等 |
启动nacos
/usr/local/nacos/bin/startup.sh –m standalone
浏览器打开链接
http://192.168.70.204:8848/nacos
默认账号nacos,密码nacos
新建命名空间seata
2.安装seata
下载页面
http://seata.io/zh-cn/blog/download.html
下载seata-server-1.5.2.tar.gz
解压到192.168.70.205的/usr/local/seata
编辑/usr/local/seata/conf/application.yml
说明:
1.这里使用SEATA默认服务器端口8091,web端口7091
2.注册中心和配置中心均使用nacos,指向nacos服务地址:192.168.70.204:8848
/usr/local/seata/conf/application.yml
server:
port: 7091
spring:
application:
name: seata-server
logging:
config: classpath:logback-spring.xml
file:
path: ${user.home}/logs/seata
extend:
logstash-appender:
destination: 127.0.0.1:4560
kafka-appender:
bootstrap-servers: 127.0.0.1:9092
topic: logback_to_logstash
console:
user:
username: seata
password: seata
seata:
config:
# support: nacos, consul, apollo, zk, etcd3
#type: file
type: nacos
nacos:
application: seata-server
server-addr: 192.168.70.204:8848
group: "SEATA_GROUP"
namespace: "abc34810-6e99-41dd-a5c3-c9f09fcced39"
registry:
# support: nacos, eureka, redis, zk, consul, etcd3, sofa
#type: file
type: nacos
nacos:
application: seata-server
server-addr: 192.168.70.204:8848
group: "SEATA_GROUP"
namespace: "abc34810-6e99-41dd-a5c3-c9f09fcced39"
store:
# support: file 、 db 、 redis
#mode: file
mode: db
db:
datasource: druid
dbType: mysql
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://192.168.70.204:3306/seata-server?useUnicode=true&rewriteBatchedStatements=true
user: root
password: ""
# server:
# service-port: 8091 #If not configured, the default is '${server.port} + 1000'
security:
secretKey: SeataSecretKey0c382ef121d778043159209298fd40bf3850a017
tokenValidityInMilliseconds: 1800000
ignore:
urls: /,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*.ico,/console-fe/public/**,/api/v1/auth/login
新建数据库seata-server,执行sql脚本seata\script\server\db\mysql.sql
-- -------------------------------- The script used when storeMode is 'db' --------------------------------
-- the table to store GlobalSession data
CREATE TABLE IF NOT EXISTS `global_table`
(
`xid` VARCHAR(128) NOT NULL,
`transaction_id` BIGINT,
`status` TINYINT NOT NULL,
`application_id` VARCHAR(32),
`transaction_service_group` VARCHAR(32),
`transaction_name` VARCHAR(128),
`timeout` INT,
`begin_time` BIGINT,
`application_data` VARCHAR(2000),
`gmt_create` DATETIME,
`gmt_modified` DATETIME,
PRIMARY KEY (`xid`),
KEY `idx_status_gmt_modified` (`status` , `gmt_modified`),
KEY `idx_transaction_id` (`transaction_id`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4;
-- the table to store BranchSession data
CREATE TABLE IF NOT EXISTS `branch_table`
(
`branch_id` BIGINT NOT NULL,
`xid` VARCHAR(128) NOT NULL,
`transaction_id` BIGINT,
`resource_group_id` VARCHAR(32),
`resource_id` VARCHAR(256),
`branch_type` VARCHAR(8),
`status` TINYINT,
`client_id` VARCHAR(64),
`application_data` VARCHAR(2000),
`gmt_create` DATETIME(6),
`gmt_modified` DATETIME(6),
PRIMARY KEY (`branch_id`),
KEY `idx_xid` (`xid`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4;
-- the table to store lock data
CREATE TABLE IF NOT EXISTS `lock_table`
(
`row_key` VARCHAR(128) NOT NULL,
`xid` VARCHAR(128),
`transaction_id` BIGINT,
`branch_id` BIGINT NOT NULL,
`resource_id` VARCHAR(256),
`table_name` VARCHAR(32),
`pk` VARCHAR(36),
`status` TINYINT NOT NULL DEFAULT '0' COMMENT '0:locked ,1:rollbacking',
`gmt_create` DATETIME,
`gmt_modified` DATETIME,
PRIMARY KEY (`row_key`),
KEY `idx_status` (`status`),
KEY `idx_branch_id` (`branch_id`),
KEY `idx_xid_and_branch_id` (`xid` , `branch_id`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4;
CREATE TABLE IF NOT EXISTS `distributed_lock`
(
`lock_key` CHAR(20) NOT NULL,
`lock_value` VARCHAR(20) NOT NULL,
`expire` BIGINT,
primary key (`lock_key`)
) ENGINE = InnoDB
DEFAULT CHARSET = utf8mb4;
INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('AsyncCommitting', ' ', 0);
INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('RetryCommitting', ' ', 0);
INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('RetryRollbacking', ' ', 0);
INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('TxTimeoutCheck', ' ', 0);
启动seata
/usr/local/seata/bin/seata-server.sh -h 192.168.70.205 -p 8091 -m db -n 1 -e dev
打开浏览器链接
默认账号seata,密码seata
3.搭建demo工程
seata的demo工程git页面:
https://github.com/seata/seata-samples
拉回本地,使用idea打开,本机IP:192.168.23.129
springcloud-nacos-seata工程
这里为了让中间状态看得更清楚,加了睡眠时间,无论分布式事务正常或者异常执行,执行过程很快,一些中间状态,例如回滚日志在执行完毕时都会删除
bootstrap.yml
spring:
cloud:
nacos:
config:
server-addr: 192.168.70.204:8848
namespace: abc34810-6e99-41dd-a5c3-c9f09fcced39
group: SEATA_GROUP
discovery:
register-enabled: false
namespace: abc34810-6e99-41dd-a5c3-c9f09fcced39
group: SEATA_GROUP
订单服务application.properties
spring.application.name=order-service
server.port=9091
# Nacos 注册中心地址
#spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
spring.cloud.nacos.discovery.server-addr=192.168.70.204:8848
spring.cloud.nacos.config.server-addr=192.168.70.204:8848
spring.cloud.nacos.discovery.register-enabled=true
spring.cloud.nacos.server-addr=192.168.70.204:8848
# seata 服务分组,要与服务端nacos-config.txt中service.vgroup_mapping的后缀对应
spring.cloud.alibaba.seata.tx-service-group=my_test_tx_group
seata.tx-service-group=my_test_tx_group
seata.service.grouplist.seata-server=192.168.70.205:8901
seata.service.vgroup-mapping.my_test_tx_group=default
seata.config.nacos.group=SEATA_GROUP
seata.registry.type=nacos
seata.registry.nacos.application=seata-server
seata.registry.nacos.server-addr=192.168.70.204:8848
seata.registry.nacos.cluster=default
seata.registry.nacos.group=SEATA_GROUP
seata.registry.nacos.namespace=abc34810-6e99-41dd-a5c3-c9f09fcced39
logging.level.io.seata=debug
# 数据源配置
#spring.datasource.url=jdbc:mysql://localhost:3306/seata_order?allowMultiQueries=true
spring.datasource.url=jdbc:mysql://192.168.70.204:3306/seata-test-01?allowMultiQueries=true
#spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=
说明:订单服务使用端口9091来注册自身服务,数据库执行seata-test-01
库存服务application.properties
spring.application.name=stock-service
server.port=9092
# Nacos 注册中心地址
#spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
spring.cloud.nacos.discovery.server-addr=192.168.70.204:8848
spring.cloud.nacos.config.server-addr=192.168.70.204:8848
spring.cloud.nacos.discovery.register-enabled=true
spring.cloud.nacos.server-addr=192.168.70.204:8848
# seata 服务分组,要与服务端nacos-config.txt中service.vgroup_mapping的后缀对应
spring.cloud.alibaba.seata.tx-service-group=my_test_tx_group
seata.tx-service-group=my_test_tx_group
seata.service.grouplist.seata-server=192.168.70.205:8901
seata.service.vgroup-mapping.my_test_tx_group=default
seata.config.nacos.group=SEATA_GROUP
seata.registry.type=nacos
seata.registry.nacos.application=seata-server
seata.registry.nacos.server-addr=192.168.70.204:8848
seata.registry.nacos.cluster=default
seata.registry.nacos.group=SEATA_GROUP
seata.registry.nacos.namespace=abc34810-6e99-41dd-a5c3-c9f09fcced39
logging.level.io.seata=debug
# 数据源配置
#spring.datasource.url=jdbc:mysql://localhost:3306/seata_stock?allowMultiQueries=true
spring.datasource.url=jdbc:mysql://192.168.70.204:3306/seata-test-02?allowMultiQueries=true
#spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=
说明:库存服务使用端口9092来注册自身服务,数据库执行seata-test-02
分别在数据库seata-test-01和seata-test-02建表undo_log
CREATE TABLE `undo_log`
(
`id` bigint(20) NOT NULL AUTO_INCREMENT,
`branch_id` bigint(20) NOT NULL,
`xid` varchar(100) NOT NULL,
`context` varchar(128) NOT NULL,
`rollback_info` longblob NOT NULL,
`log_status` int(11) NOT NULL,
`log_created` datetime NOT NULL,
`log_modified` datetime NOT NULL,
`ext` varchar(100) DEFAULT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `ux_undo_log` (`xid`,`branch_id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;
在idea把订单服务和库存服务跑起来
在192.168.70.205查看SEATA服务器端日志
tail -200f /usr/local/seata/logs/start.out
订单服务和库存服务分别向SEATA(TC,transaction coordinator)注册成为TM和RM
这时观察nacos服务列表
这里让我们模拟提交分布式事务的过程,在浏览器输入链接
http://192.168.129.23:9091/order/placeOrder/commit
通过SEATA管理台看到,订单服务向SEATA发起了一个分布式事务
库存服务的undo_log表,生成回滚日志
拷贝rollback_info字段的内容,做json格式化处理,得到以下内容
{
"@class":"io.seata.rm.datasource.undo.BranchUndoLog",
"xid":"192.168.70.205:8091:2306133463886057485",
"branchId":2306133463886057486,
"sqlUndoLogs":[
"java.util.ArrayList",
[
{
"@class":"io.seata.rm.datasource.undo.SQLUndoLog",
"sqlType":"UPDATE",
"tableName":"stock_tbl",
"beforeImage":{
"@class":"io.seata.rm.datasource.sql.struct.TableRecords",
"tableName":"stock_tbl",
"rows":[
"java.util.ArrayList",
[
{
"@class":"io.seata.rm.datasource.sql.struct.Row",
"fields":[
"java.util.ArrayList",
[
{
"@class":"io.seata.rm.datasource.sql.struct.Field",
"name":"id",
"keyType":"PRIMARY_KEY",
"type":4,
"value":1
},
{
"@class":"io.seata.rm.datasource.sql.struct.Field",
"name":"commodity_code",
"keyType":"NULL",
"type":12,
"value":"product-1"
},
{
"@class":"io.seata.rm.datasource.sql.struct.Field",
"name":"count",
"keyType":"NULL",
"type":4,
"value":90
}
]
]
}
]
]
},
"afterImage":{
"@class":"io.seata.rm.datasource.sql.struct.TableRecords",
"tableName":"stock_tbl",
"rows":[
"java.util.ArrayList",
[
{
"@class":"io.seata.rm.datasource.sql.struct.Row",
"fields":[
"java.util.ArrayList",
[
{
"@class":"io.seata.rm.datasource.sql.struct.Field",
"name":"id",
"keyType":"PRIMARY_KEY",
"type":4,
"value":1
},
{
"@class":"io.seata.rm.datasource.sql.struct.Field",
"name":"commodity_code",
"keyType":"NULL",
"type":12,
"value":"product-1"
},
{
"@class":"io.seata.rm.datasource.sql.struct.Field",
"name":"count",
"keyType":"NULL",
"type":4,
"value":89
}
]
]
}
]
]
}
}
]
]
}
可以看到回滚日志主要包含了两块内容,分别是数据表stock_tbl指定行id=1的执行前镜像和执行后镜像。
SEATA服务器端日志,
通过日志可以看到
1.订单服务向TC发起了一个分布式事务
2.订单服务和库存服务分别向TC注册事务分支
3.最后订单服务和库存服务执行本地事务均无报错,分布式事务提交成功
4.SEATA原理
SEATA官网
https://seata.io/zh-cn/docs/overview/what-is-seata.html
Seata术语
TC (Transaction Coordinator) - 事务协调者
维护全局和分支事务的状态,驱动全局事务提交或回滚。
TM (Transaction Manager) - 事务管理器
定义全局事务的范围:开始全局事务、提交或回滚全局事务。
RM (Resource Manager) - 资源管理器
管理分支事务处理的资源,与TC交谈以注册分支事务和报告分支事务的状态,并驱动分支事务提交或回滚。
Seata 中,分布式事务的执行流程:
TM 开启分布式事务(TM 向 TC 注册全局事务记录);
按业务场景,编排数据库、服务等事务内资源(RM 向 TC 汇报资源准备状态 );
TM 结束分布式事务,事务一阶段结束(TM 通知 TC 提交/回滚分布式事务);
TC 汇总事务信息,决定分布式事务是提交还是回滚;
TC 通知所有 RM 提交/回滚 资源,事务二阶段结束。
原理(TM和RM都会被seate代理数据源):
1.TM执行业务时,会通过aop拦截@GlobalTransactional注解,先查询ThreadLocal是否有XID,如果没有,会请求TC创建一个XID,获取到XID,保存到ThreadLocal;
2.在调用其他服务接口的时候,会把XID存放到Http请求头传给RM;
3.RM从请求头上获取到XID,会保存到Threadlocal,并且向TC注册事务分支(当前微服务的);
4.RM操作sql前,会记录前置镜像到undo_log表,然后执行sql,成功后再记录后置镜像到undo_log表(记录undo_log和执行业务sql是同一事务),然后提交事务;
5.TM调用RM返回,继续执行业务,如果异常,通知TC,然后TC通知所有事务分支进行回滚;
6.RM收到回滚通知,会执行后置镜像sql,将数据还原,然后删除当前XID中undo_log的镜像记录;
7.如果成功,通知TC,然后TC通知所有事务分支;
8.RM收到成功通知,删除当前XID中undo_log的镜像记录;
5.AT模式
以上面demo示例来说明整个 AT 分支的工作过程。
业务表:stock_tbl
Field | Type | Desc | Key |
---|---|---|---|
id | int(11) | 主键 | PRI |
commodity_code | varchar(255) | 商品代号 | |
count | int(11) | 库存量 |
AT 分支事务的业务逻辑:
update stock_tbl set count = 89 where id= 1;
一阶段
过程:
1.解析 SQL:得到 SQL 的类型(UPDATE),表(stock_tbl),条件(where id = 1)等相关的信息。
2.查询前镜像:根据解析得到的条件信息,生成查询语句,定位数据。
select id, commodity_code, count from stock_tbl where id = 1;
得到前镜像:
id | commodity_code | count |
---|---|---|
1 | product-1 | 90 |
3.执行业务 SQL:更新这条记录的 count 为 89。
4.查询后镜像:根据前镜像的结果,通过 主键 定位数据。
select id, commodity_code, count from stock_tbl where id = 1;
得到后镜像:
id | commodity_code | count |
---|---|---|
1 | product-1 | 89 |
5.插入回滚日志:把前后镜像数据以及业务 SQL 相关的信息组成一条回滚日志记录,插入到 UNDO_LOG
表中。
6.提交前,向 TC 注册分支:申请 stock_tbl表中,主键值等于 1 的记录的 全局锁 。
7.本地事务提交:业务数据的更新和前面步骤中生成的 UNDO LOG 一并提交。
8.将本地事务提交的结果上报给 TC。
二阶段-回滚
- 收到 TC 的分支回滚请求,开启一个本地事务,执行如下操作。
- 通过 XID 和 Branch ID 查找到相应的 UNDO LOG 记录。
- 数据校验:拿 UNDO LOG 中的后镜与当前数据进行比较,如果有不同,说明数据被当前全局事务之外的动作做了修改。这种情况,需要根据配置策略来做处理,详细的说明在另外的文档中介绍。
- 根据 UNDO LOG 中的前镜像和业务 SQL 的相关信息生成并执行回滚的语句:
update stock_tbl set count = 89 where id = 1;
- 提交本地事务。并把本地事务的执行结果(即分支事务回滚的结果)上报给 TC。
二阶段-提交
- 收到 TC 的分支提交请求,把请求放入一个异步任务的队列中,马上返回提交成功的结果给 TC。
- 异步任务阶段的分支提交请求将异步和批量地删除相应 UNDO LOG 记录。
6.TM代码简单导读
GlobalTransactionalInterceptor.java 全局事务拦截器,处理GlobalTransactional注解,把注解本身提供的信息和上下文信息,封装成一个transaction对象,交由transactionTemplate去执行。
TransactionalTemplate.java 事务模板类,模板方法设计模式,使用模板代码开启事务。
DefaultGlobalTransaction.java 全局事务处理器默认实现类,这一层代码主要做了一些跟xid相关的动作。
DefaultTransactionManager.java 事务管理器默认实现类,负责跟TC的交互,封装请求对象,获取响应对象。
7.TC代码简单导读
AbstractNettyRemotingServer.java SEATA服务器端,这里启动了一个serverBootstrap服务类来处理请求,内部类ServerHandler是一个netty的handler类,处理Message,这里processMessage方法是外部类的父类方法。
AbstractNettyRemoting.java 这个类是上面那个类的父类,这里使用了一个通用的代码来处理消息,根据消息类型的不同,采用不同的Processor类来执行process方法。map容器processorTable有消息类型到处理器的映射关系。
NettyRemotingServer.java 统一注册处理器
RegTmProcessor.java 这个是专门处理TM注册请求的处理器。如果注册成功,会在SEATA服务器端日志打印TM register success日志。