分布式事务

1. 两阶段提交-XA

1.1 引入Maven依赖

<dependency>
    <groupId>org.apache.shardingsphere</groupId>
    <artifactId>sharding-transaction-xa-core</artifactId>
    <version>${shardingsphere.version}</version>
</dependency>

XA事务管理器将以SPI的方式被Sharding-JDBC所加载。

1.2 Atomikos参数配置 (可选)

ShardingSphere默认的XA事务管理器为Atomikos，在项目的logs目录中会生成xa_tx.log, 这是XA崩溃恢复时所需的日志，请勿删除。

也可以通过在项目的classpath中添加jta.properties来定制化Atomikos配置项。具体的配置规则请参考Atomikos的官方文档。

2. 第三方BASE实现-Saga

目前Apache/incubator-shardingsphere暂无BASE事务的实现，但是仍然可以使用第三方实现的Saga事务。

项目地址: shardingsphere-spi-impl

文中涉及${shardingsphere-spi-impl.version} 的jar暂未发布到maven中央仓，因此需要您根据源码自行部署。

2.1 引入Maven依赖

<dependency>
    <groupId>io.shardingsphere</groupId>
    <artifactId>sharding-transaction-base-saga</artifactId>
    <version>${shardingsphere-spi-impl.version}</version>
</dependency>

Saga事务管理器将以SPI的方式被Sharding-JDBC所加载。

2.2 Saga相关配置

可以通过在项目的classpath中添加saga.properties来定制化Saga事务的配置项。 配置项的属性及说明如下：

2.3 Saga 快照及日志持久化

当saga.persistence.enabled设置为true时，Saga引擎将会对事务的快照及执行日志进行持久化操作。 持久化操作默认通过HikariCP链接池写入到MySQL、H2或PostgreSQL数据库中。 关于持久化的配置，同样添加在saga.properties中，配置项及说明如下：

由于用户使用的数据库类型与事务大小不一定一致，因此可以在项目的classpath中添加schema-init.sql来定制化持久化的表结构，Saga引擎会自动根据其中SQL创建。 如下以MySQL为例，用户可自行修改，以匹配不同数据库类型及字段长度。

-- MySQL init table SQL

CREATE TABLE IF NOT EXISTS saga_snapshot(
  id BIGINT AUTO_INCREMENT PRIMARY KEY,
  transaction_id VARCHAR(255) null,
  snapshot_id int null,
  revert_context VARCHAR(255) null,
  transaction_context VARCHAR(255) null,
  create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  INDEX transaction_snapshot_index(transaction_id, snapshot_id)
)ENGINE=InnoDB DEFAULT CHARSET=utf8;

CREATE TABLE IF NOT EXISTS saga_event(
  id BIGINT AUTO_INCREMENT PRIMARY KEY,
  saga_id VARCHAR(255) null,
  type VARCHAR(255) null,
  content_json TEXT null,
  create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  INDEX saga_id_index(saga_id)
)ENGINE=InnoDB DEFAULT CHARSET=utf8

2.4 Saga 快照及日志持久化SPI定制

默认通过数据库来持久化快照和日志并不一定能够满足用户对业务和性能的需求。因此Saga引擎提供SPI允许用户定制化持久化部分。 当saga.persistence.enabled设置为true且Saga引擎监测到有持久化SPI时，Saga引擎将通过用户实现的SPI代替默认持久化进行持久化工作。 用户只需要实现接口io.shardingsphere.transaction.saga.persistence.SagaPersistence即可实现持久化SPI。 具体可参考项目sharding-transaction-base-saga-persistence-jpa，Maven引入：

<dependency>
    <groupId>io.shardingsphere</groupId>
    <artifactId>sharding-transaction-base-saga-persistence-jpa</artifactId>
    <version>${shardingsphere-spi-impl.version}</version>
</dependency>

2.5 Saga 注意事项

• 反向SQL需要主键，请确保在表结构中定义主键。
• 对于INSERT语句， 需要在SQL中显示插入主键值，如INSERT INTO ${table_name} (id, value, ...) VALUES (11111, '', ....) (其中id为表主键)。
• 若需要自动生成主键，可使用ShardingSphere的分布式主键（分布式主键不能为联合主键）。

3. 分布式事务接入端

ShardingSphere的事务类型存放在TransactionTypeHolder的本地线程变量中，因此在数据库连接创建前修改此值，可以达到自由切换事务类型的效果。

注意：数据库连接创建之后，事务类型将无法更改。

3.1 原生API

TransactionTypeHolder.set(TransactionType.LOCAL);

或

 TransactionTypeHolder.set(TransactionType.XA);

或

TransactionTypeHolder.set(TransactionType.BASE);

3.2 Spring注解

@ShardingTransactionType(TransactionType.LOCAL)
@Transactional

或

@ShardingTransactionType(TransactionType.XA)
@Transactional

或

@ShardingTransactionType(TransactionType.BASE)
@Transactional

注意：@ShardingTransactionType需要同Spring的@Transactional配套使用，事务才会生效。

Spring boot starter

引入Maven依赖：

<dependency>
    <groupId>io.shardingsphere</groupId>
    <artifactId>sharding-transaction-jdbc-spring-boot-starter</artifactId>
    <version>${shardingsphere-spi-impl.version}</version>
</dependency>

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>${aspectjweaver.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context-support</artifactId>
    <version>${springframework.version}</version>
</dependency>

<aspectjweaver.version>1.8.9</aspectjweaver.version>
<springframework.version>[4.3.6.RELEASE,5.0.0.M1)</springframework.version>

Spring namespace

引入Maven依赖：

<dependency>
    <groupId>io.shardingsphere</groupId>
    <artifactId>sharding-transaction-jdbc-spring</artifactId>
    <version>${shardingsphere-spi-impl.version}</version>
</dependency>

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>${aspectjweaver.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context-support</artifactId>
    <version>${springframework.version}</version>
</dependency>

<aspectjweaver.version>1.8.9</aspectjweaver.version>
<springframework.version>[4.3.6.RELEASE,5.0.0.M1)</springframework.version>

加载切面配置信息

<import resource="classpath:META-INF/shardingTransaction.xml"/>

分布式事务example

transaction-example