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

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

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

前言

作为分布式实时计算系统的代表，Apache Storm 的开发工作需要遵循特定的流程和规范。本文将全面介绍 Storm 项目的开发工作流程，包括代码贡献、问题报告、构建测试等关键环节，帮助开发者快速融入 Storm 社区。

开发工作流程详解

1. 问题报告与功能请求

1.1 报告 Bug

当发现 Storm 系统存在问题时，开发者应当：

1. 提供清晰的复现步骤，包括使用的 Storm 版本信息
2. 描述预期行为与实际错误行为的差异
3. 检查问题是否已被报告，避免重复提交

最佳实践：对于复杂问题，建议同时提供修复补丁或直接提交 Pull Request。

1.2 新功能请求

对于新功能需求：

1. 明确描述功能需求和预期效果
2. 说明该功能的潜在应用场景
3. 可先在社区邮件列表讨论获取反馈

2. 代码贡献规范

2.1 准备工作

在贡献代码前，建议：

1. 阅读 Storm 实现文档，理解系统架构
2. 从标记为"newbie"或"trivial"的简单问题入手
3. 遵循 Clojure 代码风格指南，特别注意函数文档注释

2.2 代码贡献流程

对于不同规模的代码变更：

• 小型修改：直接提交 Pull Request
• 大型功能：
  1. 创建对应 issue 并说明实现方案
  2. 与社区维护者讨论设计思路
  3. 获得认可后开始实现

3. 测试规范

Storm 采用分层测试策略：

3.1 测试类型

| 测试类型 | 语言 | 标识方式 | 执行阶段 | |---------|------|----------|----------| | 单元测试 | Java | 无特殊标记 | test | | 集成测试 | Java | @IntegrationTest 注解 | integration-test/verify | | 单元测试 | Clojure | 常规测试目录 | test | | 集成测试 | Clojure | integration.* 包路径 | test |

3.2 测试执行命令

# 仅运行单元测试
mvn test

# 仅运行集成测试
mvn -P integration-tests-only,examples,externals verify

# 运行所有测试
mvn -P all-tests,examples,externals verify

调试技巧：使用 -Dtest=<test_name> 参数可选择性运行特定测试。

4. 文档贡献

文档贡献与代码贡献流程类似：

1. 版本相关文档位于项目 docs/ 目录
2. 通用文档需提交到专门文档仓库
3. 同样需要通过 Pull Request 提交

构建与打包指南

1. 环境准备

构建 Storm 需要：

• Python 3.x（2.7 不支持）
• Ruby（推荐 2.7+）
• Node.js（推荐 16+）
• Mock 测试库（pip3 install mock）

2. 完整构建流程

# 生成 Thrift 代码（修改 storm.thrift 后必须执行）
cd storm-client/src
sh genthrift.sh

# 完整构建（跳过测试可加 -DskipTests）
mvn clean install

# 跳过示例和外部模块
mvn clean install -P '!examples,!externals'

3. 创建发布包

# 先完成基础构建
mvn clean install

# 生成二进制发布包
cd storm-dist/binary && mvn package

许可证管理

Storm 采用严格的许可证管理：

1. 生成依赖许可证列表：

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

2. 验证许可证文件：

   python dev-tools/validate-license-files.py
   

3. 手动更新 LICENSE/NOTICE 文件时需注意区分源码和二进制发布版本。

结语

参与 Apache Storm 开发需要遵循项目特定的流程规范，但社区对各类贡献都持开放态度。无论是代码修复、功能实现还是文档改进，只要按照本文介绍的流程操作，都能有效提高贡献被接纳的效率。建议新贡献者从简单问题入手，逐步熟悉项目代码结构和开发流程。

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