ARTICLE DETAIL

建站实战干货

来自一线的建站与推广经验沉淀,每一条都经过真实交付验证。

深入参与 RocketMQ Studio 开发:从分支模型、环境搭建到 PR 合入的完整贡献指南

2026/10/5 2:22:21 拓冰建站 浏览量
深入参与 RocketMQ Studio 开发:从分支模型、环境搭建到 PR 合入的完整贡献指南 后端消息队列运维【免费下载链接】rocketmq-dashboardThe state-of-the-art Dashboard of Apache RoccketMQ provides excellent monitoring capability. Various graphs and statistics of events, performance and system information of clients and application is evidently made available to the user.项目地址https://gitcode.com/gh_mirrors/ro/rocketmq-dashboard点击查看免费下载本篇技术指南以 RocketMQ StudioApache rocketmq-dashboard 仓库的rocketmq-studio分支的 CONTRIBUTING.md 为骨架系统梳理该项目面向开发者的协作规范包括双分支维护模型、JDK 21 / Maven / Node.js / Docker 开发环境与全栈启动方式、后端 ArchUnit 架构测试与前端测试体系、从 Issue 讨论到 Squash Merge 的完整贡献工作流以及后端六边形架构、Lombok、REST 层约定和 RocketMQ 客户端池化等硬性代码标准。读完本文你将掌握如何在本仓库搭建可运行、可测试的开发环境并写出符合 Apache 社区评审要求、能够被合入rocketmq-studio主干的 Pull Request。分支模型rocketmq-studio是唯一开发主干RocketMQ Studio 的开发和贡献全部发生在仓库的rocketmq-studio分支上它同时是仓库的默认分支。所有 Pull Request 必须以它为目标分支。仓库内实际存在两个分支职责截然不同分支角色rocketmq-studioRocketMQ Studio 开发主干trunk所有功能分支与 Pull Request 都基于它创建master_archive旧版 rocketmq-dashboard 代码的历史归档只读不用于任何开发注意master_archive中存放的是 legacy dashboard 代码的历史快照。从源码结构看当前项目的真实形态是一个全新的管控平台Java 21 Spring Boot 3.5 后端、React 18 Vite 前端、MySQL 持久化与旧的 Web 控制台完全不同因此提交 PR 时切莫以归档分支为基线。开发环境准备版本是硬性要求CONTRIBUTING.md 给出了明确的工具链版本表组件版本要求JDK21Dragonwell 或 Temurin 发行版均可Maven3.9Node.js 20.19.0npm仓库已提交package-lock.json依赖版本锁定Docker Docker Compose最新版用于拉起 MySQL 与本地 RocketMQ 拓扑几个版本细节值得注意JDK 21 是后端基线server/pom.xml中 Maven 容器构建镜像为maven:3.9.9-eclipse-temurin-21见 deploy/README.md本地开发与远端部署保持同一 JDK 版本可避免编译期差异。前端必须使用npm ci而非npm install因为package-lock.json已提交npm ci会按锁文件精确安装保证所有贡献者与 CI 环境依赖完全一致。package-lock.json已提交意味着依赖升级属于需要 Issue 讨论的非请求重写见后文 PR 期望不要在顺手改代码时夹带。本地运行全栈、仅后端、仅前端三种模式一键启动完整技术栈cd deploy/rocketmq docker compose up -d # RocketMQ 拓扑 网络 cd .. docker compose up -d --build # MySQL Studio 后端 前端第一条命令会启动内置 RocketMQ 拓扑并创建 Studio 服务所需的rocketmq_netDocker 网络第二条命令构建并启动 MySQL、后端与前端。启动后访问两个入口前端http://127.0.0.1:6789Nginx 服务后端http://127.0.0.1:8888Spring BootRocketMQ 服务端各端口见 README_zh.mdNameServer9876、Broker10911、Proxy Remoting8080、Proxy gRPC8081。完整的配置选项见 deploy/README.md。仅启动后端cd server mvn -B -ntp spring-boot:run # 开发模式热启动 # 或打包后运行 mvn -B -ntp package -DskipTests-Bbatch 模式与-ntp不输出传输进度是 Maven 在 CI 和终端日志场景的推荐参数。仅启动前端cd web npm ci npm run dev # Vite dev server热更新前端仓库web/为 React 18 TypeScript Vite Ant Design Tailwind CSS 技术栈npm run dev提供带热重载的开发服务器。测试体系后端测试依赖真实 MySQL后端测试cd server mvn -B -ntp test这行命令会同时运行后端单元测试与集成测试并在测试过程中自动执行 ArchUnit 六边形架构约束检查——一旦代码破坏架构规则构建直接失败。ArchUnit 依赖真实存在于 server/pom.xmlcom.tngtech.archunit:archunit-junit5这也印证了 README 中架构约束由测试强制的声明而非仅靠人工评审。前端测试、lint 与构建cd web npm test npm run lint npm run build分别对应 vitest 测试、ESLint 检查与生产构建。前端代码风格由 ESLint Prettier 统一Husky pre-commit hook 会在提交前自动检查见 README_zh.md。后端集成测试为什么需要 MySQLCONTRIBUTING.md 明确指出后端集成测试SpringBootTest会连接真实数据源因此需要一台可访问的 MySQL 8 实例地址为localhost:3306且已加载 Studio schema。最简单的方式是启动仓库自带的 MySQL 容器cd deploy docker compose up -d mysql该容器会自动加载server/src/main/resources/db/schema.sql。这份 SQL 是唯一的权威 DDL 来源MyBatis-Plus 不会自动建表其中强制了所有表的规范id bigint(20) unsigned自增主键、gmt_create/gmt_modified时间戳字段、禁止created_at/updated_at命名、禁止 VARCHAR UUID 主键。从文件头部注释schema.sql可以看出表结构与 MyBatis-Plus Entity 必须保持同步改动实体后应同步维护此 DDL。测试与文案的约定命名规则非平凡变更必须带测试测试方法命名为somethingHappensTestTest后缀。就近原则前端和后端测试放在被测代码旁边即同目录__tests__/或同包下便于评审时对照。国际化凡新增 UI 文案必须在web/src/i18n/中同时补充中英文翻译如 translations.ts。贡献工作流先讨论、再编码、后合入CONTRIBUTING.md 规定的流程分六步先搜索查阅仓库已有 Issues确认问题或想法是否已被跟踪。写代码前先开 Issue使用仓库提供的 Issue 模板之一。仓库实际配置了四种模板见 .github/ISSUE_TEMPLATE/bug_report.ymlBug 报告、feature_request.yml功能请求、enhancement_request.yml增强请求、doc.yml文档。纯拼写错误等琐碎修复无需 Issue。在 Issue 中讨论非平凡设计并等待维护者反馈Apache 项目以共识consensus决策——新功能、新 API 或大型重构应先在 Issue 达成一致再落地实现避免已完成 PR 因设计问题被拒绝。Fork、建分支、提交git clone gitgithub.com:your-username/rocketmq-dashboard.git git remote add upstream https://github.com/apache/rocketmq-dashboard.git git fetch upstream rocketmq-studio git checkout -b your-topic upstream/rocketmq-studio注意本地功能分支必须基于upstream/rocketmq-studio创建而非默认的master或归档分支。向rocketmq-studio打开 Pull Request并在描述中用Fixes #issue-id关联 Issue合入时自动关闭对应 Issue。保持分支最新当主干前移时用 rebase 同步upstream/rocketmq-studio必要时对自己的 fork 分支 force-push。合入方式Squash Merge Conventional Commits所有 PR只允许 squash merge因此合入后的提交信息格式统一为type: description (#N)其中type遵循 Conventional Commits 风格合法前缀为feat:/fix:/refactor:/chore:/docs:/perf:。这与 README_zh.md 的开发规范保持一致。这意味着 PR 标题最好直接写成符合该格式的提交信息避免合入后被改写。对 Pull Request 的评审期望CONTRIBUTING.md 明确列出合入门槛一个 PR 只包含一个内聚的变更既不要把一个修复拆成多个单行 PR也不要把无关改动捆绑在一起。必须能构建、测试通过CI 会跑后端构建、后端测试套件、前端构建和前端镜像构建编译不过的 PR 会被直接关闭。评审的是代码而非生成物允许使用 AI 辅助但贡献者必须对结果负责——阅读 diff、理解它、并用测试验证批量提交未经核实的变更会在未评审的情况下被关闭。禁止未经请求的重写大型重构、依赖升级和格式整理类改动需要先有 Issue 并获维护者同意。新源码文件必须有 License 头这是 ASF 的强制要求遵循 Apache 源码头政策。代码标准后端代码标准由评审和构建双重强制细节与理由记录在 README.md 与 docs/ 目录中。以下是后端的核心规则包根org.apache.rocketmq.studio源码位于server/src/实际完整包路径为org.apache.rocketmq.studio见 server/src/main/java/org/apache/rocketmq/studio。六边形架构domain / application / adapter 分层由 ArchUnit 测试断言随mvn test执行违反即构建失败。依赖项见 server/pom.xml。Lombok 全面使用POJO 用Data/Builder/NoArgsConstructor/AllArgsConstructor构造器注入用RequiredArgsConstructor日志用Slf4j。仓库中如 ClusterService.java、ClusterRepositoryImpl.java 等实现均遵循该模式。REST 层约定写操作接收带 Jakarta validation 的 DTO返回 VO所有响应包裹在ResultT中错误以BusinessException(400, msg)抛出见 Result.java 与 BusinessException.java。RocketMQ 客户端长生命周期 池化必须使用仓库已有的工厂与连接池MqAdminExtFactory、MqClientPool见 MqAdminExtFactory.java 与 MqClientPool.java禁止每个请求都创建、启动、关闭一个客户端——这是性能与资源泄漏的根源。查询失败分级RPC 级失败连接超时、Broker 不可达表现为错误而空业务结果如消费组不在线、路由未找到返回200加空数据而不是错误。依赖红线org.apache.rocketmq:*只能使用 Apache 开源发行版——禁止内部或厂商定制构建禁止com.aliyun.openservices:ons-client云控制面访问必须走官方 OpenAPI SDK。代码标准前端最小字号 14px。表格不得在常规宽度下出现横向滚动条列宽通过web/src/utils/table.ts中的tableScrollX(columns)按声明列宽自动累加计算scroll.x禁止写死魔术数字详见 README_zh.md。页面级中性提示使用共享组件InfoBanner见 InfoBanner.tsx。国际化新增 UI 文案必须同时提供中英文web/src/i18n/。评审、合并与 stale bot 机制维护者按到达顺序评审 PR。当需要返工时你会收到Request changes评审——在同一分支上推送修复即可继续评审流程。一个重要的自动化约束仓库运行 stale bot会在 7 天无活动后自动关闭 Issue 和 PR。实际配置见 .github/workflows/stale.ymlactions/stalev9days-before-stale: 7、days-before-close: 0即标记 stale 的当天即关闭并豁免pinned与security标签。对贡献者的实操含义若 PR 在等你响应务必在 7 天窗口内回复若 PR 在等维护者可以留言重置计时器或申请pinned标签只要分支仍存在被关闭的 PR 可以重新打开。Apache 贡献者许可协议ICLA / CCLA对于实质性贡献ASF 要求签署 Individual Contributor License Agreement (ICLA) 的 Apache License 2.0 授权一致。沟通渠道仓库 IssuesRocketMQ Studio 的 Bug、功能与设计讨论主场。devrocketmq.apache.org 邮件列表RocketMQ 项目的开发者邮件列表用于跨项目话题与版本发布讨论。RocketMQ Discussions针对 Apache RocketMQ 本身的用法问题。成为 committer项目始终欢迎新的 committer。考察标准是持续且有价值的贡献记录、评审中展现的良好判断力、以及对项目的持续兴趣。如果你希望成为 committer可以联系任意现有 committer他们会带你走完流程。附提交 PR 前的快速自检清单分支基于upstream/rocketmq-studio创建PR 目标分支也是rocketmq-studio先有 Issue、设计已获讨论共识琐碎修复除外PR 描述含Fixes #issue-idmvn -B -ntp test后端 ArchUnit 架构检查、npm test npm run lint npm run build前端全部通过一个 PR 只含一个内聚变更提交信息符合 Conventional Commits 风格新增源码带 License 头新 UI 文案已补充中英文翻译非平凡逻辑已补充somethingHappensTest命名的测试RocketMQ 客户端走MqAdminExtFactory/MqClientPool池化空业务结果返回200空数据而非错误关注 stale bot 的 7 天窗口及时响应评审意见或留言重置计时器。遵循以上流程与代码标准你的贡献就能顺畅地进入 RocketMQ Studio 主干的评审与合入通道。赞分享后端消息队列运维【免费下载链接】rocketmq-dashboardThe state-of-the-art Dashboard of Apache RoccketMQ provides excellent monitoring capability. Various graphs and statistics of events, performance and system information of clients and application is evidently made available to the user.项目地址https://gitcode.com/gh_mirrors/ro/rocketmq-dashboard点击查看免费下载相关推荐Cherry Studio 贡献指南从开发环境搭建到 PR 合入的完整协作流程Cherry Studio 贡献指南从开发环境搭建到 PR 合入的完整协作流程 Cherry Studio CherryHQ/cherry studio人工智能大模型AI 应用交互助手本地部署Devbox 贡献指南从开发环境搭建到 PR 合入的完整工作流Devbox 贡献指南从开发环境搭建到 PR 合入的完整工作流 本文以 Devbox 仓库的 CONTRIBUTING.md https://link.git开发工具CLIAutoClip 贡献指南从开发环境搭建到 PR 合入的完整协作规范AutoClip 贡献指南从开发环境搭建到 PR 合入的完整协作规范 AutoClip 是一个基于 AI 的智能视频切片系统支持 YouTube / B 站人工智能AI 应用大模型音视频短视频后端前端桌面应用上一篇Spring AI 连 vLLM 报 400分块传输编码排障实录下一篇QtScrcpy 完整教程投屏控制手机1 秒出帧、键鼠全接管创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考