bishe-backend 启动与部署说明

本文档用于说明后端服务在本地开发、Docker 启动与 CNB 自动构建场景下的标准用法。

• JDK 17
• Docker（如需容器化运行）
• 可访问的 MySQL 数据库（容器编排不内置数据库）

chmod +x ./mvnw
./mvnw spring-boot:run

• 接口服务：http://localhost:8080
• Swagger UI：http://localhost:8080/swagger-ui/index.html
• OpenAPI JSON：http://localhost:8080/v3/api-docs

docker build -t bishe-backend:latest .

说明：当前 compose 文件仅启动后端服务，数据库需外部提供。

先设置数据库环境变量：

export DB_URL='jdbc:mysql://192.168.1.10:3306/bishe?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&allowPublicKeyRetrieval=true&useSSL=false'
export DB_USERNAME='root'
export DB_PASSWORD='123456'

启动：

docker compose up -d --build

查看日志：

docker compose logs -f bishe-backend

停止并清理：

docker compose down

注意事项：

• DB_URL、DB_USERNAME、DB_PASSWORD 在 compose 中为必填项，缺失会直接报错。
• compose 依赖外部网络 network_default，请提前创建或确认已存在。

仓库已配置 CNB 流水线，在 master 分支推送后会自动：

• 构建镜像
• 推送 latest 标签镜像

镜像地址格式：

• ${CNB_DOCKER_REGISTRY}/${CNB_REPO_SLUG_LOWERCASE}/backend:latest

以下参数可通过环境变量覆盖（包含本地运行与容器运行场景）：

• SERVER_PORT：服务端口，默认 8080
• DB_URL：数据库连接串（建议必填）
• DB_USERNAME：数据库用户名，默认 root
• DB_PASSWORD：数据库密码，默认 123456
• SPRINGDOC_API_DOCS_ENABLED：是否开启 OpenAPI，默认 true
• SPRINGDOC_SWAGGER_UI_ENABLED：是否开启 Swagger UI，默认 true

• 8080：后端接口与 API 文档端口