Skip to content

快速开始

本文给出一条以源码为准的本地启动路径。完整的 Learning OS V1 联调请阅读 Learning OS 本地联调

环境要求

  • JDK 21
  • Maven 3.9+
  • MySQL 8.x(按服务需要)
  • Redis 6.x+(按服务需要)
  • Nacos 2.x(使用服务发现或配置中心时)

部分模块还需要 Dubbo、RocketMQ、XXL-Job、Qdrant 或 Ollama 等外部依赖,是否启动取决于目标场景。

获取代码

bash
git clone https://github.com/CaptainJike/x-boot-cloud.git
cd x-boot-cloud

构建项目

bash
# 完整构建并运行测试
mvn clean install

# 本地快速构建
mvn clean install -DskipTests

初始化数据库

当前仓库的模块 SQL 位于各服务的资源目录,不再假设存在独立的 config/db/MySQL 目录。常用脚本包括:

bash
mysql -u root -p < x-boot-modules/sys/sys-service/src/main/resources/sql/x_boot_sys.sql
mysql -u root -p < x-boot-modules/oss/oss-service/src/main/resources/sql/x_boot_oss.sql
mysql -u root -p < x-boot-modules/ai/ai-service/src/main/resources/sql/x_boot_ai.sql

Learning OS V1 使用的初始化顺序和数据库名称,请以仓库中的 LEARNING_OS_V1_LOCAL_SETUP.md 为准。

启动业务服务

可以在服务模块目录中运行 Spring Boot:

bash
# 系统管理
mvn -pl x-boot-modules/sys/sys-service -am spring-boot:run

# AI 服务
mvn -pl x-boot-modules/ai/ai-service -am spring-boot:run

# OSS 服务
mvn -pl x-boot-modules/oss/oss-service -am spring-boot:run

如果需要启动任务调度管理:

bash
mvn -pl x-boot-job-admin spring-boot:run

常用检查入口

具体端口以本地配置和 Nacos 配置为准,常见入口包括:

  • Actuator 健康检查:/actuator/health
  • Swagger UI:/swagger-ui.html
  • Knife4j:/doc.html
  • Prometheus:/actuator/prometheus

配置原则

  • 数据库、Redis、Nacos 等环境配置通过 profile、配置中心或环境变量提供。
  • API Key、数据库密码和云服务密钥不得提交到源码仓库。
  • 生产配置应与本地配置分离,并使用 CI/CD Secret、Vault 或 KMS 管理敏感信息。
  • 修改服务模块前,先确认对应的 Facade 契约、租户上下文和配置边界。

以工程化方式构建可演进的 Java 微服务系统