SAGA 模式 Spring Boot 开发

操作场景

该任务指导您在 Saga 模式下进行 Spring Boot 开发。 手动启动 Saga 事务，需要用户自行编写 Execute和 Compensate 接口的实现，并保证这两个方法的幂等性。

准备工作

• 参考 准备工作 文档，完成环境配置和开发前准备。

• 参考 快速部署 文档，执行 FMT 初始化脚本.

引入 DTF SDK

通过以下方式引入 Spring Cloud 版本的 DTF SDK。

<dependency>
    <groupId>com.tencent.cloud</groupId>
    <artifactId>dtf-core</artifactId>
    <version>{dtf.version}</version>
</dependency>

?version 填写 Release Note 中最新版本的即可。

客户端配置

在客户端中，支持以下配置自定义：

dtf:
  env:
    groups:
      {事务分组ID 1}: [{独占集群列表}]
      {事务分组ID 2}: [{独占集群列表}]
    secretId: {SecretID}
    secretKey: {SecretKey}
    server: {客户端服务标识}

?通常情况下，仅需要在 dtf.env.groups 下配置一个事务分组。

启用分布式事务服务

在 @SpringBootApplication 注解处增加 @EnableDtf 注解来启用分布式事务服务。

@SpringBootApplication
@EnableDtf
@EnableTransactionManagement
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

?建议同时启用本地事务管理：@EnableTransactionManagement。

开启主事务

通过以下注解开启主事务。 主事务通常在入口 Controller 处开启。一般建议标记在实现类上。注解所在的方法所在的类需要注入为 Bean。

主事务注解方法正常返回时提交主事务，在抛出异常时进行回滚。

@DtfTransactional
@RequestMapping("/order")
public Boolean order(@RequestBody Order order) {
    // 业务逻辑
}

主事务注解支持的能力包括

开启 Saga 分支事务

通过以下注解开启分支事务。

?

• 分支事务通常标记在 Service 上。可以标记在接口或实现类上。
• 分支事务最好被 Spring 的 @Transactional 注解管理。

@DtfSaga
public boolean order(Long txId, Long branchId, Order order);

分支事务注解支持的参数包括：

Compensate 操作

一个分支事务中，需要包含 Execute 和 Compensate 两个部分。可以使用 步骤5 中的默认值简化配置。

• 分支事务的 Execute 和 Compensate 方法所在的类需要被注入为 Bean。

• 分支事务的 Execute 和 Compensate 方法最好被 Spring 的 @Transactional 注解管理

• 分支事务的 Execute 和 Compensate 方法的参数保持一致。

• 分支事务的 Execute 和 Compensate 方法的前两个参数固定为 Long txId 和 Long branchId。

Execute 方法：

• 本地调用 Execute 方法时 txId 和 branchId 参数传 null，其他参数正常传递。

• 返回值为业务逻辑需要的返回值。

Compensate 方法：

• 返回值固定为 Boolean 类型。

• 仅在返回 true 时视为分支事务 Compensate 成功。

• 返回 false 或抛出异常时，视为分支事务 Compensate 失败。

public interface IOrderService {

    @DtfSaga
    boolean order(Long txId, Long branchId, Order order);

    boolean compensateOrder(Long txId, Long branchId, Order order);

}

远程请求

方式一：使用 RestTemplate + Spring MVC 切点

使用 RestTemplate 访问下游服务（也使用了 DTF SDK）的 Controller。DTF SDK 框架托管了全局事务传递的处理。

使用以下方式进行常规注入即可。

@Bean
public RestTemplate restTemplate() {
    return new RestTemplate();
}

方式二：使用 Feign

需要引入 openfeign 依赖：

<dependency>;
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>;

然后按照正常方式使用 Feign 即可：

@FeignClient("spring-cloud-payment")
public interface PaymentProxy {
    @RequestMapping("/pay")
    public Boolean pay(@RequestBody Payment payment);
}

方式三：自行处理

• 上游处理： 需要从上下文中提取 txId、groupId、lastBranchId 三个内容传递到下游。

   txId: DtfContextHolder.get().getTxId();
   groupId: DtfContextHolder.get().getGroupId();
   lastBranchId: DtfContextHolder.get().getBranchIdStack().peek();

  ?建议放到下列 Header 的 key 中，下游可以通过 DTF SDK 自行注入。

   ClientConstant.HTTP_HEADER.TX_ID: txId
   ClientConstant.HTTP_HEADER.GROUP_ID: groupId
   ClientConstant.HTTP_HEADER.LAST_BRANCH_ID: lastBranchId

• 下游处理： 下游可以使用以下方法将从上游传递的三个变量绑定到本地，重新开启全局事务。

   DtfContextHolder.set(new DtfContext(txId, lastBranchId, groupId));

与 TSF 结合使用

引入依赖后（注意 SDK 版本），直接正常使用 TSF 即可。

使用方式

目前支持 Greenwich（G）和 Finchley（F）版本的 TSF SDK。您可以单击以下页签，查看对应的使用方式。

<!-- TSF 启动器 -->
<dependency>
    <groupId>com.tencent.tsf</groupId>
    <artifactId>spring-cloud-tsf-starter</artifactId>
    <version>1.23.0-Greenwich-RELEASE</version>
</dependency>

!需要再排除 DTF 中的一些依赖。

<!-- TSF 启动器 -->
<dependency>
    <groupId>com.tencent.tsf</groupId>
    <artifactId>spring-cloud-tsf-starter</artifactId>
    <version>1.23.5-Finchley-RELEASE</version>
</dependency>
<!-- Spring Boot DTF -->
<dependency>
        <groupId>com.tencent.cloud</groupId>
        <artifactId>spring-boot-dtf</artifactId>
        <version>${dtf.version}</version>
        <exclusions>
                <exclusion>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-context</artifactId>
                </exclusion>
                <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter</artifactId>
                </exclusion>
                <exclusion>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-aspects</artifactId>
                </exclusion>
                <exclusion>
                        <groupId>org.springframework</groupId>
                        <artifactId>spring-boot-starter-web</artifactId>
                </exclusion>
                <exclusion>
                        <groupId>io.github.openfeign</groupId>
                        <artifactId>feign-core</artifactId>
                </exclusion>
        </exclusions>
</dependency>

启用 TSF

@SpringBootApplication
@EnableDtf
@EnableTsf
@EnableTransactionManagement
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}