SpringCloud集成Seata实现分布式事务管理

发表于 | 分类于 ， ， | 9999+条评论

前言

事务是保证数据一致性，准确性的重要保证。以spring举例，在单体项目中常用的是注解式事务，例如在service方法上添加 @Transactional(rollbackFor = Exception.class) 注解即可。而当我们业务复杂，数据量大时候，我们就不得不拆分服务，当拆分服务后，每个功能模块都是一个独立运行的服务，这时候我们又该如何处理事务呢？如何保证服务与服务之间的数据一致性呢？

何为数据库事务

数据库事务（Database Transaction）是指作为单个逻辑工作单元执行的一组数据库操作，这些操作要么全部成功完成并永久保存，要么全部失败并回滚到最初状态，以确保数据库的一致性和完整性。

事务具有以下四个特性，通常缩写为 ACID：

  1. 原子性（Atomicity）：事务被视为不可分割的工作单元，要么全部执行成功，要么全部失败回滚。如果事务中的任何一部分操作失败，整个事务都会被回滚到初始状态。
  2. 一致性（Consistency）：事务的执行将数据库从一致状态转移到另一个一致状态，即事务执行前后数据库的完整性约束没有被破坏。
  3. 隔离性（Isolation）：多个事务并发执行时，每个事务的操作应该被隔离，互不干扰。这意味着一个事务的中间状态对其他事务是不可见的，直到事务提交。
  4. 持久性（Durability）：一旦事务提交，其所做的修改将永久保存在数据库中，并不会因为系统故障或其他因素而丢失。

通过事务，可以确保数据库操作的完整性和一致性，避免数据损坏或丢失。数据库管理系统使用事务来保证数据的可靠性，并提供回滚和提交操作来管理事务的执行。

何为分布式事务

分布式事务是指涉及多个独立数据库或应用程序之间的事务操作，这些数据库或应用程序分布在不同的计算机或服务器上。分布式事务需要确保跨多个节点的事务操作具有ACID属性，保证数据的一致性和完整性。

通俗来讲：就是把上面的单体事务连接成多个事务且保证一致。单个变多个，听着简单实际大有搞头。

何为Seata

Seata 是一款开源的分布式事务解决方案，致力于提供高性能和简单易用的分布式事务服务。Seata 将为用户提供了 AT、TCC、SAGA 和 XA 事务模式，为用户打造一站式的分布式解决方案。2023 年 10 月阿里和蚂蚁集团正式将 Seata 捐赠给 Apache 基金会。

部署Seata服务端

1、首先使用docker命令临时启动一个seata容器

1
docker run -d -p 8091:8091 -p 7091:7091  --name seata-server-test seataio/seata-server:latest

2、将此容器启动后内部的配置文件copy出来放到宿主机中，方便后面使用

1
docker cp seata-server-test:/seata-server/resources /home/seata/data

3、删除上面创建的临时容器

1
docker rm -f seata-server-test

4、创建docker-compose.yml。其中/seata-server/resources映射的目录就是第一步copy出来的目录

1
2
3
4
5
6
7
8
9
10
11
12
version: "3.1"
services:
  seata-server:
    image: seataio/seata-server:1.6.1
    container_name: seata-server
    ports:
      - "7091:7091"
      - "8091:8091"
    volumes:
      - "/usr/share/zoneinfo/Asia/Shanghai:/etc/localtime"
      - "/usr/share/zoneinfo/Asia/Shanghai:/etc/timezone"
      - "/home/seata/data/resources:/seata-server/resources"

5、编辑seata的application.yml配置文件，路径为第2步copy出来的位置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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: nacos
    nacos:
      server-addr: 127.0.0.1:8848
      group: DEFAULT_GROUP
      username:
      password:
      data-id: seataServer.properties

  registry:
    # support: nacos, eureka, redis, zk, consul, etcd3, sofa
    type: nacos
    nacos:
      application: seata-server
      server-addr: 127.0.0.1:8848
      group: DEFAULT_GROUP
      # tc集群名称
      cluster: default
      username:
      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

此配置文件的大致意思为：

  1. 使用nacos作为服务的注册中心
  2. 使用nacos作为服务配置中心

PS：因此需要先提前搭建好nacos服务

6、创建seata的配置文件并上传到nacos中

文件名称为：seataServer.properties

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
store.mode=db
#-----db-----
store.db.datasource=druid
store.db.dbType=mysql
# 需要根据mysql的版本调整driverClassName
# mysql8及以上版本对应的driver：com.mysql.cj.jdbc.Driver
# mysql8以下版本的driver：com.mysql.jdbc.Driver
store.db.driverClassName=com.mysql.cj.jdbc.Driver
store.db.url=jdbc:mysql://127.0.0.1:3306/seata?useUnicode=true&characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useSSL=false
store.db.user= 用户名
store.db.password=密码
# 数据库初始连接数
store.db.minConn=1
# 数据库最大连接数
store.db.maxConn=20
# 获取连接时最大等待时间 默认5000，单位毫秒
store.db.maxWait=5000
# 全局事务表名 默认global_table
store.db.globalTable=global_table
# 分支事务表名 默认branch_table
store.db.branchTable=branch_table
# 全局锁表名 默认lock_table
store.db.lockTable=lock_table
# 查询全局事务一次的最大条数 默认100
store.db.queryLimit=100


# undo保留天数 默认7天,log_status=1（附录3）和未正常清理的undo
server.undo.logSaveDays=7
# undo清理线程间隔时间 默认86400000，单位毫秒
server.undo.logDeletePeriod=86400000
# 二阶段提交重试超时时长 单位ms,s,m,h,d,对应毫秒,秒,分,小时,天,默认毫秒。默认值-1表示无限重试
# 公式: timeout>=now-globalTransactionBeginTime,true表示超时则不再重试
# 注: 达到超时时间后将不会做任何重试,有数据不一致风险,除非业务自行可校准数据,否者慎用
server.maxCommitRetryTimeout=-1
# 二阶段回滚重试超时时长
server.maxRollbackRetryTimeout=-1
# 二阶段提交未完成状态全局事务重试提交线程间隔时间 默认1000，单位毫秒
server.recovery.committingRetryPeriod=1000
# 二阶段异步提交状态重试提交线程间隔时间 默认1000，单位毫秒
server.recovery.asynCommittingRetryPeriod=1000
# 二阶段回滚状态重试回滚线程间隔时间  默认1000，单位毫秒
server.recovery.rollbackingRetryPeriod=1000
# 超时状态检测重试线程间隔时间 默认1000，单位毫秒，检测出超时将全局事务置入回滚会话管理器
server.recovery.timeoutRetryPeriod=1000

7、创建seata库的表结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
-- -------------------------------- 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` (`xid`)
) 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);

8、启动seata服务

1
docker-compose up -d

自此Seata的服务端已经全部搭建完成，上面教程给出的是 nacos+db 方式部署。当然也可以选择无nacos、无db方式部署，更为简单但不那么稳定，可能会出现事务丢失情况。

具体配置相关可参考官方文档：https://seata.apache.org/zh-cn/docs/ops/deploy-by-docker-compose

配置Seata客户端

客户端就比较简单分为以下几点

1、服务端项目需要注册到nacos注册中心且和seata共用一个中心

2、引入seata的maven依赖

1
2
3
4
5
6
7
8

<dependencies>
	<dependency>
		<groupId>com.alibaba.cloud</groupId>
		<artifactId>spring-cloud-starter-alibaba-seata</artifactId>
	</dependency>
	</dependency>
</dependencies>

3、配置application.properties相关配置

1
2
# 使用默认nacos组，注意和seata服务端配置保持一致
seata.config.nacos.group=DEFAULT_GROUP

4、在需要使用分布式事务的地方加上注解 @GlobalTransactional

结言

至此分布式事务seata已经全部搭建完成。

详情实战可参考项目：https://github.com/Snykta/forge-fast-cloud （一个可快速开始的SpringCloud微服务脚手架）