Files
spring-cloud-template/README.md
T
2025-10-06 14:53:52 +08:00

24 lines
3.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# spring-cloud-template
本项目是一个基于 Spring Cloud 的微服务架构模板,提供服务注册、配置管理、API 网关、服务间调用等核心功能,结构清晰、易于扩展,适用于快速搭建高可用的微服务系统。
## 任务清单
| **任务编号** | **任务名称** | **说明** |
|--------------|---------------------------------------------------|--------------------------------------------------------------------------|
| T01 | 创建项目根目录 `spring-cloud-template` | 作为 Maven 父工程,统一管理子模块的依赖和版本 |
| T02 | 搭建 Eureka Server 模块 | 配置单机模式,实现服务注册与发现功能,提供服务实例列表页面 |
| T03 | 搭建 Config Server 模块 | 配置 Spring Cloud Config,实现统一配置管理 |
| T04 | 创建 Service A 模块 | 实现 `/api/service-a/hello` REST 接口,配置 logging 和 health check |
| T05 | 创建 Service B 模块 | 实现 `/api/service-b/hello` REST 接口,配置 logging 和 health check |
| T06 | 集成 Feign Client 和 Ribbon 服务调用 | 服务间使用 Feign 进行远程调用,Ribbon 实现负载均衡 |
| T07 | 搭建 API Gateway 模块 | 配置路由规则(如 `/api/service-a/**` 路由到 service-a) |
| T08 | 创建 Demo Client 模块 | 调用通过 API Gateway 路由的服务 A 和 B,展示客户端访问逻辑 |
| T09 | 配置 Spring Boot 和 Spring Cloud 版本 | 使用 Spring Boot 3.x 和 Spring Cloud 2023.0.x 作为技术栈版本 |
| T10 | 集成日志系统(SLF4J + Logback) | 统一日志输出,支持日志管理 |
| T11 | 配置 Git 项目结构,支持代码托管 | 使用 Gitea 或其他 Git 服务管理代码和配置文件 |
| T12 | 检查开发环境是否满足要求 | 确保 JDK 21、Maven 3.x、IDE 等工具已安装并配置正确 |
| T13 | 验证服务注册、配置获取、路由和调用功能 | 确保各模块之间能正常通信、注册、访问和负载均衡 |
| T14 | 添加 Hystrix 支持,实现断路机制 | 为服务调用增加容错能力,防止雪崩效应 |
| T15 | 测试健康检查接口 | 使用 Spring Boot Actuator 提供健康状态检查 |
| T16 | 编写项目说明文档和运行指南 | 为后续开发人员提供使用和启动说明 |