SpringCloud整合Seata1.4.2
目录
Seata1.4.2特点
相比于Seata1.0以前的老版本,Seata1.4.2版本与SpringCloud整合主要有两方面的特点:
- 配置文件方面
- 支持在项目中使用properties或yml类型文件配置,不用在项目classpath路径下配置conf类型文件
- 支持在Nacos配置中心使用一条dataId中配置统用参数文件
- 配置类方面
- 默认开启数据源自动代理
- 自动完成GlobalTransactionScanner初始化
可以说在配置方面的改动,大大简化了项目整合Seata的难度
本篇文章就带大家使用SpringCloud Alibaba + Nacos的方式,详细解释整合Seata需要关注的问题
Seata配置文件详解
进行整合之前需要对Seata的配置文件有一个基础的认识,配置文件大概可以分为三类:
- server端
server端一般指Seata的TC端。TC即事务的协调者,用于接收事务注册,提交和回滚
对server端的配置包括注册中心与配置中心两部分的相关信息
server端下载地址(本文使用V1.4.2版本) - client端
client端一般指Seata的TM端和RM端
在SpringCloud中,通常指项目中的每个微服务,使用properties或yml类型文件进行配置- TM即事务的发起者。用来告诉TC,全局事务的开始,提交,回滚
- RM即具体的事务资源,每一个RM都会作为一个分支事务注册在TC
- config-center端
顾名思义,即配置中心端。在本文中使用的配置中心是Nacos,配置内容包括事务分组,数据库连接等信息。
整合Seata
步骤一、创建数据库
数据库作为实现分布式事务高可用的方式被引入进来,主要负责将事务数据保存
在数据库中需创建seata数据库,同时创建
global_table
全局事务, branch_table
分支事务,lock_table
全局锁
sql脚本可以在seata/script/server/db/上获取,本文使用的数据库及版本是Mysql v8.0.21
-- -------------------------------- The script used when storeMode is 'db' ----------------------
-- create database
CREATE DATABASE seata;
USE seata;
-- 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);
注意,在AT
模式中,需要在参与全局事务的数据库中,添加一个undo_log
表,建表语句如下:
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;
-- ----------------------------
-- Table structure for undo_log
-- ----------------------------
DROP TABLE IF EXISTS `undo_log`;
CREATE TABLE `undo_log` (
`branch_id` bigint(20) NOT NULL COMMENT '分支事务ID',
`xid` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '全局事务ID',
`context` varchar(128) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '上下文',
`rollback_info` longblob NOT NULL COMMENT '回滚信息',
`log_status` int(11) NOT NULL COMMENT '状态,0正常,1全局已完成',
`log_created` datetime(6) NOT NULL COMMENT '创建时间',
`log_modified` datetime(6) NOT NULL COMMENT '修改时间',
UNIQUE INDEX `ux_undo_log`(`xid`, `branch_id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = 'AT transaction mode undo table' ROW_FORMAT = Compact;
SET FOREIGN_KEY_CHECKS = 1;
步骤二、启动Nacos配置中心
- 在Nacos命名空间中新建
seata_dev
命名空间,记录下此时的命名空间ID
- 进入 配置管理-配置列表 菜单下,切换到
seata_dev
命名空间,新建一条Data Id
为seataServer.properties,Group
为SEATA_GROUP的配置。
配置格式选择Properties,配置内容可参考 seata/script/config-center/目录下的config.txt进行配置#For details about configuration items, see https://seata.io/zh-cn/docs/user/configurations.html #Transport configuration, for client and server transport.type=TCP transport.server=NIO transport.heartbeat=true transport.enableTmClientBatchSendRequest=false transport.enableRmClientBatchSendRequest=true transport.enableTcServerBatchSendResponse=false transport.rpcRmRequestTimeout=30000 transport.rpcTmRequestTimeout=30000 transport.rpcTcRequestTimeout=30000 transport.threadFactory.bossThreadPrefix=NettyBoss transport.threadFactory.workerThreadPrefix=NettyServerNIOWorker transport.threadFactory.serverExecutorThreadPrefix=NettyServerBizHandler transport.threadFactory.shareBossWorker=false transport.threadFactory.clientSelectorThreadPrefix=NettyClientSelector transport.threadFactory.clientSelectorThreadSize=1 transport.threadFactory.clientWorkerThreadPrefix=NettyClientWorkerThread transport.threadFactory.bossThreadSize=1 transport.threadFactory.workerThreadSize=default transport.shutdown.wait=3 transport.serialization=seata transport.compressor=none #Transaction routing rules configuration, only for the client # 事务分组 需要与项目中的事务分组配置保持一致 service.vgroupMapping.my_test_tx_group=default #Transaction rule configuration, only for the client client.rm.asyncCommitBufferLimit=10000 client.rm.lock.retryInterval=10 client.rm.lock.retryTimes=30 client.rm.lock.retryPolicyBranchRollbackOnConflict=true client.rm.reportRetryCount=5 client.rm.tableMetaCheckEnable=false client.rm.tableMetaCheckerInterval=60000 client.rm.sqlParserType=druid client.rm.reportSuccessEnable=false client.rm.sagaBranchRegisterEnable=false client.rm.sagaJsonParser=fastjson client.rm.tccActionInterceptorOrder=-2147482648 client.tm.commitRetryCount=5 client.tm.rollbackRetryCount=5 client.tm.defaultGlobalTransactionTimeout=60000 client.tm.degradeCheck=false client.tm.degradeCheckAllowTimes=10 client.tm.degradeCheckPeriod=2000 client.tm.interceptorOrder=-2147482648 client.undo.dataValidation=true client.undo.logSerialization=jackson client.undo.onlyCareUpdateColumns=true server.undo.logSaveDays=7 server.undo.logDeletePeriod=86400000 client.undo.logTable=undo_log client.undo.compress.enable=true client.undo.compress.type=zip client.undo.compress.threshold=64k #For TCC transaction mode tcc.fence.logTableName=tcc_fence_log tcc.fence.cleanPeriod=1h #Log rule configuration, for client and server log.exceptionRate=100 #Transaction storage configuration, only for the server. The file, DB, and redis configuration values are optional. # 使用db进行事务存储 store.mode=db store.lock.mode=db store.session.mode=db #Used for password encryption store.publicKey= #These configurations are required if the `store mode` is `db`. If `store.mode,store.lock.mode,store.session.mode` are not equal to `db`, you can remove the configuration block. store.db.datasource=druid store.db.dbType=mysql # Mysql 8.0版本以下请使用com.mysql.jdbc.Driver作为驱动 store.db.driverClassName=com.mysql.cj.jdbc.Driver store.db.url=jdbc:mysql://127.0.0.1:3306/seata?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false # 填写你的mysql用户 store.db.user=root # 填写你的mysql密码 store.db.password=root store.db.minConn=5 store.db.maxConn=30 store.db.globalTable=global_table store.db.branchTable=branch_table store.db.distributedLockTable=distributed_lock store.db.queryLimit=100 store.db.lockTable=lock_table store.db.maxWait=5000 #Transaction rule configuration, only for the server server.recovery.committingRetryPeriod=1000 server.recovery.asynCommittingRetryPeriod=1000 server.recovery.rollbackingRetryPeriod=1000 server.recovery.timeoutRetryPeriod=1000 server.maxCommitRetryTimeout=-1 server.maxRollbackRetryTimeout=-1 server.rollbackRetryTimeoutUnlockEnable=false server.distributedLockExpireTime=10000 server.xaerNotaRetryTimeout=60000 server.session.branchAsyncQueueSize=5000 server.session.enableBranchAsyncRemove=true #Metrics configuration, only for the server metrics.enabled=false metrics.registryType=compact metrics.exporterList=prometheus metrics.exporterPrometheusPort=9898
步骤三、启动Seata-Server
解压后的seata目录结构如下图所示
seata-server的配置文件在conf/
目录下,其中file.conf
只有当registry.conf
中的配置中心设置为file类型时才会使用,因为本文中的注册和配置中心均使用Nacos,所以无需配置file.conf
registry.conf
配置文件内容如下:
# 注册中心信息
registry {
# file 、nacos 、eureka、redis、zk、consul、etcd3、sofa
type = "nacos"
nacos {
# seata-server在Nacos的注册服务名
application = "seata-server"
serverAddr = "127.0.0.1:8848"
# 需要与配置项Group保持一致
group = "SEATA_GROUP"
# 需要与配置项命名空间保持一致
namespace = "2281e0ba-4e41-48f3-9916-e7673159ad24"
# 需要与配置项service.vgroupMapping.my_test_tx_group的值保持一致
cluster = "default"
username = "nacos"
password = "nacos"
}
}
# 配置中心信息
config {
# file、nacos 、apollo、zk、consul、etcd3
type = "nacos"
nacos {
serverAddr = "127.0.0.1:8848"
# 需要与配置项命名空间保持一致
namespace = "2281e0ba-4e41-48f3-9916-e7673159ad24"
# 需要与配置项Group保持一致
group = "SEATA_GROUP"
username = "nacos"
password = "nacos"
# 需要与配置项Data Id保持一致
dataId = "seataServer.properties"
}
}
需要注意registry.conf
中的部分属性需要与之前Nacos配置项的值保持一致,否则Seata-Server启动会报错
完成后,使用如下命令启动Seata-Server
sh ./bin/seata-server.sh -p 8091 -h 127.0.0.1 -m db
启动完成后,在Nacos服务列表中可以查看到注册的服务
在 配置管理-监听查询 可以看到Seata-Server正监听着配置项
步骤四、启动微服务
新建SpringCloud微服务,在pom.xml中引用seata的依赖包
<dependency>
<groupId>io.seata</groupId>
<artifactId>seata-spring-boot-starter</artifactId>
<version>最新版</version>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-seata</artifactId>
<version>2.2.1.RELEASE</version>
<exclusions>
<exclusion>
<groupId>io.seata</groupId>
<artifactId>seata-spring-boot-starter</artifactId>
</exclusion>
</exclusions>
</dependency>
注意,如果这里使用seata-all替换seata-spring-boot-starter作为依赖,需要使用@EnableAutoDataSourceProxy来显式开启数据源自动代理功能,同时需要在项目中创建conf类型配置文件,而使用seata-spring-boot-starter可以将配置项写入到application.properties或yml中。
创建application.yml
文件
server:
port: 2001
spring:
application:
name: seata-order-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/seata_order?rewriteBatchedStatements=true&serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false
username: root
password: root
type: com.alibaba.druid.pool.DruidDataSource
seata:
tx-service-group: my_test_tx_group # 与nacos事务分组配置项保持一致
registry: # 注册中心
type: nacos
nacos:
application: seata-server # seata-server注册在nacos中的服务名
server-addr: 127.0.0.1:8848 # nacos的地址端口
group: SEATA_GROUP # seata-server在nacos的分组
namespace: 2281e0ba-4e41-48f3-9916-e7673159ad24 # seata-server在nacos的命名空间ID
config: # 配置中心
type: nacos
nacos:
server-addr: 127.0.0.1:8848
group: SEATA_GROUP
namespace: 2281e0ba-4e41-48f3-9916-e7673159ad24 # 与配置项命名空间ID保持一致
dataId: seataServer.properties # 与配置项Data Id保持一致
feign:
hystrix:
enabled: false
logging:
level:
io:
seata: info
mybatis:
mapperLocations: classpath:mapper/*.xml
完成业务代码的编写后,启动项目,看到控制台打印如下信息
22022-05-02 15:48:02.269 INFO 10884 --- [ main] i.s.c.rpc.netty.RmNettyRemotingClient : RM will register :jdbc:mysql://localhost:3306/seata_order
2022-05-02 15:48:02.275 INFO 10884 --- [ main] i.s.core.rpc.netty.NettyPoolableFactory : NettyPool create channel to transactionRole:RMROLE,address:192.168.229.1:8091,msg:< RegisterRMRequest{resourceIds='jdbc:mysql://localhost:3306/seata_order', applicationId='seata-order-service', transactionServiceGroup='my_test_tx_group'} >
2022-05-02 15:48:03.654 INFO 10884 --- [ main] i.s.c.rpc.netty.RmNettyRemotingClient : register RM success. client version:1.4.2, server version:1.4.2,channel:[id: 0x791ec63e, L:/192.168.229.1:59605 - R:/192.168.229.1:8091]
2022-05-02 15:48:03.671 INFO 10884 --- [ main] i.s.core.rpc.netty.NettyPoolableFactory : register success, cost 199 ms, version:1.4.2,role:RMROLE,channel:[id: 0x791ec63e, L:/192.168.229.1:59605 - R:/192.168.229.1:8091]
2022-05-02 15:48:55.983 INFO 10884 --- [eoutChecker_1_1] i.s.c.r.netty.NettyClientChannelManager : will connect to 192.168.229.1:8091
2022-05-02 15:48:55.992 INFO 10884 --- [eoutChecker_1_1] i.s.core.rpc.netty.NettyPoolableFactory : NettyPool create channel to transactionRole:TMROLE,address:192.168.229.1:8091,msg:< RegisterTMRequest{applicationId='seata-order-service', transactionServiceGroup='my_test_tx_group'} >
2022-05-02 15:48:56.020 INFO 10884 --- [eoutChecker_1_1] i.s.c.rpc.netty.TmNettyRemotingClient : register TM success. client version:1.4.2, server version:1.4.2,channel:[id: 0xdc0c8277, L:/192.168.229.1:59714 - R:/192.168.229.1:8091]
2022-05-02 15:48:56.020 INFO 10884 --- [eoutChecker_1_1] i.s.core.rpc.netty.NettyPoolableFactory : register success, cost 18 ms, version:1.4.2,role:TMROLE,channel:[id: 0xdc0c8277, L:/192.168.229.1:59714 - R:/192.168.229.1:8091]
可以看到seata RM/TM都已注册成功。
在Nacos 服务管理-订阅者列表可以看到三个微服务都已订阅Seata-Server
至此,SpringCloud整合Seata成功!
测试seata
在AbstractUndoLogManager
类的deleteUndoLog
方法上打上断点,测试undo_log
回滚日志是否在数据库中保存
当事务报错回滚时,进入断点处,此时打开数据库查看undo_log
表中是否产生日志。
可以看到此时表中保存了事务的信息,当回滚完成后,这条数据也会在表中被删除,最终分布式事务回滚成功。