Apache Storm 开发者指南：从代码贡献到构建测试全流程解析

Apache Storm 开发者指南：从代码贡献到构建测试全流程解析

storm Apache Storm 项目地址: https://gitcode.com/gh_mirrors/storm22/storm

前言

Apache Storm 作为分布式实时计算系统的标杆项目，其开源社区一直保持着活跃的开发者生态。本文将系统性地介绍 Storm 项目的开发流程、最佳实践和工具链，帮助开发者快速融入社区并做出高质量贡献。

开发流程详解

1. 问题报告与功能请求

Bug 报告规范：

• 在 JIRA 系统中创建类型为 "Bug" 的 issue
• 必须包含三要素：
  1. 重现步骤（包括 Storm 版本等环境信息）
  2. 预期行为
  3. 实际错误行为

新功能建议：

• 创建类型为 "New feature" 的 issue
• 建议先在邮件列表讨论设计思路
• 大型功能需先提交设计方案文档

2. 代码贡献规范

代码风格要求：

• Clojure 代码需遵循官方风格指南
• 函数必须包含清晰的文档字符串
• 优先使用 pull request 方式提交

贡献流程建议：

1. 小型修改：直接提交 PR
2. 大型功能：
   • 先在 JIRA 创建 issue
   • 提交详细设计方案
   • 与 Committer 讨论确认
   • 分阶段实现并提交 PR

3. 测试规范

测试类型区分：

// Java 单元测试
public class NormalTest {...}

// Java 集成测试
@Category(IntegrationTest.class)
public class IntegrationTest {...}

;; Clojure 单元测试路径
test/clj/org.apache.storm.core_test.clj

;; Clojure 集成测试路径
test/clj/integration.org.apache.storm.core_test.clj

测试执行命令：

• 仅单元测试：mvn test
• 仅集成测试：mvn -P integration-tests-only verify
• 全部测试：mvn -P all-tests verify

构建与打包

环境准备

必备工具：

• Python 3.x（需安装 mock 库）
• Ruby 2.7+（推荐使用 rvm）
• NodeJS 16+（推荐使用 nvm）

环境配置示例：

# Ruby 环境
curl -L https://get.rvm.io | bash -s stable --autolibs=enabled
source ~/.profile
rvm use 2.7 --install

# NodeJS 环境
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
source ~/.bashrc
nvm install 16

完整构建流程

1. Thrift 代码生成（修改协议时必需）：

cd storm-client/src
sh genthrift.sh

2. 项目构建：

mvn clean install
# 跳过测试
mvn clean install -DskipTests

3. 二进制打包：

cd storm-dist/binary
mvn package

许可证管理

依赖许可证检查：

mvn license:aggregate-add-third-party@generate-and-check-licenses \
  -Dlicense.skipAggregateAddThirdParty=false

LICENSE 文件验证：

# 检查 LICENSE-binary 一致性
./dev-tools/validate-license-files.py

开发者工具链

1. 代码仓库：基于 Git 的分布式开发
2. 问题追踪：JIRA 系统管理 issue
3. CI 系统：自动化测试验证

结语

参与 Apache Storm 开发不仅是代码贡献，更是一个学习分布式系统设计的绝佳机会。建议新开发者从标记为 "newbie" 的 issue 入手，逐步深入系统核心模块。记住，清晰的文档和测试用例与代码本身同等重要。

希望本指南能帮助您顺利融入 Storm 社区，期待看到您的精彩贡献！

storm Apache Storm 项目地址: https://gitcode.com/gh_mirrors/storm22/storm