Seata部署配置使用

Seata部署配置使用

官方文档地址：https://seata.io/zh-cn/docs/overview/what-is-seata.html

部署

说明

Seata分TC、TM和RM三个角色，TC（Server端）为单独服务端部署，TM和RM（Client端）由业务系统集成。

client

• 存放client端sql脚本 (包含 undo_log表) ，参数配置

config-center

• 各个配置中心参数导入脚本，config.txt(包含server和client，原名nacos-config.txt)为通用参数文件

server

• server端数据库脚本 (包含 lock_table、branch_table 与 global_table) 及各个容器配置

下载解压压缩包，定位到conf目录下registry.conf文件，包含Seata的注册和配置

Seata的注册和配置支持File，Nacos，Eureka，Redis，Zookeeper，Consul，Etcd3，Sofa

registry.conf

nacos配置registry

registry {
  # file 、nacos 、eureka、redis、zk、consul、etcd3、sofa
  # type = "file"
  type = "nacos"
  nacos {
    application = "seata-server" # nacos中的服务名 serviceId
    serverAddr = "localhost"
    # namespace = "public"  # 默认public
    cluster = "default"
    # username = "nacos"
    # password = "nacos"
  }
}
config {
  # file、nacos 、apollo、zk、consul、etcd3
  type = "nacos"

  nacos {
    serverAddr = "localhost"
    namespace = "3cb52aaf-3e24-4eea-a8ce-2252beaf88fd"
    group = "SEATA_GROUP"
    # username = "nacos"
    # password = "nacos"
  }
}

nacos配置文件SEATA_GROUP分组 seaga服务端配置中心设置

Seata/script/config-center目录下的config.txt是seata的所有配置

通过Seata/script/config-center/nacos/nacos-config.sh -h localhost -p 8848 -g SEATA_GROUP -t 3cb52aaf-3e24-4eea-a8ce-2252beaf88fd  将Seata/script/config.txt 即上级目录的config同步到nacos
    win可通过git bash运行sh脚本
常用配置：
service.vgroupMapping.my_test_tx_group=default
store.mode=db  # 存储模式
store.db.datasource=druid
store.db.dbType=mysql
store.db.driverClassName=com.mysql.jdbc.Driver
# 数据库url
store.db.url=jdbc:mysql://127.0.0.1:3306/seata_server?useUnicode=true&rewriteBatchedStatements=true
# 数据库用户名密码
store.db.user=root
store.db.password=root
store.db.minConn=5
store.db.maxConn=30
store.db.globalTable=global_table
store.db.branchTable=branch_table
store.db.queryLimit=100
store.db.lockTable=lock_table
store.db.maxWait=5000

注意：

通过dataId配置
从v1.4.2版本开始，已支持从一个Nacos dataId中获取所有配置信息,你只需要额外添加一个dataId配置项。

首先你需要在nacos新建配置，此处dataId为seataServer.properties,配置内容参考https://github.com/seata/seata/tree/develop/script/config-center 的config.txt并按需修改保存

在client参考如下配置进行修改,

seata:
  config:
    type: nacos
    nacos:
      server-addr: 127.0.0.1:8848
      group : "SEATA_GROUP"
      namespace: ""
      dataId: "seataServer.properties"
      username: "nacos"
      password: "nacos"

file.conf

Server端存储模式（store.mode）现有file、db、redis三种（后续将引入raft,mongodb），file模式无需改动，直接启动即可，下面专门讲下db和redis启动步骤。
注： file模式为单机模式，全局事务会话信息内存中读写并持久化本地文件root.data，性能较高;

db模式为高可用模式，全局事务会话信息通过db共享，相应性能差些;

redis模式Seata-Server 1.3及以上版本支持,性能较高,存在事务信息丢失风险,请提前配置合适当前场景的redis持久化配置.

file.conf

store {
  ## store mode: file、db
  mode = "db"
 
  ## database store property
  db {
    ## the implement of javax.sql.DataSource, such as DruidDataSource(druid)/BasicDataSource(dbcp) etc.
    datasource = "druid"
    ## mysql/oracle/postgresql/h2/oceanbase etc.
    dbType = "mysql"
    driverClassName = "com.mysql.jdbc.Driver"
    url = "jdbc:mysql://localhost:3306/seata_server"
    user = "root"
    password = "root"
    minConn = 5
    maxConn = 30
    globalTable = "global_table"
    branchTable = "branch_table"
    lockTable = "lock_table"
    queryLimit = 100
    maxWait = 5000
  }
  ## redis store property
  redis {
    host = "192.168.1.72"
    port = "6379"
    password = "xxxxxx"
    database = "1"
    minConn = 1
    maxConn = 10
    maxTotal = 100
    queryLimit = 100
  }
}

server建表

-- -------------------------------- 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_gmt_modified_status` (`gmt_modified`, `status`),
    KEY `idx_transaction_id` (`transaction_id`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8;

-- 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 = utf8;

-- 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),
    `gmt_create`     DATETIME,
    `gmt_modified`   DATETIME,
    PRIMARY KEY (`row_key`),
    KEY `idx_branch_id` (`branch_id`)
) ENGINE = InnoDB
  DEFAULT CHARSET = utf8;

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);

在bin下启动seata 启动参数有

参数	作用
-h (–host)	指定在注册中心注册的IP
-p (–port)	程序端口号 默认8091
-m (–storeMode)	事务日志存储方式，支持file，db，redis等 默认file
-n (–serverNode)	用于指定Seata服务端节点ID，默认1
-e (–seataEnv)	指定seata服务端运行环境，dev，test等，会使用不同的配置文件

启动后在nacos服务列表看到seata 应用名seata-server

client建表

所有客户端都要建表undo_log 被调用的服务以及服务的调用方都需要用到 "undo_log"表用于事务的回滚

-- 注意此处0.3.0+ 增加唯一索引 ux_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;

client配置

入门配置

客户端项目增加pom依赖

// seata-spring-boot-starter:内置GlobalTransactionScanner自动初始化功能，若外部实现初始化，请参考SeataAutoConfiguration保证依赖加载顺序
// 默认开启数据源自动代理，可配置seata.enable-auto-data-source-proxy: false关闭
//spring-cloud-starter-alibaba-seata:2.1.0内嵌seata-all 0.7.1，2.1.1内嵌seata-all 0.9.0，2.2.0内嵌seata-spring-boot-starter 1.0.0, 2.2.1内嵌seata-spring-boot-starter 1.1.0
//2.1.0和2.1.1兼容starter解决方案:
//@SpringBootApplication注解内exclude掉spring-cloud-starter-alibaba-seata内的com.alibaba.cloud.seata.GlobalTransactionAutoConfiguration


    com.alibaba.cloud
    spring-cloud-starter-alibaba-seata
    
        
            io.seata
            seata-spring-boot-starter
        
    



    io.seata
    seata-spring-boot-starter
    1.2.0

//spring-cloud-starter-alibaba-seata推荐依赖配置方式

    com.alibaba.cloud
    spring-cloud-starter-alibaba-seata
    2.2.1.RELEASE
    
        
            io.seata
            seata-spring-boot-starter
        
    


    io.seata
    seata-spring-boot-starter
    最新版

客户端增加配置项 yml 全部配置参考Seata\script\client\spring\application.yml

seata:
  enabled: true # 开启
  application-id: order-server # application id
  tx-service-group: my_test_tx_group # 事务分组 对应config.txt的service.vgroupMapping.my_test_tx_group=default 默认AT
  enable-auto-data-source-proxy: true # 开启数据源自动代理
  config:
    type: nacos #选择 nacos
    nacos:
      namespace: 3cb52aaf-3e24-4eea-a8ce-2252beaf88fd  # namespace
      serverAddr: 127.0.0.1:8848 #nacos服务地址
      group:  SEATA_GROUP # group 分组
  registry:
    type: nacos   # 选择nacos
    nacos:
      application: seata-server  # 应用名称 和registry.conf的application对应 是nacos中的服务名
      server-addr: 127.0.0.1:8848  # nacos 服务地址
      namespace:    # namespace命名空间 默认public
server:
  port: 8081 #程序端口号
spring:
  application:
    name: order #应用名称
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848 #nacos服务注册、发现地址
      config:
        server-addr: 127.0.0.1:8848 #nacos配置中心地址
        file-extension: yml #指定配置内容的数据格式

事务注解@GlobalTransactional

在事务开始的地方加上@GlobalTransactional
//@GlobalTransactional(name = "s-create-order事务名称", rollbackFor = Exception.class
    @Transactional // Spring事务注解
    @GlobalTransactional // seata全局事务注解
    @Override
    public Integer order(Integer id) {
	    int count = insert;//新增订单
	    Integer result = orderTService.insert(orderId); // 新增商户
	    if (result <= 0) {
	        throw new RuntimeException("新增商户异常!"); // 失败抛出RuntimeException
	    }
	    return count;
    }

注意：@GlobalTransactional必须在事务开始的地方添加，即A调用B，C，则A添加@GlobalTransactional和@Transactional，B和C添加@Transactional

总结

业务系统集成Client

步骤一：添加seata依赖（建议单选）

• 依赖seata-all
• 依赖seata-spring-boot-starter，支持yml、properties配置(.conf可删除)，内部已依赖seata-all
• 依赖spring-cloud-alibaba-seata，内部集成了seata，并实现了xid传递 建议**

步骤二：undo_log建表、配置参数

步骤三：数据源代理（不支持自动和手动配置并存）

• 如果使用seata-all

0.9.0版本开始seata支持自动代理数据源
    1.1.0: seata-all取消属性配置，改由注解@EnableAutoDataSourceProxy开启，并可选择jdk proxy或者cglib proxy
    1.0.0: client.support.spring.datasource.autoproxy=true
    0.9.0: support.spring.datasource.autoproxy=true
    如果采用XA模式，@EnableAutoDataSourceProxy(dataSourceProxyMode = "XA")
手动配置可参考下方的例子
    @Primary
    @Bean("dataSource")
    public DataSource dataSource(DataSource druidDataSource) {
        //AT 代理 二选一
        return new DataSourceProxy(druidDataSource);
        //XA 代理
        return new DataSourceProxyXA(druidDataSource)
    }

• 如果使用seata-starter

使用自动代理数据源时，如果使用XA模式还需要调整配置文件
application.properties
    seata.data-source-proxy-mode=XA  
OR yml
    seata:
      data-source-proxy-mode: XA
如何关闭seata-spring-boot-starter的数据源自动代理？
application.properties
    seata.enable-auto-data-source-proxy=false  

步骤四：初始化GlobalTransactionScanner

• 手动

@Bean
public GlobalTransactionScanner globalTransactionScanner() {
   String applicationName = this.applicationContext.getEnvironment().getProperty("spring.application.name");
   String txServiceGroup = this.seataProperties.getTxServiceGroup();
   if (StringUtils.isEmpty(txServiceGroup)) {
       txServiceGroup = applicationName + "-fescar-service-group";
       this.seataProperties.setTxServiceGroup(txServiceGroup);
   }

   return new GlobalTransactionScanner(applicationName, txServiceGroup);
}

• 自动

引入seata-spring-boot-starter、spring-cloud-starter-alibaba-seata等jar

步骤五：实现xid跨服务传递

• 手动 参考源码integration文件夹下的各种rpc实现 module
• 自动 springCloud用户可以引入spring-cloud-starter-alibaba-seata，内部已经实现xid传递