快速开始
本项目演示如何使用 spring-cloud-starter-alibaba-seata 完成 Spring Cloud 应用的分布式事务接入。
启动 Seata Server
在运行此示例之前,需要先完成如下几步准备工作启动 Seata Server:
配置数据库
NOTE: MySql 数据库的存储引擎需要为 InnoDB。实际上,Seata 支持不同的应用使用完全不相干的数据库,但是这里为了简单地演示一个原理,所以下面只使用一个数据库。
配置 UNDO_LOG 表
Seata AT 模式需要使用到 undo_log 表。
导入 seata-server db 模式所需要的数据库表
在数据库中初始化 global_table、branch_table、lock_table、distributed_lock。
启动 Seata Server 应用
1.运行 seata-server 启动 Seata server。
示例中采用 nacos 作为配置,注册中心 存储模式为:db 采用 mysql。
2.或点击这个页面 Seata 官网 Github,下载最新版本的 Seata Server 端。
进入解压之后的 bin 目录,执行如下命令来启动, 所有启动参数为可选项。
-p seata-server 监听服务端口号。
-m 存储模式,可选值:file、db。file 用于单点模式,db 用于 ha 模式,当使用 db 存储模式,需要修改配置中 store 配置节点的数据库配置,同时在数据库中初始化global_table、branch_table 和
lock_table。
-h 用于解决 seata-server 和业务侧跨网络问题,其配置的 host 值直接显示到注册中心的服务可用地址 host,当跨网络时这里需要配置为公网 IP 或 NATIP,若都在同一局域网则无需配置。
-e 用于解决多环境配置中心隔离问题。
采用如下命令来启动 Seata Server:
NOTE: 如果你修改了 endpoint 且注册中心使用默认 file 类型,那么记得需要在各个示例工程中的 file.conf 文件中,修改 grouplist 的值(当 registry.conf 中 registry.type 或 config.type 为 file 时会读取内部的 file 节点中的文件名,若 type 不为 file 将直接从配置类型的对应元数据的注册配置中心读取数据),推荐大家使用 nacos 作为配置注册中心。
Seata Dashboard
- Seata 1.5.1 支持 Seata 控制台本地访问控制台地址:http://127.0.0.1:7091。
- 通过 Seata 控制台可以观察到正在执行的事务信息和全局锁信息,并且在事务完成时删除相关信息。
启动示例 Example
创建 Nacos 配置
NOTE: 执行此配置的时候,确保本地 Nacos server 启动成功!
创建示例中 Nacos data-id: seata.properties , Group: SEATA_GROUP(seata 1.5.1 默认分组) ,导入 Nacos 配置。
在 seata.properties 中增加示例中需要的如下事务群组配置。
配置业务数据环境
-
将 account-server、order-service、storage-service 这三个应用中的 resources 目录下的 application.yml 文件中的如下配置修改成你运行环境中的实际配置。
-
创建示例应用中所需要的数据库表。
可根据 spring-cloud-alibaba-examples/seata-example 下的 all.sql
快速操作:
- 根据选择的事务模式,创建 事务日志表。比如默认为AT模式,需要使用到 undo_log 表,则进入 at/db 下选择对应的数据库脚本执行。
- 创建 seata-server db模式所需要的 状态记录表 ,包括 global_table 、branch_table 、lock_table 、distributed_lock。
- 创建 spring-cloud-alibaba-examples/seata-example 示例中所需的数据库表。
启动 Example 示例
- 创建 Spring Boot 项目并引入依赖。
示例可以参考 Seata-Example。
-
启动 Seata Server。
NOTE: Spring Boot 和下载 server 两种方式(如果在准备 Seata-Server 准备中已经启动 Seata-Server,则可以跳过此步骤):
- 运行 spring-cloud-alibaba-examples/seata-example 下的 seata-server, 启动 Seata server。
- 根据 Seata 社区官方提供的 seata-server.jar 启动 Seata Server。
-
在本地启动 spring-cloud-alibaba-examples/seata-example 文件夹下的子服务 account-service , order-service , storage-service ,最后启动全局事务控制服务 business-service。
-
启动示例后,通过 HTTP 的 GET 方法访问如下 URL,可以分别验证在 business-service 中 通过 RestTemplate 和 FeignClient 调用其他服务的场景:
http://127.0.0.1:18081/seata/feign
http://127.0.0.1:18081/seata/rest
分布式事务功能验证
Xid 信息是否成功传递
在 account-server、order-service 和 storage-service 三个 服务的 Controller 中,第一个执行的逻辑都是输出 RootContext 中的 Xid 信息,如果看到都输出了正确的 Xid 信息,即每次都发生变化,且同一次调用中所有服务的 Xid 都一致。则表明 Seata 的 Xid 的传递和还原是正常的。
数据库中数据是否一致
在本示例中,我们模拟了一个用户购买货物的场景,StorageService 负责扣减库存数量,OrderService 负责保存订单,AccountService 负责扣减用户账户余额。
为了演示样例,我们在 OrderService 和 AccountService 中 使用 Random.nextBoolean() 的方式来随机抛出异常,模拟了在服务调用时随机发生异常的场景。
如果分布式事务生效的话, 那么以下等式应该成立:
-
用户原始金额(1000) = 用户现存的金额 + 货物单价 (2) _ 订单数量 _ 每单的货物数量(2)
-
货物的初始数量(100) = 货物的现存数量 + 订单数量 * 每单的货物数量(2)
对 Spring Cloud 支持点
-
通过 Spring MVC 提供服务的服务提供者,在收到 header 中含有 Seata 信息的 HTTP 请求时,可以自动还原 Seata 上下文。
-
支持服务调用者通过 RestTemplate 调用时,自动传递 Seata 上下文。
-
支持服务调用者通过 FeignClient 调用时,自动传递 Seata 上下文。
-
支持 SeataClient 和 Hystrix 同时使用的场景。
-
支持 SeataClient 和 Sentinel 同时使用的场景。