Relevant source files

The following files were used as context for generating this wiki page: - [extensions/rpc/seata-grpc/pom.xml](https://github.com/apache/incubator-seata/blob/2.x/extensions/rpc/seata-grpc/pom.xml) - [LICENSE](https://github.com/apache/incubator-seata/blob/2.x/LICENSE) - [.travis.yml](https://github.com/apache/incubator-seata/blob/2.x/.travis.yml) - [codecov.yml](https://github.com/apache/incubator-seata/blob/2.x/codecov.yml) - [mvnw](https://github.com/apache/incubator-seata/blob/2.x/mvnw)

# 扩展与插件本页概述 **Seata** 项目中“扩展与插件”机制的组织结构、构建方式以及持续集成流程。 Seata 通过 **Maven 多模块** 的方式提供可插拔的 RPC 实现（如 gRPC）、事务管理模块（TM）以及其他可选组件。每个扩展都以独立的 Maven 子模块形式存在，遵循统一的父 POM（`seata-rpc`），并通过 **Maven Wrapper** 与 **Travis CI** 完成自动化构建、测试与代码覆盖率上报。 --- ## 目录 - [模块化结构](#模块化结构) - [gRPC 扩展实现](#grpc-扩展实现) - [构建与发布流程](#构建与发布流程) - [持续集成 (CI) 流程](#持续集成-ci-流程) - [许可证与合规性](#许可证与合规性) - [常见问题](#常见问题) --- ## 模块化结构 Seata 的扩展采用 **Maven 多模块** 组织，根目录下的 `extensions` 目录保存所有可选插件。每个插件都有自己的 `pom.xml`，并通过父 POM (`seata-rpc`) 统一管理版本、依赖管理以及插件配置。 ### 关键模块 | 模块路径 | 作用 | 关键依赖 | |----------|------|----------| | `extensions/rpc/seata-grpc` | 为 Seata 提供基于 gRPC 的 RPC 通信实现 | `seata-tm`、`grpc-netty`、`grpc-protobuf`、`grpc-stub`、`grpc-core`（均为 `provided`） | | `extensions/...`（其他） | 预留给其他 RPC、存储、日志等插件 | 视具体实现而定 | > **来源**：`extensions/rpc/seata-grpc/pom.xml` 中的 `seata-grpc` 与 `` 列表 (Sources: [pom.xml:9-45](https://github.com/apache/incubator-seata/blob/2.x/extensions/rpc/seata-grpc/pom.xml)) ### Maven 依赖层级图 ```mermaid graph TB subgraph SeataRootGroup [#40;Root#41;] direction TB Core[Core#40;seata-rpc#41;] GrpcMod[GrpcMod#40;seata-grpc#41;] end subgraph GrpcModDeps [#40;Grpc#41;] direction TB TM[TM#40;seata-tm#41;] Netty[Netty#40;grpc-netty#41;] Protobuf[Proto#40;grpc-protobuf#41;] Stub[Stub#40;grpc-stub#41;] CoreGrpc[CoreGrpc#40;grpc-core#41;] end Core --> GrpcMod GrpcMod --> TM GrpcMod --> Netty GrpcMod --> Protobuf GrpcMod --> Stub GrpcMod --> CoreGrpc ``` *说明*：`GrpcMod`（即 `seata-grpc`）在父模块 `seata-rpc` 的基础上，引入事务管理模块 `seata-tm` 与 gRPC 运行时依赖。所有 gRPC 相关依赖均标记为 `provided`，意味着在运行时由外部容器提供（如 Spring Boot 的自动配置）。 --- ## gRPC 扩展实现 ### 目标 - 为 Seata 提供高性能、跨语言的 RPC 通道。 - 与事务管理模块（TM）解耦，使得业务方可以自由选择底层通信实现。 ### 关键配置 | 配置项 | 说明 | |--------|------| | `artifactId` | `seata-grpc` | | `description` | “gRPC integration for Seata built with Maven” | | `protobuf-maven-plugin` | 用于在 **test** 阶段生成 gRPC 代码（`protoc` 与 `protoc-gen-grpc-java`） | | `scope: provided` | 依赖在编译时可用，运行时由容器提供，避免冲突 | > **来源**：`pom.xml` 中的 `` 配置 (Sources: [pom.xml:46-78](https://github.com/apache/incubator-seata/blob/2.x/extensions/rpc/seata-grpc/pom.xml)) ### 代码生成流程（Mermaid） ```mermaid graph TB subgraph ProtoGen [#40;Proto Generation#41;] direction TB Protoc[Protoc#40;3.25.4#41;] GrpcPlugin[GrpcPlugin#40;protoc-gen-grpc-java#41;] Src[ProtoSrc#40;*.proto#41;] Out[Generated#40;java code#41;] end Src --> Protoc Protoc --> GrpcPlugin GrpcPlugin --> Out ``` *说明*：在 `test-compile` 与 `test-compile-custom` 阶段，`protobuf-maven-plugin` 调用 `protoc`（版本 3.25.4）和 `protoc-gen-grpc-java`（版本 1.55.1）生成 Java 代码，供单元测试使用。 --- ## 构建与发布流程 Seata 使用 **Maven Wrapper (`mvnw`)** 统一构建环境，确保所有贡献者使用相同的 Maven 版本（3.1.1）。`mvnw` 脚本负责： 1. 检测并设置 `JAVA_HOME`（包括对 Cygwin、Mingw、Darwin 的特殊处理）。 2. 自动下载 `maven-wrapper.jar`（若本地不存在）。 3. 通过 `MAVEN_PROJECTBASEDIR` 启动 Maven。 > **来源**：`mvnw` 脚本的前半段（JAVA_HOME 检测与 wrapper 下载） (Sources: [mvnw:1-120](https://github.com/apache/incubator-seata/blob/2.x/mvnw)) ### 构建流程图 ```mermaid graph TB subgraph BuildPipeline [#40;Maven Wrapper#41;] direction TB DetectJDK[Detect#40;JAVA_HOME#41;] DownloadWrapper[Download#40;wrapper.jar#41;] ExecMaven[Execute#40;mvn clean install#41;] end DetectJDK --> DownloadWrapper DownloadWrapper --> ExecMaven ``` *说明*：若本地已存在 `maven-wrapper.jar`，步骤 2 会被跳过，直接进入 Maven 执行。 --- ## 持续集成 (CI) 流程 Seata 使用 **Travis CI** 进行多 JDK（8、17、21）矩阵测试，并在成功后通过 **codecov** 上报覆盖率。 ### 关键 CI 配置 | 配置项 | 说明 | |--------|------| | `language: java` | 使用 Java 环境 | | `jdk` | `openjdk8`、`openjdk17`、`openjdk21` | | `cache` | 缓存本地 Maven 仓库 (`$HOME/.m2`) | | `script` | 调用 `./mvnw clean test`，在 `develop` 分支且非 PR 时额外使用 `-P image` | | `after_success` | 通过 `bash <(curl -s https://codecov.io/bash)` 上传覆盖率报告 | | `codecov.yml` | 设定覆盖率阈值、忽略路径等（见 `codecov.yml`） | > **来源**：`.travis.yml` 中的完整 CI 配置 (Sources: [travis.yml:1-45](https://github.com/apache/incubator-seata/blob/2.x/.travis.yml)) ### CI 流程图 ```mermaid graph TB subgraph CI [#40;Travis CI#41;] direction TB Checkout[Checkout#40;code#41;] SetupJDK[Setup#40;JDK#41;] CacheM2[Cache#40;.m2#41;] SetImage[Set#40;IMAGE_NAME#41;] BuildTest[Run#40;.#47;mvnw test#41;] UploadCov[Upload#40;codecov#41;] end Checkout --> SetupJDK SetupJDK --> CacheM2 CacheM2 --> SetImage SetImage --> BuildTest BuildTest --> UploadCov ``` *说明*：`SetImage` 步骤根据不同 JDK 选择对应的 Eclipse Temurin 镜像，用于后续容器化测试（`-P image`）。 ### Codecov 配置概览 ```mermaid graph TB subgraph CodecovConfig [#40;codecov.yml#41;] direction TB RequireCI[require_ci_to_pass: true] Branch[branch: 2.x] Threshold[threshold: 1%] Ignore[ignore patterns] end ``` *说明*：仅在 CI 成功且覆盖率下降不超过 1% 时才会阻塞 PR（`codecov.yml` 中的 `threshold: 1%`）。 > **来源**：`codecov.yml`（Sources: [codecov.yml:1-30](https://github.com/apache/incubator-seata/blob/2.x/codecov.yml)) --- ## 许可证与合规性 Seata 项目采用 **Apache License 2.0**，所有源码文件均在文件头声明许可证信息。CI 脚本、Maven Wrapper、以及插件的 `pom.xml` 均包含相同的许可证声明，确保分发时的合规性。 | 文件 | 许可证声明位置 | |------|----------------| | `pom.xml`、`.travis.yml`、`codecov.yml`、`mvnw` | 文件头部注释（`Licensed to the Apache Software Foundation (ASF)...`） | | `LICENSE` | 完整许可证文本 | > **来源**：`LICENSE` 文件全文 (Sources: [LICENSE](https://github.com/apache/incubator-seata/blob/2.x/LICENSE)) --- ## 常见问题 | 问题 | 解答 | |------|------| | 如何在本地编译 `seata-grpc` 插件？ | 使用 `./mvnw clean install -DskipTests=false`，确保已安装 JDK 8/17/21 中任意一个。 | | 为什么 `grpc-netty` 标记为 `provided`？ | 运行时由容器（如 Spring Boot）提供统一的 Netty 实现，避免版本冲突。 | | CI 失败时如何定位问题？ | 查看 Travis 构建日志的 `script` 阶段输出；若是覆盖率问题，参考 `codecov.yml` 中的阈值设置。 | | 如何自定义 Maven Wrapper 下载地址？ | 设置环境变量 `MVNW_REPOURL`，`mvnw` 脚本会使用该地址下载 `maven-wrapper.jar`。 | --- ## 结论 Seata 的 **扩展与插件** 体系通过 **Maven 多模块**、**Maven Wrapper** 与 **Travis CI** 实现了高度可插拔、统一构建与持续集成的能力。gRPC 插件是其中的典型案例，展示了如何在保持核心事务管理模块独立的前提下，引入外部通信实现。所有源码均遵循 **Apache License 2.0**，确保在开源社区的合法使用与再分发。