分布式事务框架 Seata 服务端快速配置指南

Seata Logo

Seata 是一款开源的分布式事务解决方案，致力于在微服务架构下提供高性能和简单易用的分布式事务服务。

下载

Seata Server v2.0.0
解压缩，约定之后将解压目录称为为：seata_home

目录结构

.
# 可执行文件
└── bin
│   └── seata-server.sh # Seata 启动脚本
│   └── startup.sh
│   └── seata-setup.sh
│   └── seata-server.bat
└── target
│   └── seata-server.jar # Seata 服务程序
└── script
│   └── server
│   │   └── db
│   │   │   └── mysql.sql # Seata 服务 DB 模式建表脚本
│   └── config-center
│   │   └── nacos # Seata 服务使用 Nacos 配置中心时，上传配置脚本（也可以手动拷贝配置）
│   │   │   └── nacos-config-interactive.sh
│   │   │   └── nacos-config.py
│   │   │   └── nacos-config.sh
│   │   │   └── nacos-config-interactive.py
│   │   └── config.txt # Seata 服务配置（可手动将此内容拷贝到 Nacos）
│   │   └── README.md
└── lib
└── conf
│   └── logback-spring.xml
│   └── application.example.yml # Seata 服务程序配置文件（模板）
│   └── application.yml # Seata 服务程序配置文件
│   └── application.raft.example.yml

配置

Seata 服务端是基于 SpringBoot，故其配置主要是修改 seata_home/conf/application.yml 文件，默认为：

server:
  port: 7091

spring:
  application:
    name: seata-server

logging:
  config: classpath:logback-spring.xml
  file:
    path: ${log.home:${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
      
# Seata Web 控制台默认用户名密码
console:
  user:
    username: seata
    password: seata
seata:
  # Seata 配置加载方式，支持：nacos, consul, apollo, zk, etcd3
  config:
    type: file
  # Seata 服务注册方式，支持：nacos, eureka, redis, zk, consul, etcd3, sofa
  registry:
    type: file
  # Seata 服务存储方式，支持：file 、 db 、 redis 、 raft
  store:
    mode: file
  
  security:
    secretKey: SeataSecretKey0c382ef121d778043159209298fd40bf3850a017
    tokenValidityInMilliseconds: 1800000
    ignore:
      urls: /,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*.jpeg,/**/*.ico,/api/v1/auth/login,/metadata/v1/**

对其配置一般关注三点：配置方式、服务注册方式、存储方式。下面示例演示将 Seata 的配置放入 Nacos 并同时将服务也注册到 Nacos，然后使用 db 存储模式。

本指南依赖 Nacos 服务、MySQL 数据库，请自行安装配置。它们的具体信息如下：

Nacos 2.2.3
- localhost:8848
- 无需用户名密码认证
MySQL 5.1.x
- localhost:3306
- 用户名、密码：root root

seata.config 配置方式（Nacos）

Nacos 配置设置

新建名称为 seata 的命名空间，产生唯一命名空间 ID

上传 Seata 配置文件到 Nacos

上传有两种方式，脚本方式和手动创建方式，脚本方式将把每一条配置生成一个 Data Id，具体参考 seata_home/script/config-center/README.md 说明，本例采用手动方式，并将所有配置放入一个 Data Id 之中。

seata-nacos-config

在配置管理中点击创建配置，并设置 seata-server、SEATA_GROUP 的 Data ID 和 Group, 同时选择 Properties 配置格式，并将 seata_home/script/config-center/config.txt 配置内容中保留 Seata 服务端的配置属性，然后拷贝到 配置内容，然后点击发布：

seata-nacos-config

下面是筛选后的 Seata 服务端配置：

#配置项详情查看： https://seata.io/zh-cn/docs/user/configurations.html
     
# === Seata 服务端、客户端公用属性 ===
transport.type=TCP
transport.server=NIO
transport.heartbeat=true
transport.enableTmClientBatchSendRequest=false
transport.enableRmClientBatchSendRequest=true
transport.enableTcServerBatchSendResponse=false
transport.rpcRmRequestTimeout=30000
transport.rpcTmRequestTimeout=30000
transport.rpcTcRequestTimeout=30000
transport.threadFactory.bossThreadPrefix=NettyBoss
transport.threadFactory.workerThreadPrefix=NettyServerNIOWorker
transport.threadFactory.serverExecutorThreadPrefix=NettyServerBizHandler
transport.threadFactory.shareBossWorker=false
transport.threadFactory.clientSelectorThreadPrefix=NettyClientSelector
transport.threadFactory.clientSelectorThreadSize=1
transport.threadFactory.clientWorkerThreadPrefix=NettyClientWorkerThread
transport.threadFactory.bossThreadSize=1
transport.threadFactory.workerThreadSize=default
transport.shutdown.wait=3
transport.serialization=seata
transport.compressor=none
log.exceptionRate=100
     
# === Seata 服务端配置 ===
# 事务存储配置
store.mode=db
store.lock.mode=db
store.session.mode=db
#store.publicKey=
store.db.datasource=druid
store.db.dbType=mysql
store.db.driverClassName=com.mysql.jdbc.Driver
store.db.url=jdbc:mysql://127.0.0.1:3306/seata?rewriteBatchedStatements=true&useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
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.distributedLockTable=distributed_lock
store.db.queryLimit=100
store.db.lockTable=lock_table
store.db.maxWait=5000
     
server.undo.logSaveDays=7
server.undo.logDeletePeriod=86400000
server.recovery.committingRetryPeriod=1000
server.recovery.asynCommittingRetryPeriod=1000
server.recovery.rollbackingRetryPeriod=1000
server.recovery.timeoutRetryPeriod=1000
server.maxCommitRetryTimeout=-1
server.maxRollbackRetryTimeout=-1
server.rollbackRetryTimeoutUnlockEnable=false
server.distributedLockExpireTime=10000
server.session.branchAsyncQueueSize=5000
server.session.enableBranchAsyncRemove=false
server.enableParallelRequestHandle=true
server.enableParallelHandleBranch=false
     
# Metrics 配置
metrics.enabled=false
metrics.registryType=compact
metrics.exporterList=prometheus
metrics.exporterPrometheusPort=9898

虽然 Seata 客户端 配置不在本文涵盖范围，但也给出配置：

#配置项详情查看： https://seata.io/zh-cn/docs/user/configurations.html
     
# === Seata 服务端、客户端公用属性 ===
transport.type=TCP
transport.server=NIO
transport.heartbeat=true
transport.enableTmClientBatchSendRequest=false
transport.enableRmClientBatchSendRequest=true
transport.enableTcServerBatchSendResponse=false
transport.rpcRmRequestTimeout=30000
transport.rpcTmRequestTimeout=30000
transport.rpcTcRequestTimeout=30000
transport.threadFactory.bossThreadPrefix=NettyBoss
transport.threadFactory.workerThreadPrefix=NettyServerNIOWorker
transport.threadFactory.serverExecutorThreadPrefix=NettyServerBizHandler
transport.threadFactory.shareBossWorker=false
transport.threadFactory.clientSelectorThreadPrefix=NettyClientSelector
transport.threadFactory.clientSelectorThreadSize=1
transport.threadFactory.clientWorkerThreadPrefix=NettyClientWorkerThread
transport.threadFactory.bossThreadSize=1
transport.threadFactory.workerThreadSize=default
transport.shutdown.wait=3
transport.serialization=seata
transport.compressor=none
log.exceptionRate=100
     
# === Seata 客户端属性 ===
service.vgroupMapping.default_tx_group=default
service.default.grouplist=127.0.0.1:8091
service.enableDegrade=false
service.disableGlobalTransaction=false
client.metadataMaxAgeMs=30000
client.rm.asyncCommitBufferLimit=10000
client.rm.lock.retryInterval=10
client.rm.lock.retryTimes=30
client.rm.lock.retryPolicyBranchRollbackOnConflict=true
client.rm.reportRetryCount=5
client.rm.tableMetaCheckEnable=true
client.rm.tableMetaCheckerInterval=60000
client.rm.sqlParserType=druid
client.rm.reportSuccessEnable=false
client.rm.sagaBranchRegisterEnable=false
client.rm.sagaJsonParser=fastjson
client.rm.tccActionInterceptorOrder=-2147482648
client.rm.sqlParserType=druid
client.tm.commitRetryCount=5
client.tm.rollbackRetryCount=5
client.tm.defaultGlobalTransactionTimeout=60000
client.tm.degradeCheck=false
client.tm.degradeCheckAllowTimes=10
client.tm.degradeCheckPeriod=2000
client.tm.interceptorOrder=-2147482648
client.undo.dataValidation=true
client.undo.logSerialization=jackson
client.undo.onlyCareUpdateColumns=true
client.undo.logTable=undo_log
client.undo.compress.enable=true
client.undo.compress.type=zip
client.undo.compress.threshold=64k
tcc.fence.logTableName=tcc_fence_log
tcc.fence.cleanPeriod=1h
tcc.contextJsonParserType=jackson
tcc.fence.logTableName=tcc_fence_log
tcc.fence.cleanPeriod=1h
tcc.contextJsonParserType=jackson

当 Seata 服务端、客户端配置完成后，如下图所示：

seata-nacos-config

Seata 配置

修改 seata_home/conf/application.yml 中 seata.config 下的内容为：

seata:
  config:
    type: nacos
    nacos:
      # Nacos 服务地址 
      server-addr: 127.0.0.1:8848
      # Nacos 命名空间
      namespace: 8b4a9073-dc11-4302-aa02-6c02fc6d81fe
      # 分组
      group: SEATA_GROUP
      # 数据ID，服务端为 seata-server，即加载服务端配置  
      data-id: seata-server
      username:
      password:
      context-path:

seata.registry 注册方式（Nacos）

此处是设置 Seata 服务端启动后，要被注册到的注册中心，可用 , 逗号分隔配置多个注册中心，本例仅将 Seata 服务端注册到 Nacos，修改 seata_home/conf/application.yml 中 seata.registry 下的内容为：

seata:
  registry:
    type: nacos
    nacos:
      # Seata 服务注册到 Nacos 时服务名称
      application: seata-server
      # Nacos 服务地址
      server-addr: 127.0.0.1:8848
      # 注册分组，本例使用默认分组
      group: DEFAULT_GROUP
      # 不填，默认使用 public 命名空间
      namespace:
      # 集群名称，使用默认
      cluster: default
      username:
      password:
      context-path:

seata.store 存储方式（DB，MySQL）

先在 MySQL 数据库创建名为 seata 的数据库，之后打开 seata_home/server/db/mysql.sql 文件，并在数据库中执行：

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

修改 seata_home/conf/application.yml 中有 seata.store 下的内容为：

seata:
  store:
    mode: db
    session:
      mode: db
    lock:
      mode: db
    db:
      datasource: druid
      # 数据库类型
      db-type: mysql
      # 数据库驱动
      driver-class-name: com.mysql.jdbc.Driver
      # 数据库连接地址
      url: jdbc:mysql://127.0.0.1:3306/seata?rewriteBatchedStatements=true&useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
      user: root
      password: root
      min-conn: 10
      max-conn: 100
      global-table: global_table
      branch-table: branch_table
      lock-table: lock_table
      distributed-lock-table: distributed_lock
      query-limit: 1000
      max-wait: 5000

注意：当前面 seata.config 的配置中心有关服务端配置中已经设置了 store.* 开头属性时，本配置文件中的设置其实会被覆盖。

启动

终端切换到 seata_home/bin 目录，执行如下命令：

# 执行如下命令
sh seata-server.sh -p 8091 -h 127.0.0.1 -m db

浏览器输入地址：http://localhost:7091，输入用户名 seata 密码 seata 即可进入 Web 控制台：

seata-web-console

書陋堂 Slowtown

分布式事务框架 Seata 服务端快速配置指南

下载

目录结构

配置

seata.config 配置方式（Nacos）

seata.registry 注册方式（Nacos）

seata.store 存储方式（DB，MySQL）

启动

推荐阅读

Search

Table of Contents