Apache ServiceComb Pack 技术文档

1. 安装指南

1.1 环境准备

在安装 Apache ServiceComb Pack 之前，请确保您的环境满足以下要求：

• Java 8 或更高版本
• Maven 3.5 或更高版本
• Docker（可选，用于容器化部署）

1.2 下载软件包

您可以通过以下方式获取 Apache ServiceComb Pack 的最新版本：

• 发行版本：访问 下载软件包 页面下载最新发行版本。
• 预览版本：如果您需要最新的预览版本，可以将以下仓库描述信息添加到您的 pom.xml 文件中：

  <repositories>
    <repository>
      <releases />
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
      <id>repo.apache.snapshot</id>
      <url>https://repository.apache.org/content/repositories/snapshots/</url>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <releases />
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
      <id>repo.apache.snapshot</id>
      <url>https://repository.apache.org/content/repositories/snapshots/</url>
    </pluginRepository>
  </pluginRepositories>
  

1.3 编译代码

您可以通过以下命令编译代码并运行单元测试：

$ mvn clean install

如果您希望编译示例代码并生成 Docker 镜像，可以使用以下命令：

$ mvn clean install -Pdemo

如果您不希望运行测试，可以使用以下命令：

$ mvn clean install -DskipTests=true -Pdemo

1.4 构建发布包

如果您需要构建软件发布包，可以使用以下命令：

$ mvn clean install -DskipTests=true -Prelease

发布包将生成在 distribution/target 目录下。

2. 项目的使用说明

2.1 快速入门

Apache ServiceComb Pack 提供了多种示例项目，帮助您快速上手：

• Saga 在 ServiceComb Java Chassis 的应用：参考 出行预订 示例。
• Saga 在 Spring 应用的用法：参考 出行预订示例。
• Saga 在 Dubbo 应用的用法：参考 Dubbo 示例。
• TCC 在 Spring 应用的用法：参考 TCC 示例。

2.2 调试示例

您可以参考 调试 Spring 示例 来了解如何调试示例项目。

3. 项目API使用文档

3.1 关键特性

Apache ServiceComb Pack 提供了以下关键特性：

• 高可用：支持高可用的集群模式部署。
• 高可靠：所有关键事务事件都持久化存储在数据库中。
• 高性能：事务事件通过高性能 gRPC 上报，请求和响应消息通过 Kyro 进行序列化和反序列化。
• 低侵入：仅需 2-3 个注解和编写对应的补偿方法即可引入分布式事务。
• 部署简单：支持通过容器（Docker）进行快速部署和交付。
• 补偿机制灵活：支持前向恢复（重试）及后向恢复（补偿）功能。
• 扩展简单：基于 Pack 架构很容易实现多种协调协议，目前支持 TCC、Saga 协议，未来还可以添加其他协议支持。

3.2 架构说明

ServiceComb Pack 架构由 alpha 和 omega 组成：

• alpha：充当协调者的角色，主要负责对事务进行管理和协调。
• omega：是微服务中内嵌的一个 agent，负责对调用请求进行拦截并向 alpha 上报事务事件。

3.3 多种语言的 Omega 实现

社区提供了多种语言的 Omega 实现：

• Go 语言版本：参见 Go 语言版本 Omega。
• C# 语言版本：参见 C# 语言版本 Omega。

4. 项目安装方式

4.1 通过 Maven 安装

您可以通过 Maven 将 ServiceComb Pack 添加到您的项目中。在 pom.xml 文件中添加以下依赖：

<dependency>
  <groupId>org.apache.servicecomb.pack</groupId>
  <artifactId>pack</artifactId>
  <version>最新版本号</version>
</dependency>

4.2 通过 Docker 安装

如果您希望使用 Docker 进行部署，可以参考以下步骤：

1. 构建 Docker 镜像：

   $ mvn clean install -Pdemo
   

2. 运行 Docker 容器：

   $ docker run -d -p 8080:8080 servicecomb-pack:latest
   

4.3 通过源码安装

您也可以通过源码进行安装：

1. 克隆项目：

   $ git clone https://github.com/apache/servicecomb-pack.git
   

2. 编译项目：

   $ mvn clean install
   

通过以上步骤，您可以成功安装并使用 Apache ServiceComb Pack。