有来实验室|第一篇：Seata1.5.2版本部署和开源全栈商城订单支付业务实战

在线体验：Seata实验室

一.  前言

相信 youlai-mall 的实验室大家有曾在项目中见到过，但应该都还处于陌生的阶段，毕竟在此之前实验室多是以概念般的形式存在，所以我想借着此次的机会，对其进行一个详细的说明。
实验室模块的建立初衷和开源项目的成立一致的，都是为了提升开发成员的技术能力，只不过开源项目是从技术栈广度上(全栈)，而实验室则是从技术栈深度方面切入，更重要的它是一种更深刻而又高效的学习方式。为什么能够这么说？因为实验室是结合真实的业务场景把中间件的作用可视化出来，达到通过现象去看本质(原理和源码)的目的，再也不是被动式输入的短期记忆学习。
实验室未来计划是将工作和面试常见的中间件(Spring、MyBatis、Redis、Seata、MQ、MySQL、ES等)做进来，本篇就以 Seata 为例正式为有来实验室拉开一个序幕。
二. Seata 概念

Seata 是一款开源的分布式事务解决方案，致力于提供高性能和简单易用的分布式事务服务。Seata 将为用户提供了 AT、TCC、SAGA 和 XA 事务模式，为用户打造一站式的分布式解决方案。
术语TC (Transaction Coordinator) - 事务协调者维护全局和分支事务的状态，驱动全局事务提交或回滚。TM (Transaction Manager) - 事务管理器定义全局事务的范围：开始全局事务、提交或回滚全局事务。RM (Resource Manager) - 资源管理器管理分支事务处理的资源，与TC交谈以注册分支事务和报告分支事务的状态，并驱动分支事务提交或回滚。三. Seata 服务端部署

中间件声明

中间件版本服务器IP端口Seata1.5.2192.168.10.1008091、7091Nacos2.0.3192.168.10.998848MySQL8.0.27192.168.10.983306官方链接

名称地址文档http://seata.io/zh-cn/源码https://github.com/seata/seataMySQL脚本https://github.com/seata/seata/blob/1.5.2/script/server/db/mysql.sqlSeata外置配置https://github.com/seata/seata/blob/1.5.2/script/config-center/config.txtSeata 数据库

Seata 表结构MySQL脚本在线地址：   https://github.com/seata/seata/blob/1.5.2/script/server/db/mysql.sql
执行以下脚本完成 Seata 数据库创建和表的初始化：

1. -- 1. 执行语句创建名为 seata 的数据库
2. CREATE DATABASE seata DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_general_ci;
4. -- 2.执行脚本完成 Seata 表结构的创建
5. use seata;
7. -- the table to store GlobalSession data
8. CREATE TABLE IF NOT EXISTS `global_table`
9. (
10.     `xid`                       VARCHAR(128) NOT NULL,
11.     `transaction_id`            BIGINT,
12.     `status`                    TINYINT      NOT NULL,
13.     `application_id`            VARCHAR(32),
14.     `transaction_service_group` VARCHAR(32),
15.     `transaction_name`          VARCHAR(128),
16.     `timeout`                   INT,
17.     `begin_time`                BIGINT,
18.     `application_data`          VARCHAR(2000),
19.     `gmt_create`                DATETIME,
20.     `gmt_modified`              DATETIME,
21.     PRIMARY KEY (`xid`),
22.     KEY `idx_status_gmt_modified` (`status` , `gmt_modified`),
23.     KEY `idx_transaction_id` (`transaction_id`)
24. ) ENGINE = InnoDB
25.   DEFAULT CHARSET = utf8mb4;
27. -- the table to store BranchSession data
28. CREATE TABLE IF NOT EXISTS `branch_table`
29. (
30.     `branch_id`         BIGINT       NOT NULL,
31.     `xid`               VARCHAR(128) NOT NULL,
32.     `transaction_id`    BIGINT,
33.     `resource_group_id` VARCHAR(32),
34.     `resource_id`       VARCHAR(256),
35.     `branch_type`       VARCHAR(8),
36.     `status`            TINYINT,
37.     `client_id`         VARCHAR(64),
38.     `application_data`  VARCHAR(2000),
39.     `gmt_create`        DATETIME(6),
40.     `gmt_modified`      DATETIME(6),
41.     PRIMARY KEY (`branch_id`),
42.     KEY `idx_xid` (`xid`)
43. ) ENGINE = InnoDB
44.   DEFAULT CHARSET = utf8mb4;
46. -- the table to store lock data
47. CREATE TABLE IF NOT EXISTS `lock_table`
48. (
49.     `row_key`        VARCHAR(128) NOT NULL,
50.     `xid`            VARCHAR(128),
51.     `transaction_id` BIGINT,
52.     `branch_id`      BIGINT       NOT NULL,
53.     `resource_id`    VARCHAR(256),
54.     `table_name`     VARCHAR(32),
55.     `pk`             VARCHAR(36),
56.     `status`         TINYINT      NOT NULL DEFAULT '0' COMMENT '0:locked ,1:rollbacking',
57.     `gmt_create`     DATETIME,
58.     `gmt_modified`   DATETIME,
59.     PRIMARY KEY (`row_key`),
60.     KEY `idx_status` (`status`),
61.     KEY `idx_branch_id` (`branch_id`),
62.     KEY `idx_xid_and_branch_id` (`xid` , `branch_id`)
63. ) ENGINE = InnoDB
64.   DEFAULT CHARSET = utf8mb4;
66. CREATE TABLE IF NOT EXISTS `distributed_lock`
67. (
68.     `lock_key`       CHAR(20) NOT NULL,
69.     `lock_value`     VARCHAR(20) NOT NULL,
70.     `expire`         BIGINT,
71.     primary key (`lock_key`)
72. ) ENGINE = InnoDB
73.   DEFAULT CHARSET = utf8mb4;
75. INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('AsyncCommitting', ' ', 0);
76. INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('RetryCommitting', ' ', 0);
77. INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('RetryRollbacking', ' ', 0);
78. INSERT INTO `distributed_lock` (lock_key, lock_value, expire) VALUES ('TxTimeoutCheck', ' ', 0);

复制代码

Seata 配置

这里采用 Nacos 作为配置中心的方式，所以需要把 Seata 的外置配置 放置在Nacos上
1. 获取 Seata 外置配置

获取Seata 配置在线地址：https://github.com/seata/seata/blob/1.5.2/script/config-center/config.txt
完整配置如下：

1. #For details about configuration items, see https://seata.io/zh-cn/docs/user/configurations.html
2. #Transport configuration, for client and server
3. transport.type=TCP
4. transport.server=NIO
5. transport.heartbeat=true
6. transport.enableTmClientBatchSendRequest=false
7. transport.enableRmClientBatchSendRequest=true
8. transport.enableTcServerBatchSendResponse=false
9. transport.rpcRmRequestTimeout=30000
10. transport.rpcTmRequestTimeout=30000
11. transport.rpcTcRequestTimeout=30000
12. transport.threadFactory.bossThreadPrefix=NettyBoss
13. transport.threadFactory.workerThreadPrefix=NettyServerNIOWorker
14. transport.threadFactory.serverExecutorThreadPrefix=NettyServerBizHandler
15. transport.threadFactory.shareBossWorker=false
16. transport.threadFactory.clientSelectorThreadPrefix=NettyClientSelector
17. transport.threadFactory.clientSelectorThreadSize=1
18. transport.threadFactory.clientWorkerThreadPrefix=NettyClientWorkerThread
19. transport.threadFactory.bossThreadSize=1
20. transport.threadFactory.workerThreadSize=default
21. transport.shutdown.wait=3
22. transport.serialization=seata
23. transport.compressor=none
25. #Transaction routing rules configuration, only for the client
26. service.vgroupMapping.default_tx_group=default
27. #If you use a registry, you can ignore it
28. service.default.grouplist=127.0.0.1:8091
29. service.enableDegrade=false
30. service.disableGlobalTransaction=false
32. #Transaction rule configuration, only for the client
33. client.rm.asyncCommitBufferLimit=10000
34. client.rm.lock.retryInterval=10
35. client.rm.lock.retryTimes=30
36. client.rm.lock.retryPolicyBranchRollbackOnConflict=true
37. client.rm.reportRetryCount=5
38. client.rm.tableMetaCheckEnable=true
39. client.rm.tableMetaCheckerInterval=60000
40. client.rm.sqlParserType=druid
41. client.rm.reportSuccessEnable=false
42. client.rm.sagaBranchRegisterEnable=false
43. client.rm.sagaJsonParser=fastjson
44. client.rm.tccActionInterceptorOrder=-2147482648
45. client.tm.commitRetryCount=5
46. client.tm.rollbackRetryCount=5
47. client.tm.defaultGlobalTransactionTimeout=60000
48. client.tm.degradeCheck=false
49. client.tm.degradeCheckAllowTimes=10
50. client.tm.degradeCheckPeriod=2000
51. client.tm.interceptorOrder=-2147482648
52. client.undo.dataValidation=true
53. client.undo.logSerialization=jackson
54. client.undo.onlyCareUpdateColumns=true
55. server.undo.logSaveDays=7
56. server.undo.logDeletePeriod=86400000
57. client.undo.logTable=undo_log
58. client.undo.compress.enable=true
59. client.undo.compress.type=zip
60. client.undo.compress.threshold=64k
61. #For TCC transaction mode
62. tcc.fence.logTableName=tcc_fence_log
63. tcc.fence.cleanPeriod=1h
65. #Log rule configuration, for client and server
66. log.exceptionRate=100
68. #Transaction storage configuration, only for the server. The file, DB, and redis configuration values are optional.
69. store.mode=file
70. store.lock.mode=file
71. store.session.mode=file
72. #Used for password encryption
73. store.publicKey=
75. #If `store.mode,store.lock.mode,store.session.mode` are not equal to `file`, you can remove the configuration block.
76. store.file.dir=file_store/data
77. store.file.maxBranchSessionSize=16384
78. store.file.maxGlobalSessionSize=512
79. store.file.fileWriteBufferCacheSize=16384
80. store.file.flushDiskMode=async
81. store.file.sessionReloadReadSize=100
83. #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.
84. store.db.datasource=druid
85. store.db.dbType=mysql
86. store.db.driverClassName=com.mysql.jdbc.Driver
87. store.db.url=jdbc:mysql://127.0.0.1:3306/seata?useUnicode=true&rewriteBatchedStatements=true
88. store.db.user=username
89. store.db.password=password
90. store.db.minConn=5
91. store.db.maxConn=30
92. store.db.globalTable=global_table
93. store.db.branchTable=branch_table
94. store.db.distributedLockTable=distributed_lock
95. store.db.queryLimit=100
96. store.db.lockTable=lock_table
97. store.db.maxWait=5000
99. #These configurations are required if the `store mode` is `redis`. If `store.mode,store.lock.mode,store.session.mode` are not equal to `redis`, you can remove the configuration block.
100. store.redis.mode=single
101. store.redis.single.host=127.0.0.1
102. store.redis.single.port=6379
103. store.redis.sentinel.masterName=
104. store.redis.sentinel.sentinelHosts=
105. store.redis.maxConn=10
106. store.redis.minConn=1
107. store.redis.maxTotal=100
108. store.redis.database=0
109. store.redis.password=
110. store.redis.queryLimit=100
112. #Transaction rule configuration, only for the server
113. server.recovery.committingRetryPeriod=1000
114. server.recovery.asynCommittingRetryPeriod=1000
115. server.recovery.rollbackingRetryPeriod=1000
116. server.recovery.timeoutRetryPeriod=1000
117. server.maxCommitRetryTimeout=-1
118. server.maxRollbackRetryTimeout=-1
119. server.rollbackRetryTimeoutUnlockEnable=false
120. server.distributedLockExpireTime=10000
121. server.xaerNotaRetryTimeout=60000
122. server.session.branchAsyncQueueSize=5000
123. server.session.enableBranchAsyncRemove=false
124. server.enableParallelRequestHandle=false
126. #Metrics configuration, only for the server
127. metrics.enabled=false
128. metrics.registryType=compact
129. metrics.exporterList=prometheus
130. metrics.exporterPrometheusPort=9898

复制代码

2.  导入配置至 Nacos

在 Nacos 默认的 public 命名空间下 ，新建配置 Data ID 为 seataServer.properties ，Group 为 SEATA_GROUP 的配置


3. 修改 Seata 外置配置

把默认 Seata 全量配置导入 Nacos 之后，本篇这里仅需修存储模式为db以及对应的db连接配置

1. # 修改store.mode为db，配置数据库连接
2. store.mode=db
3. store.db.dbType=mysql
4. store.db.driverClassName=com.mysql.cj.jdbc.Driver
5. store.db.url=jdbc:mysql://192.168.10.98:3306/seata?useUnicode=true&rewriteBatchedStatements=true
6. store.db.user=root
7. store.db.password=123456

复制代码

• **store.mode=db **存储模式选择为数据库
  
• 192.168.10.98   MySQL主机地址
  
• store.db.user=root 数据库用户名
  
• store.db.password=123456 数据库密码
  

Seata 部署

Seata 官方部署文档：https://seata.io/zh-cn/docs/ops/deploy-by-docker.html
1.  获取应用配置

按照官方文档描述使用自定义配置文件的部署方式，需要先创建临时容器把配置copy到宿主机
创建临时容器

1. docker run -d --name seata-server -p 8091:8091 -p 7091:7091 seataio/seata-server:1.5.2

复制代码

创建挂载目录

1. mkdir -p /mnt/seata/config

复制代码

复制容器配置至宿主机

1. docker cp seata-server:/seata-server/resources/ /mnt/seata/config

复制代码

注意复制到宿主机的目录，下文启动容器需要做宿主机和容器的目录挂载

过河拆桥，删除临时容器

1. docker rm -f seata-server

复制代码

2. 修改启动配置

在获取到 seata-server 的应用配置之后，因为这里采用 Nacos 作为 seata 的配置中心和注册中心，所以需要修改  application.yml 里的配置中心和注册中心地址，详细配置我们可以从 application.example.yml 拿到。
application.yml 原配置

修改后的配置(参考 application.example.yml 示例文件)，以下是需要调整的部分，其他配置默认即可

1. seata:
2.   config:
3.     type: nacos
4.     nacos:
5.       server-addr: 192.168.10.99:8848
6.       namespace:
7.       group: SEATA_GROUP
8.       data-id: seataServer.properties
9.   registry:
10.     type: nacos
11.     preferred-networks: 30.240.*
12.     nacos:
13.       application: seata-server
14.       server-addr: 192.168.10.99:8848
15.       namespace:
16.       group: SEATA_GROUP
17.       cluster: default
18.   # 存储模式在外置配置(Nacos)中，Nacos 配置加载优先级大于application.yml，会被application.yml覆盖，所以此处注释
19.   #store:
20.           #mode: file

复制代码

• **192.168.10.99 ** 是Nacos宿主机的IP地址，Docker部署别错填 localhost 或Docker容器的IP(172.17. * . *)
  
• namespace  nacos命名空间id，不填默认是public命名空间
  
• data-id: seataServer.properties  Seata外置文件所处Naocs的Data ID，参考上小节的 导入配置至 Nacos
  
• group: SEATA_GROUP 指定注册至nacos注册中心的分组名
  
• cluster: default 指定注册至nacos注册中心的集群名
  

3. 启动容器

1. docker run -d --name seata-server --restart=always  \
2. -p 8091:8091 \
3. -p 7091:7091 \
4. -e SEATA_IP=192.168.10.100 \
5. -v /mnt/seata/config:/seata-server/resources \
6. seataio/seata-server:1.5.2

复制代码

• /mnt/seata/config  Seata应用配置挂载在宿主机的目录
  
• **192.168.10.100 ** Seata 宿主机IP地址
  

在 nacos 控制台 的 public 命名空间下服务列表里有 seata-server 说明部署启动成功

如果启动失败或者未注册到 nacos , 基本是粗心的结果，请仔细检查下自己 application.yml 的注册中心配置或查看日志

1. docker logs -f --tail=100 seata-server

复制代码

以上就完成对 Seata 服务端的部署和配置，接下来就是 SpringBoot  与 Seata 客户端的整合。
四. Seata 客户端搭建

1. Maven 依赖

1. <dependency>
2.     <groupId>com.alibaba.cloud</groupId>
3.     <artifactId>spring-cloud-starter-alibaba-seata</artifactId>
4.    
5.     <exclusions>
6.         <exclusion>
7.             <groupId>io.seata</groupId>
8.             <artifactId>seata-spring-boot-starter</artifactId>
9.         </exclusion>
10.     </exclusions>
11. </dependency>
12. <dependency>
13.     <groupId>io.seata</groupId>
14.     <artifactId>seata-spring-boot-starter</artifactId>
15.     <version>1.5.2</version>
16. </dependency>

复制代码

2. undo_log 表

undo_log表脚本： https://github.com/seata/seata/blob/1.5.2/script/client/at/db/mysql.sql

1. -- for AT mode you must to init this sql for you business database. the seata server not need it.
2. CREATE TABLE IF NOT EXISTS `undo_log`
3. (
4.     `branch_id`     BIGINT       NOT NULL COMMENT 'branch transaction id',
5.     `xid`           VARCHAR(128) NOT NULL COMMENT 'global transaction id',
6.     `context`       VARCHAR(128) NOT NULL COMMENT 'undo_log context,such as serialization',
7.     `rollback_info` LONGBLOB     NOT NULL COMMENT 'rollback info',
8.     `log_status`    INT(11)      NOT NULL COMMENT '0:normal status,1:defense status',
9.     `log_created`   DATETIME(6)  NOT NULL COMMENT 'create datetime',
10.     `log_modified`  DATETIME(6)  NOT NULL COMMENT 'modify datetime',
11.     UNIQUE KEY `ux_undo_log` (`xid`, `branch_id`)
12. ) ENGINE = InnoDB
13.   AUTO_INCREMENT = 1
14.   DEFAULT CHARSET = utf8mb4 COMMENT ='AT transaction mode undo table';

复制代码

AT模式两阶段提交协议的演变：

• 一阶段：业务数据和回滚日志记录在同一个本地事务中提交，释放本地锁和连接资源。
  
• 二阶段：
  
  
  
  • 提交异步化，非常快速地完成。
    
  • 回滚通过一阶段的回滚日志进行反向补偿。
    
  
  

Seata的AT模式下之所以在第一阶段直接提交事务，依赖的是需要在每个RM创建一张undo_log表，记录业务执行前后的数据快照。
如果二阶段需要回滚，直接根据undo_log表回滚，如果执行成功，则在第二阶段删除对应的快照数据。
3. 客户端配置

1. # Seata配置
2. seata:
3.   enabled: true
4.   # 指定事务分组至集群映射关系，集群名default需要与seata-server注册到Nacos的cluster保持一致
5.   service:
6.     vgroup-mapping:
7.       mall_tx_group: default
8.   # 事务分组配置
9.   tx-service-group: mall_tx_group
10.   registry:
11.     type: nacos
12.     nacos:
13.       application: seata-server
14.       # nacos 服务地址
15.       server-addr: 192.168.10.99:8848
16.       namespace:
17.       group: SEATA_GROUP

复制代码

以上3点就是 Seata 客户端需要做的事项，下面就 Seata 如何实战应用进行展开详细说明。
五. Seata 实战

Seata 官网示例： http://seata.io/zh-cn/docs/user/quickstart.html
需求

用户购买商品订单支付的业务逻辑。整个业务逻辑由3个微服务提供支持：

• 商品服务：扣减商品库存。
  
• 订单服务：修改订单状态【已支付】。
  
• 会员服务：扣减账户余额。
  

架构图

• TM：事务管理器(有来实验室：laboratory)
  
• RM：资源管理器(商城服务：mall-pms；会员服务：mall-ums；订单服务：mall-oms)
  
• TC ：事务协调者(Seata服务端：seata-server)
  

代码实现

有来实验室

实验室在“订单支付”案例中扮演的是【事务管理器】的角色，其工作内容是开始全局事务、提交或回滚全局事务。
按照 【第三节-Seata客户端搭建 】 在 laboratory 模块添加 Maven 依赖和客户端的配置。
订单支付关键代码片段(SeataServiceImpl#payOrderWithGlobalTx)，通过注解 GlobalTransactional 开启全局事务，通过对商品 Feign 客户端和订单 Feign 客户端的调用完成订单支付的流程，这是全局事务开始的地方。

1.     /**
2.      * 订单支付(全局事务)
3.      */
4.     @GlobalTransactional
5.     public boolean payOrderWithGlobalTx(SeataForm seataForm) {
7.         log.info("========扣减商品库存========");
8.         skuFeignClient.deductStock(skuId, 1);
10.         log.info("========订单支付========");
11.         orderFeignClient.payOrder(orderId, ...);
13.         return true;
14.     }

复制代码

商品服务

按照 【第三节-Seata客户端搭建 】 在 mall-pms 模块添加 Maven 依赖和客户端的配置，在 mall-pms 数据库创建 undo_log 表。
扣减库存关键代码：

1.     /**
2.      * 「实验室」扣减商品库存
3.      */
4.     public boolean deductStock(Long skuId, Integer num) {
5.         boolean result = this.update(new LambdaUpdateWrapper<PmsSku>()
6.                 .setSql("stock_num = stock_num - " + num)
7.                 .eq(PmsSku::getId, skuId)
8.         );
9.         return result;
10.     }

复制代码

订单服务

按照 【第三节-Seata客户端搭建 】 在 mall-oms 模块添加 Maven 依赖和客户端的配置，在 mall-oms 数据库创建 undo_log 表。
订单支付关键代码：

1.     /**
2.      * 「实验室」订单支付
3.      */
4.     public Boolean payOrder(Long orderId, SeataOrderDTO orderDTO) {
6.         Long memberId = orderDTO.getMemberId();
7.         Long amount = orderDTO.getAmount();
9.         // 扣减账户余额
10.         memberFeignClient.deductBalance(memberId, amount);
12.         // 【关键】如果开启异常，全局事务将会回滚
13.         Boolean openEx = orderDTO.getOpenEx();
14.         if (openEx) {
15.             int i = 1 / 0;
16.         }
18.         // 修改订单【已支付】
19.         boolean result = this.update(new LambdaUpdateWrapper<OmsOrder>()
20.                 .eq(OmsOrder::getId, orderId)
21.                 .set(OmsOrder::getStatus, OrderStatusEnum.WAIT_SHIPPING.getValue())
22.         );
24.         return result;
25.     }

复制代码

会员服务

按照 【第三节-Seata客户端搭建 】 在 mall-ums 模块添加 Maven 依赖和客户端的配置，在 mall-ums 数据库创建 undo_log 表。
扣减余额关键代码：

1.     @ApiOperation(value = "「实验室」扣减会员余额")
2.     @PutMapping("/{memberId}/balances/_deduct")
3.     public Result deductBalance(@PathVariable Long memberId, @RequestParam Long amount) {
4.         boolean result = memberService.update(new LambdaUpdateWrapper<UmsMember>()
5.                 .setSql("balance = balance - " + amount)
6.                 .eq(UmsMember::getId, memberId));
7.         return Result.judge(result);
8.     }

复制代码

测试

以上就基于 youlai-mall 商城订单支付的业务简单实现的 Seata 实验室，接下来通过测试来看看 Seata 分布式事务的能力。
未开启事务

未开启事务前提： 订单状态因为异常修改失败，但这并未影响到商品库存扣减和余额扣减成功的结果，明显这不是希望的结果。

开启事务

开启事务前提：订单状态修改发生异常，同时也回滚了扣减库存、扣减余额的行为，可见 Seata 分布式事务生效。

六. Seata 源码

因为 Seata 源码牵涉角色比较多，需要在本地搭建 seata-server 然后和 Seata 客户端交互调试，后面整理出来会单独拿一篇文章进行进行具体分析。

七. 结语

本篇通过 Seata 1.5.2 版本部署到实战讲述了 Seata 分布式事务AT模式在商城订单支付业务场景的应用，相信大家对 Seata 和有来实验室有个初步的认知，但这里还只是一个开始，后续会有更多的热门中间件登上实验室舞台。当然，可见这个舞台很大，所以也希望有兴趣或者有想法同学加入有来实验室的开发。
附. 源码

本文源码已推送至gitee和github仓库
giteegithub后端工程https://gitee.com/youlaitech/youlai-mallhttps://github.com/youlaitech/youlai-mall前端工程https://gitee.com/youlaiorg/mall-adminhttps://github.com/youlaitech/mall-admin