Docs: 更新项目文档

.gitignore

@@ -1,12 +1,13 @@
 # ---> Java
 # Compiled class file
 *.class
+*/target
 
 # Log file
 *.log
 
-# BlueJ files
+# Idea
-*.ctxt
+.idea
 
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/

README.md

@@ -1,3 +1,125 @@
-# spring-cloud-template
+# Spring Cloud 微服务模板项目
 
-😎 Spring Cloud 项目模板
+本项目是一个基于 Spring Cloud 的微服务架构模板，提供服务注册、配置管理、API 网关、服务间调用等核心功能，结构清晰、易于扩展，适用于快速搭建高可用的微服务系统。
+
+## 项目结构
+
+```
+spring-cloud-template
+├── eureka-server          # 服务注册中心（Eureka Server）
+├── config-server          # 配置中心（Spring Cloud Config）
+├── service-producer       # 服务提供者（示例服务A）
+├── service-consumer       # 服务消费者（示例服务B）
+├── api-gateway            # API 网关（Spring Cloud Gateway）
+└── pom.xml                # 父工程 POM 文件
+```
+
+## 核心功能
+
+### 1. 服务注册与发现
+- 使用 Eureka Server 实现服务注册与发现
+- 提供服务实例列表页面，便于监控服务状态
+
+### 2. 配置中心
+- 使用 Spring Cloud Config 实现统一配置管理
+- 支持配置的动态刷新
+
+### 3. 服务间调用
+- 使用 OpenFeign 实现声明式服务调用
+- 集成 Ribbon 实现客户端负载均衡
+
+### 4. API 网关
+- 使用 Spring Cloud Gateway 作为统一 API 入口
+- 支持路由配置和请求转发
+
+### 5. 服务健康检查
+- 集成 Spring Boot Actuator 实现服务健康检查
+- 提供监控端点，便于系统运维
+
+## 技术栈
+
+- **Spring Boot**: 3.3.13
+- **Spring Cloud**: 2023.0.6
+- **JDK**: 21
+- **Maven**: 3.x
+- **Eureka Server**: Netflix Eureka
+- **Config Server**: Spring Cloud Config
+- **API Gateway**: Spring Cloud Gateway
+- **OpenFeign**: 声明式 HTTP 客户端
+- **Ribbon**: 客户端负载均衡
+
+## 快速开始
+
+### 1. 环境要求
+- JDK 21
+- Maven 3.x
+
+### 2. 启动服务
+
+#### 启动服务注册中心 (Eureka Server)
+```bash
+cd eureka-server
+mvn spring-boot:run
+```
+
+#### 启动配置中心 (Config Server)
+```bash
+cd config-server
+mvn spring-boot:run
+```
+
+#### 启动服务提供者 (Service Producer)
+```bash
+cd service-producer
+mvn spring-boot:run
+```
+
+#### 启动服务消费者 (Service Consumer)
+```bash
+cd service-consumer
+mvn spring-boot:run
+```
+
+#### 启动 API 网关 (API Gateway)
+```bash
+cd api-gateway
+mvn spring-boot:run
+```
+
+### 3. 访问服务
+
+- Eureka Server: http://localhost:8761
+- Service Producer: http://localhost:8081/api/health
+- Service Consumer: http://localhost:8082/api/health
+- API Gateway: http://localhost:8080/api/consumer/print
+
+## 项目模块说明
+
+### eureka-server
+服务注册中心，负责服务的注册与发现。
+
+### config-server
+配置中心，统一管理微服务的配置信息。
+
+### service-producer
+服务提供者示例，提供 REST API 接口。
+
+### service-consumer
+服务消费者示例，调用其他服务提供的接口。
+
+### api-gateway
+API 网关，统一处理所有外部请求的入口。
+
+## 开发指南
+
+### 添加新服务
+1. 创建新的 Maven 模块
+2. 添加必要的依赖
+3. 配置服务注册与发现
+4. 实现业务逻辑
+
+### 配置管理
+所有服务都通过 Spring Cloud Config 进行配置管理，配置文件位于 config-server 中。
+
+### 负载均衡
+服务间调用使用 Ribbon 实现客户端负载均衡。

api-gateway/pom.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>cn.hezhaohui</groupId>
+        <artifactId>spring-cloud-template</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>api-gateway</artifactId>
+
+    <properties>
+        <maven.compiler.source>21</maven.compiler.source>
+        <maven.compiler.target>21</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-gateway</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-bootstrap</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-config</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>

api-gateway/src/main/java/cn/hezhaohui/apigateway/GatewayApplication.java

@@ -0,0 +1,13 @@
+package cn.hezhaohui.apigateway;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
+
+@SpringBootApplication
+@EnableDiscoveryClient
+public class GatewayApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(GatewayApplication.class, args);
+    }
+}

api-gateway/src/main/resources/bootstrap.yml

@@ -0,0 +1,11 @@
+spring:
+  application:
+    name: api-gateway
+  cloud:
+    config:
+      uri: http://localhost:8888
+      fail-fast: true
+eureka:
+  client:
+    service-url:
+      defaultZone: http://localhost:8761/eureka/

config-server/pom.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>cn.hezhaohui</groupId>
+        <artifactId>spring-cloud-template</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>config-server</artifactId>
+
+    <properties>
+        <maven.compiler.source>21</maven.compiler.source>
+        <maven.compiler.target>21</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-config-server</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-netflix-eureka-client</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>

config-server/src/main/java/cn/hezhaohui/configserver/ConfigServerApplication.java

@@ -0,0 +1,15 @@
+package cn.hezhaohui.configserver;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
+import org.springframework.cloud.config.server.EnableConfigServer;
+
+@SpringBootApplication
+@EnableConfigServer
+@EnableDiscoveryClient
+public class ConfigServerApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(ConfigServerApplication.class, args);
+    }
+}

config-server/src/main/resources/application.yml

@@ -0,0 +1,16 @@
+server:
+  port: 8888
+spring:
+  application:
+    name: config-server
+  cloud:
+    config:
+      server:
+        git:
+          uri: http://47.121.181.112:3000/wonder/spring-cloud-config
+          search-paths: config-files
+
+eureka:
+  client:
+    service-url:
+      defaultZone: http://localhost:8761/eureka/

eureka-server/pom.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>cn.hezhaohui</groupId>
+    <artifactId>eureka-server</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <parent>
+        <groupId>cn.hezhaohui</groupId>
+        <artifactId>spring-cloud-template</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <properties>
+        <maven.compiler.source>21</maven.compiler.source>
+        <maven.compiler.target>21</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>

eureka-server/src/main/java/cn/hezhaohui/eurekaserver/EurekaServerApplication.java

@@ -0,0 +1,14 @@
+package cn.hezhaohui.eurekaserver;
+
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
+
+@SpringBootApplication
+@EnableEurekaServer
+public class EurekaServerApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(EurekaServerApplication.class, args);
+    }
+}

eureka-server/src/main/resources/application.yml

@@ -0,0 +1,15 @@
+server:
+  port: 8761
+
+spring:
+  application:
+    name: eureka-server
+
+eureka:
+  instance:
+    hostname: localhost
+  client:
+    register-with-eureka: false
+    fetch-registry: false
+    service-url:
+      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

eureka-server/src/test/java/cn/hezhaohui/eurekaserver/EurekaServerApplicationTest.java

@@ -0,0 +1,14 @@
+package cn.hezhaohui.eurekaserver;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+class EurekaServerApplicationTest {
+
+    @Test
+    void contextLoads() {
+
+    }
+
+}

pom.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>cn.hezhaohui</groupId>
+    <artifactId>spring-cloud-template</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <packaging>pom</packaging>
+
+    <modules>
+        <module>eureka-server</module>
+        <module>config-server</module>
+        <module>service-producer</module>
+        <module>service-consumer</module>
+        <module>api-gateway</module>
+    </modules>
+
+    <properties>
+        <maven.compiler.source>21</maven.compiler.source>
+        <maven.compiler.target>21</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-starter-parent</artifactId>
+                <version>3.3.13</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+
+            <dependency>
+                <groupId>org.springframework.cloud</groupId>
+                <artifactId>spring-cloud-dependencies</artifactId>
+                <version>2023.0.6</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+
+        </dependencies>
+    </dependencyManagement>
+
+</project>

service-consumer/pom.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>cn.hezhaohui</groupId>
+        <artifactId>spring-cloud-template</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>service-consumer</artifactId>
+
+    <properties>
+        <maven.compiler.source>21</maven.compiler.source>
+        <maven.compiler.target>21</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-netflix-eureka-client</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-config</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-bootstrap</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-openfeign</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
+        </dependency>
+
+    </dependencies>
+
+</project>

service-consumer/src/main/java/cn/hezhaohui/serviceconsumer/ServiceConsumerApplication.java

@@ -0,0 +1,15 @@
+package cn.hezhaohui.serviceconsumer;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
+import org.springframework.cloud.openfeign.EnableFeignClients;
+
+@SpringBootApplication
+@EnableFeignClients
+@EnableDiscoveryClient
+public class ServiceConsumerApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(ServiceConsumerApplication.class, args);
+    }
+}

service-consumer/src/main/java/cn/hezhaohui/serviceconsumer/client/ServiceProducerClient.java

@@ -0,0 +1,11 @@
+package cn.hezhaohui.serviceconsumer.client;
+
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@FeignClient(name = "service-producer")
+public interface ServiceProducerClient {
+
+    @GetMapping("/api/number")
+    String getNumber();
+}

service-consumer/src/main/java/cn/hezhaohui/serviceconsumer/config/RestTemplateConfig.java

@@ -0,0 +1,16 @@
+package cn.hezhaohui.serviceconsumer.config;
+
+import org.springframework.cloud.client.loadbalancer.LoadBalanced;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.client.RestTemplate;
+
+@Configuration
+public class RestTemplateConfig {
+
+    @Bean
+    @LoadBalanced
+    public RestTemplate restTemplate () {
+        return new RestTemplate();
+    }
+}

service-consumer/src/main/java/cn/hezhaohui/serviceconsumer/controller/ConsumeController.java

@@ -0,0 +1,23 @@
+package cn.hezhaohui.serviceconsumer.controller;
+
+import cn.hezhaohui.serviceconsumer.client.ServiceProducerClient;
+import jakarta.annotation.Resource;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.client.RestTemplate;
+
+@RestController
+@RequestMapping("/api")
+public class ConsumeController {
+
+    @Resource
+    private ServiceProducerClient serviceProducerClient;
+
+    @GetMapping("/print")
+    public String print() {
+        String number = serviceProducerClient.getNumber();
+        return "[Generate]: " + number;
+    }
+
+}

service-consumer/src/main/java/cn/hezhaohui/serviceconsumer/controller/HealthController.java

@@ -0,0 +1,19 @@
+package cn.hezhaohui.serviceconsumer.controller;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api")
+public class HealthController {
+
+    @Value("${test.message}")
+    private String testMessage;
+
+    @GetMapping("/health")
+    public String health() {
+        return "Wow, nice to meet you!" + "\n" + testMessage;
+    }
+}

service-consumer/src/main/resources/bootstrap.yml

@@ -0,0 +1,11 @@
+spring:
+  application:
+    name: service-consumer
+  cloud:
+    config:
+      uri: http://localhost:8888
+      fail-fast: true
+eureka:
+  client:
+    service-url:
+      defaultZone: http://localhost:8761/eureka/

service-producer/pom.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>cn.hezhaohui</groupId>
+        <artifactId>spring-cloud-template</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>service-producer</artifactId>
+
+    <properties>
+        <maven.compiler.source>21</maven.compiler.source>
+        <maven.compiler.target>21</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-netflix-eureka-client</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-config</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-starter-bootstrap</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>

service-producer/src/main/java/cn/hezhaohui/serviceproducer/ServiceProducerApplication.java

@@ -0,0 +1,11 @@
+package cn.hezhaohui.serviceproducer;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class ServiceProducerApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(ServiceProducerApplication.class, args);
+    }
+}

service-producer/src/main/java/cn/hezhaohui/serviceproducer/controller/HealthController.java

@@ -0,0 +1,19 @@
+package cn.hezhaohui.serviceproducer.controller;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api")
+public class HealthController {
+
+    @Value("${test.message}")
+    private String testMessage;
+
+    @GetMapping("/health")
+    public String health() {
+        return "Wow, nice to meet you!" + "\n" + testMessage;
+    }
+}

service-producer/src/main/java/cn/hezhaohui/serviceproducer/controller/ProduceController.java

@@ -0,0 +1,18 @@
+package cn.hezhaohui.serviceproducer.controller;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.Random;
+
+@RestController
+@RequestMapping("/api")
+public class ProduceController {
+
+    @GetMapping("/number")
+    public int getNum() {
+        Random random = new Random();
+        return random.nextInt(101);
+    }
+}

service-producer/src/main/resources/bootstrap.yml

@@ -0,0 +1,11 @@
+spring:
+  application:
+    name: service-producer
+  cloud:
+    config:
+      uri: http://localhost:8888
+      fail-fast: true
+eureka:
+  client:
+    service-url:
+      defaultZone: http://localhost:8761/eureka/