Seata搭建與分散式事務入門

2021 年 4 月 21 日
筆記
分散式事務

在單體架構下，我們大多使用的是單體資料庫，通過資料庫的ACID特性支援，實現了本地事務。但是在微服務架構下複雜的業務關係中，分散式事務是不可避免的問題之一。Seata是Spring Cloud Alibaba分散式事務解決方案中間件，解決了微服務場景下面臨的分散式事務問題。本文介紹如何通過搭建Seata環境，並通過其AT模式，實現分散式事務。

本文中使用的環境版本：

nacos-server-1.3.1
seata-server-1.4.0
spring-cloud Hoxton.SR3
spring-cloud-alibaba 2.2.1.RELEASE

1、Seata服務安裝包下載

下載seata-server-1.4.0：
//github.com/seata/seata/releases/tag/v1.4.0
同時下載seata-server-0.0.9，需要其中的配置文件和腳本：
//github.com/seata/seata/releases/tag/v0.9.0

2、Seata服務配置

在conf目錄下，先把配置文件備份後再進行更改

修改file.conf，mode選擇資料庫模式，並配置資料庫連接資訊

  ## store mode: file、db、redis
  mode = "db"
  ## database store property
  db {
    ## the implement of javax.sql.DataSource, such as DruidDataSource(druid)/BasicDataSource(dbcp)/HikariDataSource(hikari) etc.
    datasource = "druid"
    ## mysql/oracle/postgresql/h2/oceanbase etc.
    dbType = "mysql"
    driverClassName = "com.mysql.jdbc.Driver"
    url = "jdbc:mysql://127.0.0.1:3306/seata"
    user = "hydra"
    password = "123456"
    minConn = 5
    maxConn = 100
    globalTable = "global_table"
    branchTable = "branch_table"
    lockTable = "lock_table"
    queryLimit = 100
    maxWait = 5000
  }

修改registry.conf，使用nacos作為註冊和配置中心。可以在nacos中創建一個命名空間，把生成的命名空間的值拷過來

  registry {
  # file 、nacos 、eureka、redis、zk、consul、etcd3、sofa
  type = "nacos"
  
    nacos {
    application = "seata-server"
    serverAddr = "127.0.0.1:8848"
    group = "SEATA_GROUP"
    namespace = "202274f4-218e-42bf-9251-e996df6340f8"
    cluster = "default"
    username = "nacos"
    password = "nacos"
  }
  
  
  config {
  # file、nacos 、apollo、zk、consul、etcd3
  type = "nacos"

  nacos {
    serverAddr = "127.0.0.1:8848"
    namespace = "202274f4-218e-42bf-9251-e996df6340f8"
    group = "SEATA_GROUP"
    username = "nacos"
    password = "nacos"
  }

3、導入Seate參數配置到nacos配置中心

首先，把seata-server-0.9的 nacos-config.txt 和nacos-config.sh腳本拷貝到1.4版本的 seata/conf下。我們需要把nacos-config.txt的參數通過腳本nacos-config.sh導入到nacos配置中心，之後微服務項目也從nacos配置中心讀取配置。這樣就不用像老版本那樣，需要把兩個配置文件拷到微服務項目的resourcce目錄下了。

修改nacos-config.txt，首先修改資料庫配置：

store.mode=db
store.db.url=jdbc:mysql://127.0.0.1:3306/seata?useUnicode=true
store.db.user=hydra
store.db.password=123456

0.9中的參數格式還是使用橫線模式，在1.4中規範有所變動，需要把橫線變成駝峰，啟動需要改動的參數有：

store.db.db-type=mysql
store.db.driver-class-name=com.mysql.jdbc.Driver

需要改成駝峰：

store.db.dbType=mysql
store.db.driverClassName=com.mysql.jdbc.Driver

並且，如果使用的是mysql8.0以上的版本，需要改一下驅動的名稱。

其他參數的具體意義可以查看官方文檔： //seata.io/zh-cn/docs/user/configurations.html，並按照上面的規則進行修改。額外需要注意參數的參數是： service.vgroup_mapping

service.vgroup_mapping.my_test_tx_group=default

官方解釋為事務群組，具體使用多少個事務群體沒有明確指出。但通過查看文檔和部分開源項目發現，大多都採用將key值設置為服務端的服務名，有多少個微服務就添加多少行。在接下來的demo中要使用兩個微服務作為示例，因此添加：

service.vgroupMapping.order-service-group=default
service.vgroupMapping.stock-service-group=default

使用gitbash運行nacos-config.sh腳本，參數是nacos的ip：

sh nacos-config.sh 127.0.0.1

這樣執行完成後參數默認是存在nacos config的public命名空間下，可以在nacos創建一個seata的命名空間，把所有參數拷貝過去，方便進行區分。

4、建表

在seata資料庫中新建表branch_table, global_table, lock_table，在業務資料庫中新建表undo_log，用於回滾，這些腳本在seata-server-0.9中也可以直接找到。

-- the table to store GlobalSession data
drop table if exists `global_table`;
create table `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_gmt_modified_status` (`gmt_modified`, `status`),
  key `idx_transaction_id` (`transaction_id`)
);
 
-- the table to store BranchSession data
drop table if exists `branch_table`;
create table `branch_table` (
  `branch_id` bigint not null,
  `xid` varchar(128) not null,
  `transaction_id` bigint ,
  `resource_group_id` varchar(32),
  `resource_id` varchar(256) ,
  `lock_key` varchar(128) ,
  `branch_type` varchar(8) ,
  `status` tinyint,
  `client_id` varchar(64),
  `application_data` varchar(2000),
  `gmt_create` datetime,
  `gmt_modified` datetime,
  primary key (`branch_id`),
  key `idx_xid` (`xid`)
);
 
-- the table to store lock data
drop table if exists `lock_table`;
create table `lock_table` (
  `row_key` varchar(128) not null,
  `xid` varchar(96),
  `transaction_id` long ,
  `branch_id` long,
  `resource_id` varchar(256) ,
  `table_name` varchar(32) ,
  `pk` varchar(36) ,
  `gmt_create` datetime ,
  `gmt_modified` datetime,
  primary key(`row_key`)
);
 
-- the table to store seata xid data
-- 0.7.0+ add context
-- you must to init this sql for you business databese. the seata server not need it.
-- 此腳本必須初始化在你當前的業務資料庫中，用於AT 模式XID記錄。與server端無關（註：業務資料庫）
-- 注意此處0.3.0+ 增加唯一索引 ux_undo_log
drop table `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;

5、啟動

在啟動nacos-server後，點擊 seata/bin/seata-server.bat啟動seata。

6、微服務改造

在微服務中引入seata的依賴：

<dependency>
    <groupId>io.seata</groupId>
    <artifactId>seata-spring-boot-starter</artifactId>
    <version>1.3.0</version>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-seata</artifactId>
    <exclusions>
        <exclusion>
            <groupId>io.seata</groupId>
            <artifactId>seata-spring-boot-starter</artifactId>
        </exclusion>
    </exclusions>
</dependency>

如果微服務中使用的是druid連接池，可以把已有的druid依賴刪除，在seata-spring-boot-starter-1.3.0中已經引入了druid-1.1.12。

修改每一個微服務yml，主要是配置nacos和seata，tx-service-group就是nacos-config.txt 中 service.vgroupMapping的key，我們這裡使用微服務的名稱加上group後綴

server:
  port: 8763

spring:
  application:
    name: order-service
  cloud:
    nacos:
      server-addr: 127.0.0.1:8848
  datasource:
    url: jdbc:mysql://localhost:3306/tenant?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
    username: hydra
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
      initial-size: 8
      min-idle: 1
      max-active: 10
      max-wait: 60000

seata:
  enabled: true
  application-id: ${spring.application.name}
  tx-service-group: ${spring.application.name}-group
  enable-auto-data-source-proxy: true
  config:
    type: nacos
    nacos:
      server-addr: 127.0.0.1:8848
      namespace: 202274f4-218e-42bf-9251-e996df6340f8
      group: SEATA_GROUP
      username: nacos
      password: nacos
  registry:
    type: nacos
    nacos:
      application: seata-server
      server-addr: 127.0.0.1:8848
      namespace: 202274f4-218e-42bf-9251-e996df6340f8
      group: SEATA_GROUP
      username: nacos
      password: nacos
#  service:
#    vgroupMapping:
#      order-service-group: default

mybatis-plus:
  mapper-locations: classpath:mapper/*Mapper.xml
  type-aliases-package: com.cn.nacos.consumer.entity

配置seata的資料庫代理，在使用mybatis-plus時的配置方式如下：

@Configuration
public class DataSourceProxyConfig {
    @Bean
    public SqlSessionFactory sqlSessionFactoryBean(DataSource dataSource) throws Exception {
        // 訂單服務中引入了mybatis-plus，所以要使用特殊的SqlSessionFactoryBean
        MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
        // 代理數據源
        sqlSessionFactoryBean.setDataSource(new DataSourceProxy(dataSource));
        // 生成SqlSessionFactory
        return sqlSessionFactoryBean.getObject();
    }
}

調用測試，OrderService調用StockService為例，在被調用的service方法上加上@Transactional註解

StockService提供介面：

@Service
public class StockService {
    @Autowired
    private StockMapper stockMapper;

    @Transactional
    public String reduce(){
        System.out.println("減庫存");

        Stock stock = stockMapper.selectOne(new LambdaQueryWrapper<Stock>().eq(Stock::getId, 1));
        System.out.println(stock.toString());

        stock.setQuantity(stock.getQuantity()-1);
        int result = stockMapper.updateById(stock);
        System.out.println("update result: "+result);

        if (result==1){
            throw new RuntimeException("異常測試，準備rollBack");
        }
        return "stock reduce success";
    }
}

OrderService調用StockService的服務，使用了FeignClient調用StockService，並在發起事務的方法上加上@GlobalTransactional註解：

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;

    @Autowired
    private StockClient stockClient;

    @GlobalTransactional
    public String buy(){
        Order order=new Order();
        order.setId(1L).setMoney(20D);
        int result = orderMapper.insert(order);

        if (result==1){
            System.out.println("插入訂單成功");
        }
        return stockClient.reduce();
    }
}

調用OrderService的介面，會在StockService中拋出異常，reduce方法中的本地事務先執行回滾。再查看日誌，在order表上執行了回滾操作：

在上面的日誌中，列印出了全局事務的xid、分支的branchId、以及seata使用的模式，在使用AT模式的二階段提交完成後，顯示回滾狀態為回滾完成。查看業務資料庫的und_log表，已經插入了回滾記錄：

這樣，就以Seata中默認的AT模式實現了分散式事務。在該模式下，可以應對大多數的業務場景，並且基本可以做到無業務入侵，對於程式設計師來說，只需要添加註解，不需要做其他的業務功能改造，就可以以無感知的方式就可以實現分散式事務的解決。

如果文章對您有所幫助，歡迎關注公眾號 碼農參上

Tags: 分散式事務