Seata 1.4.1とNacosを用いた分散トランザクション環境の構築手順

Seata Serverのセットアップと設定

まず、seata-server-1.4.1.zipをダウンロードし、Linux環境(CentOS 7など)で展開します。展開後、seata/confディレクトリへ移動して設定ファイルを編集します。

1. file.confの編集(DBモードへの切り替え)

seata/conf/file.confを開き、セッションストレージのモードをdbに変更します。これにより、トランザクションセッション情報がデータベースに永続化されます。

mode = "db"

2. データベース接続の設定

同じfile.conf内で、データベース接続情報を設定します。事前にMySQL(バージョン5または8)にSeata用のデータベースを作成しておく必要があります。以下のドライバ設定と接続情報を環境に合わせて更新してください。

store {
  ## db storage property
  mode = "db"
  
  db {
    datasource = "druid"
    dbType = "mysql"
    driverClassName = "com.mysql.jdbc.Driver"
    url = "jdbc:mysql://127.0.0.1:3306/seata_config?useUnicode=true&rewriteBatchedStatements=true"
    user = "root"
    password = "your_password"
    minConn = 5
    maxConn = 30
    globalTable = "global_table"
    branchTable = "branch_table"
    lockTable = "lock_table"
    queryLimit = 100
    maxWait = 5000
  }
}

3. registry.confの編集(Nacosの登録)

seata/conf/registry.confを編集し、登録センターと設定センターをNacosに指定します。serverAddrにはNacosのアドレスを、namespaceには使用する名前空間IDを設定してください。

registry {
  type = "nacos"
  
  nacos {
    application = "seata-server"
    serverAddr = "127.0.0.1:8848"
    group = "SEATA_GROUP"
    namespace = "your_namespace_id"
    cluster = "default"
    username = "nacos"
    password = "nacos"
  }
}

config {
  type = "nacos"
  
  nacos {
    serverAddr = "127.0.0.1:8848"
    group = "SEATA_GROUP"
    namespace = "your_namespace_id"
    username = "nacos"
    password = "nacos"
  }
}

Nacosへの設定反映

Seataの設定をNacosのConfiguration Managementに取り込むため、スクリプトと設定ファイルを用意します。

4. 設定反映スクリプトの作成

以下の内容をseata/conf/nacos-config-import.shとして保存します。このスクリプトは、設定ファイルを読み込んでNacosのAPIを通じて登録を行います。

#!/bin/bash

# デフォルト値の設定
NACOS_HOST=${1:-localhost}
NACOS_PORT=${2:-8848}
GROUP_ID=${3:-SEATA_GROUP}
TENANT_ID=${4:-""}
AUTH_USER=${5:-""}
AUTH_PASS=${6:-""}

# 設定ファイルのパス(confディレクトリの1つ上)
CONFIG_PATH="$(dirname "$PWD")/config.txt"

if [ ! -f "$CONFIG_PATH" ]; then
  echo "Error: Configuration file not found at $CONFIG_PATH"
  exit 1
fi

NACOS_URL="http://${NACOS_HOST}:${NACOS_PORT}/nacos/v1/cs/configs"
CONTENT_TYPE="Content-Type: application/json;charset=UTF-8"

SUCCESS_COUNT=0
FAIL_COUNT=0

# 設定のプッシュ関数
import_config() {
  local key=$1
  local val=$2
  
  # curlで設定を送信
  response=$(curl -s -X POST "$NACOS_URL" \
    -H "$CONTENT_TYPE" \
    -d "dataId=$key" \
    -d "group=$GROUP_ID" \
    -d "content=$val" \
    -d "tenant=$TENANT_ID" \
    -d "username=$AUTH_USER" \
    -d "password=$AUTH_PASS")

  if [ "$response" = "true" ]; then
    echo "[OK] Uploaded: $key"
    ((SUCCESS_COUNT++))
  else
    echo "[ERR] Failed to upload: $key"
    ((FAIL_COUNT++))
  fi
}

# config.txtの読み込みと処理
while IFS='=' read -r raw_key raw_val; do
  # 空行とコメント行をスキップ
  if [[ -z "$raw_key" || "$raw_key" =~ ^[[:space:]]*# ]]; then
    continue
  fi
  
  # キーとバリューの前後の空白をトリム
  key=$(echo "$raw_key" | xargs)
  value=$(echo "$raw_val" | xargs)
  
  import_config "$key" "$value"
  
done < "$CONFIG_PATH"

echo "======================================================================"
echo "Import Complete. Total Success: $SUCCESS_COUNT, Total Failure: $FAIL_COUNT"
echo "======================================================================"

5. Seata設定ファイルの準備

以下の内容をseata/config.txtconfではなくseataディレクトリ直下)に保存します。データベース接続情報部分は、手順2で設定した内容と一致させるように変更してください。

transport.type=TCP
transport.server=NIO
transport.heartbeat=true
transport.enableClientBatchSendRequest=true
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
service.vgroupMapping.my_test_tx_group=default
service.default.grouplist=127.0.0.1:8091
service.enableDegrade=false
service.disableGlobalTransaction=false
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=false
client.rm.sqlParserType=druid
client.rm.reportSuccessEnable=false
client.rm.sagaBranchRegisterEnable=false
client.tm.commitRetryCount=5
client.tm.rollbackRetryCount=5
client.tm.defaultGlobalTransactionTimeout=60000
client.tm.degradeCheck=false
client.tm.degradeCheckAllowTimes=10
client.tm.degradeCheckPeriod=2000
store.mode=db
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_config?useUnicode=true
store.db.user=root
store.db.password=your_password
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
store.redis.host=127.0.0.1
store.redis.port=6379
store.redis.maxConn=10
store.redis.minConn=1
store.redis.database=0
store.redis.password=null
store.redis.queryLimit=100
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
client.undo.dataValidation=true
client.undo.logSerialization=jackson
client.undo.onlyCareUpdateColumns=true
server.undo.logSaveDays=7
server.undo.logDeletePeriod=86400000
client.undo.logTable=undo_log
log.exceptionRate=100
transport.serialization=seata
transport.compressor=none
metrics.enabled=false
metrics.registryType=compact
metrics.exporterList=prometheus
metrics.exporterPrometheusPort=9898

6. 設定のインポート実行

seata/confディレクトリで作成したスクリプトを実行します。引数にNacosのアドレスや認証情報を渡します。

$ chmod +x nacos-config-import.sh
$ sh nacos-config-import.sh -h localhost -p 8848 -g SEATA_GROUP -t your_namespace_id

実行後、Nacosコンソールの構成管理リストにSeata関連の設定が表示されていればインポート成功です。

データベーステーブルの初期化

7. Seata Server用テーブルの作成

Seataサーバーがトランザクション状態を管理するためのテーブルを、手順2で作成したデータベース内に作成します。

-- グローバルセッション用テーブル
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 = utf8mb4;

-- ブランチセッション用テーブル
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),
    `lock_key`          VARCHAR(128),
    `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;

-- ロック情報用テーブル
CREATE TABLE IF NOT EXISTS `lock_table`
(
    `row_key`        VARCHAR(128) NOT NULL,
    `xid`            VARCHAR(96),
    `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 = utf8mb4;

8. ビジネスデータベース用 undo_log テーブルの作成

各マイクロサービスの業務データベース(MySQL 5/8など)に対し、ATモードで利用するundo_logテーブルを作成します。

-- ATモード用Undoログテーブル
CREATE TABLE IF NOT EXISTS `undo_log`
(
    `id`            BIGINT(20)   NOT NULL AUTO_INCREMENT COMMENT 'increment id',
    `branch_id`     BIGINT(20)   NOT NULL COMMENT 'branch transaction id',
    `xid`           VARCHAR(100) NOT NULL COMMENT 'global transaction id',
    `context`       VARCHAR(128) NOT NULL COMMENT 'undo_log context,such as serialization',
    `rollback_info` LONGBLOB     NOT NULL COMMENT 'rollback info',
    `log_status`    INT(11)      NOT NULL COMMENT '0:normal status,1:defense status',
    `log_created`   DATETIME(6)  NOT NULL COMMENT 'create datetime',
    `log_modified`  DATETIME(6)  NOT NULL COMMENT 'modify datetime',
    `ext`           VARCHAR(100) DEFAULT NULL COMMENT 'extra info',
    PRIMARY KEY (`id`),
    UNIQUE KEY `ux_undo_log` (`xid`, `branch_id`)
) ENGINE = InnoDB
  AUTO_INCREMENT = 1
  DEFAULT CHARSET = utf8mb4 COMMENT ='AT transaction mode undo table';

Seata Serverの起動

9. ログディレクトリの作成と起動

ログ出力用のディレクトリとファイルを作成し、Seataサーバーをバックグラウンドで起動します。

$ cd seata
$ mkdir -p logs
$ cd bin
$ nohup ./seata-server.sh -p 8091 -h 127.0.0.1 &

起動後、Nacosコンソールのサービスリストにseata-serverが登録されていることを確認してください。

アプリケーション側の設定

最後に、Seataを利用するSpring Bootアプリケーションの設定を行います。

10. Maven依存関係

pom.xmlにSpring Cloud AlibabaとSeataの依存関係を追加します。

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2.2.5.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-seata</artifactId>
    </dependency>
</dependencies>

11. application.ymlの設定

アプリケーション設定ファイルにSeataとレジストリの情報を記述します。トランザクショングループ名(tx-service-group)と、Nacosの設定が正しく連携されているか確認してください。

seata:
  enabled: true
  enable-auto-data-source-proxy: true
  tx-service-group: my_test_tx_group
  registry:
    type: nacos
    nacos:
      application: seata-server
      server-addr: 127.0.0.1:8848
      group: SEATA_GROUP
      namespace: "your_namespace_id"
      username: "nacos"
      password: "nacos"
  config:
    type: nacos
    nacos:
      server-addr: 127.0.0.1:8848
      group: SEATA_GROUP
      namespace: "your_namespace_id"
      username: "nacos"
      password: "nacos"
  service:
    vgroup-mapping:
      my_test_tx_group: default
    disable-global-transaction: false
  client:
    rm:
      report-success-enable: false

タグ: Seata Nacos distributed-transaction spring-cloud-alibaba MySQL

7月22日 21:58 投稿