Saga 用户指南

准备环境

编译

获取源码：

  1. $ git clone https://github.com/apache/servicecomb-saga.git
  2. $ cd servicecomb-saga

Saga可通过以下任一方式进行构建：

  • 只构建可执行文件：
  1.  $ mvn clean install -DskipTests
  • 同时构建可执行文件和docker镜像：
  1.  $ mvn clean install -DskipTests -Pdocker
  • 同时构建可执行文件以及Saga发行包
  1.     $ mvn clean install -DskipTests -Prelease

在执行以上任一指令后，可在alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar中找到alpha server的可执行文件。

如何使用

引入Saga的依赖

  1.     <dependency>
  2.       <groupId>org.apache.servicecomb.saga</groupId>
  3.       <artifactId>omega-spring-starter</artifactId>
  4.       <version>${saga.version}</version>
  5.     </dependency>
  6.     <dependency>
  7.       <groupId>org.apache.servicecomb.saga</groupId>
  8.       <artifactId>omega-transport-resttemplate</artifactId>
  9.       <version>${saga.version}</version>
  10.     </dependency>

注意: 请将${saga.version}更改为实际的版本号。

添加Saga的注解及相应的补偿方法

以一个转账应用为例：

  • 在应用入口添加 @EnableOmega 的注解来初始化omega的配置并与alpha建立连接。
  1. @SpringBootApplication
  2. @EnableOmega
  3. public class Application {
  4.   public static void main(String[] args) {
  5.     SpringApplication.run(Application.class, args);
  6.   }
  7. }
  • 在全局事务的起点添加 @SagaStart 的注解。
  1. @SagaStart(timeout=10)
  2. public boolean transferMoney(String from, String to, int amount) {
  3.   transferOut(from, amount);
  4.   transferIn(to, amount);
  5. }

注意: 默认情况下，超时设置需要显式声明才生效。

  • 在子事务处添加 @Compensable 的注解并指明其对应的补偿方法。
  1. @Compensable(timeout=5, compensationMethod="cancel")
  2. public boolean transferOut(String from, int amount) {
  3.   repo.reduceBalanceByUsername(from, amount);
  4. }
  6. public boolean cancel(String from, int amount) {
  7.   repo.addBalanceByUsername(from, amount);
  8. }

注意: 实现的服务和补偿必须满足幂等的条件。

注意: 默认情况下，超时设置需要显式声明才生效。

注意: 若全局事务起点与子事务起点重合，需同时声明 @SagaStart 和 @Compensable 的注解。

  • 对转入服务重复第三步即可。

  • 从Saga-0.3.0, 你可以在服务函数或者取消函数中通过访问 OmegaContext 来获取 gloableTxId 以及 localTxId 信息。

如何运行

  • 运行postgreSQL,
  1. docker run -d -e "POSTGRES_DB=saga" -e "POSTGRES_USER=saga" -e "POSTGRES_PASSWORD=password" -p 5432:5432 postgres

如果你想使用MySQL做为后台数据库，可以参考 此文档。

  • 运行alpha。在运行alpha前，请确保postgreSQL已正常启动。可通过docker或可执行文件的方式来启动alpha。

    • 通过docker运行：
  1.  docker run -d -p 8080:8080 -p 8090:8090 -e "JAVA_OPTS=-Dspring.profiles.active=prd -Dspring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" alpha-server:${saga_version}
  • 通过可执行文件运行：
  1.  java -Dspring.profiles.active=prd -D"spring.datasource.url=jdbc:postgresql://${host_address}:5432/saga?useSSL=false" -jar alpha-server-${saga_version}-exec.jar

注意: 请在执行命令前将${saga_version}和${host_address}更改为实际值。

注意: 默认情况下，8080端口用于处理omega处发起的gRPC的请求，而8090端口用于处理查询存储在alpha处的事件信息。

  • 配置omega。在 application.yaml 添加下面的配置项：
  1. spring:
  2.   application:
  3.     name: {application.name}
  4. alpha:
  5.   cluster:
  6.     address: {alpha.cluster.addresses}

然后就可以运行相关的微服务了，可通过访问http://${alpha-server:port}/events 来获取所有的saga事件信息。