# ServiceComb-Saga

**Repository Path**: eecos/ServiceComb-Saga

## Basic Information

- **Project Name**: ServiceComb-Saga
- **Description**: Apache ServiceComb (incubating) Saga 是一个微服务应用的数据最终一致性解决方案。相对于TCC而言，在try阶段，Saga会直接提交事务，后续rollback阶段则通过反向的补偿操作来完成。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 21
- **Created**: 2018-11-23
- **Last Updated**: 2022-06-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Saga | [English](README.md) [![Build Status](https://travis-ci.org/apache/servicecomb-saga.svg?branch=master)](https://travis-ci.org/apache/servicecomb-saga?branch=master) [![Coverage Status](https://coveralls.io/repos/github/apache/servicecomb-saga/badge.svg?branch=master)](https://coveralls.io/github/apache/servicecomb-saga?branch=master) [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Gitter](https://img.shields.io/badge/ServiceComb-Gitter-ff69b4.svg)](https://gitter.im/ServiceCombUsers/Saga)
Apache ServiceComb Saga 是一个微服务应用的数据最终一致性解决方案。

## 特性
* 高可用。支持集群模式。
* 高可靠。所有的事务事件都持久存储在数据库中。
* 高性能。事务事件是通过gRPC来上报的，且事务的请求信息是通过Kyro进行序列化和反序列化的。
* 低侵入。仅需2-3个注解和编写对应的补偿方法即可进行分布式事务。
* 部署简单。可通过Docker快速部署。
* 支持前向恢复（重试）及后向恢复（补偿）。
* 扩展简单。基于Pack架构很容实现多种协调机制。

## 架构
Saga Pack 架构是由 **alpha** 和 **omega**组成，其中：
* alpha充当协调者的角色，主要负责对事务进行管理和协调。
* omega是微服务中内嵌的一个agent，负责对网络请求进行拦截并向alpha上报事务事件。

下图展示了alpha, omega以及微服务三者的关系：
![Saga Pack 架构](docs/static_files/pack.png)
在此架构基础中我们除了实现saga协调协议以外，我们还可以很容易实现TCC协调协议。
详情可浏览[Saga Pack 设计文档](docs/design_zh.md).

同时社区也提供了多种语言的Omega实现:
* Go语言版本Omega 可参见 https://github.com/jeremyxu2010/matrix-saga-go
* C#语言版本Omega 可参见 https://github.com/OpenSagas-csharp/servicecomb-saga-csharp


## 快速入门
* Saga在ServiceComb Java Chassis应用可以参考[出行预订](saga-demo/saga-servicecomb-demo/README.md)
* Saga在Spring应用的用法可参考[出行预订示例](saga-demo/saga-spring-demo/README.md)。
* Saga在Dubbo应用的用法可参考[Dubbo示例](saga-demo/saga-dubbo-demo/README.md).
* TCC在Spring应用的用法可以参考[TCC示例](saga-demo/tcc-spring-demo/README.md)
* 示例的的调试方法可以参考[调试Spring示例](saga-demo/saga-spring-demo#debugging).


## 编译和运行代码
* 编译代码并且运行相关的单元测试
   ```bash
      $ mvn clean install
   ```
* 编译示例，并生产docker镜像，运行验收测试
   ```bash
      $ mvn clean install -Pdemo,docker
   ```
* 编译示例，并生产docker镜像, 不运行测试
   ```bash
      $ mvn clean install -DskipTests=true -Pdemo,docker
   ```       
* 当前Saga模块同时支持Spring Boot 1.x 以及 Spring Boot 2.x, 在缺省情况下Saga会使用Spring Boot 1.x来进行构建。
你可以使用 *-Pspring-boot-2* 将Spring Boot版本转换到 2.x 上。 由于Spring Boot 只在2.x开始支持 JDK9，如果你想用
JDK9或者JDK10 来编译Saga并运行测试的话，你需要使用 spring-boot-2 profile参数。
   ```bash
      $ mvn clean install -Pdemo,docker,spring-boot-2
   ```


## 用户指南
如何构建和使用可浏览[用户指南](docs/user_guide_zh.md)。

## 获取最新发行版本

[下载Saga](http://servicecomb.apache.org/release/saga-downloads/)

## [常见问题](FAQ_ZH.md)

## 联系我们
* [提交issues](https://issues.apache.org/jira/browse/SCB)
* [gitter聊天室](https://gitter.im/ServiceCombUsers/Saga)
* 邮件列表: [订阅](mailto:dev-subscribe@servicecomb.apache.org) [浏览](https://lists.apache.org/list.html?dev@servicecomb.apache.org)

## 贡献
详情可浏览[代码提交指南](http://servicecomb.apache.org/cn/developers/submit-codes/)。

## License
[Apache 2.0 license](https://github.com/apache/servicecomb-saga/blob/master/LICENSE)。