apache/dubbo-initializer

Apache dubbo-initializer 镜像文档

镜像概述

Apache dubbo-initializer 是 Apache Dubbo 官方提供的项目初始化工具镜像，旨在帮助开发者快速创建符合 Dubbo 分布式服务框架规范的应用项目。该镜像集成了 Dubbo 最佳实践，支持通过 Web 界面或 REST API 交互，可根据需求自定义项目参数（如语言、版本、依赖组件等），一键生成完整的项目结构、配置文件及基础代码，大幅降低分布式服务应用的初始化门槛。

核心功能与特性

• 快速项目生成：一键生成包含 Dubbo 基础依赖、标准目录结构及配置模板的完整项目，无需手动编写初始代码。
• 多版本兼容：支持主流 Dubbo 版本（如 2.7.x、3.x 等），可根据项目需求选择对应版本。
• 依赖组件自定义：支持选择注册中心（ZooKeeper、Nacos、Etcd 等）、配置中心（Nacos、Apollo 等）、协议（Dubbo、REST 等）及其他 Dubbo 生态组件。
• 标准化项目结构：生成符合 Maven/Gradle 规范的项目结构，包含主程序入口、服务接口定义、配置文件（dubbo.yml/dubbo.properties）等关键模块。
• 多交互方式：提供 Web 可视化界面（类似 Spring Initializr）和 RESTful API，支持交互式操作与自动化集成场景。
• 语言支持：当前主要支持 Java 语言，后续将扩展至 Dubbo 支持的其他语言（如 Go、Rust 等）。

使用场景

• 新项目快速启动：开发者在创建 Dubbo 分布式服务应用时，通过该工具快速生成基础项目，避免手动配置的繁琐流程。
• 学习与演示：Dubbo 初学者可通过生成的示例项目快速了解 Dubbo 项目结构及核心配置，降低学习门槛。
• 教学与培训：讲师在教学过程中，可一键生成统一的示例项目，确保学员环境一致性，提升教学效率。
• 自动化流程集成：在 CI/CD 或 DevOps 流程中，通过 REST API 调用自动生成项目模板，实现标准化项目创建。

使用方法

基本运行命令

通过 Docker 命令启动镜像，默认暴露 8080 端口：

bash
docker run -d -p 8080:8080 --name dubbo-initializer docker.xuanyuan.run/apache/dubbo-initializer:latest

访问与使用方式

1. Web 界面（推荐）

启动容器后，访问 http://localhost:8080，通过可视化界面配置项目参数：

• 填写基本信息（Group ID、Artifact ID、项目版本等）；
• 选择 Dubbo 版本、开发语言（如 Java）；
• 勾选所需依赖组件（注册中心、配置中心、协议等）；
• 点击“生成”按钮下载项目压缩包，解压后即可导入 IDE 使用。

2. REST API（自动化场景）

通过 HTTP POST 请求调用 API 生成项目，示例：

bash
# 生成 Java + Dubbo 3.2.0 + ZooKeeper 注册中心 + Nacos 配置中心的项目
curl -X POST "http://localhost:8080/starter.zip" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "groupId=com.example&artifactId=dubbo-demo&version=1.0.0&language=java&dubboVersion=3.2.0&registry=zookeeper&configCenter=nacos" \
  -o dubbo-demo.zip

停止与清理容器

bash
# 停止容器
docker stop dubbo-initializer

# 移除容器
docker rm dubbo-initializer

配置参数说明

可通过环境变量或启动参数自定义镜像行为，常用参数如下：

示例：指定默认 Dubbo 版本为 2.7.15 并修改服务端口为 9090

bash
docker run -d -p 9090:9090 \
  -e DUBBO_DEFAULT_VERSION=2.7.15 \
  -e PORT=9090 \
  --name dubbo-initializer docker.xuanyuan.run/apache/dubbo-initializer:latest

注意事项

• 镜像运行建议分配至少 1GB 内存，低配置环境可能导致启动缓慢或失败。
• 生成的项目压缩包包含完整的 Maven/Gradle 项目结构，解压后可直接导入 IDE（如 IntelliJ IDEA、Eclipse）。
• 如需自定义高级配置（如协议参数、服务暴露方式等），可在生成项目后手动修改 dubbo.yml 或 dubbo.properties 文件。