Spring Cloud 专题-配置篇（2）

关注微信公众号：IT技术馆

Spring Cloud 是一个基于 Spring Boot 构建的云应用开发工具集，它为开发人员提供了在分布式系统中快速实现常见模式（如配置管理、服务发现、断路器等）的能力。下面是一个简化的示例，展示如何在 Spring Boot 应用中引入 Spring Cloud 的一些关键组件。

环境准备

确保你的开发环境中安装了以下工具：

Java Development Kit (JDK) 8 或更高版本
Maven 或 Gradle 构建工具
IDE（如 IntelliJ IDEA 或 Eclipse）

创建 Spring Boot 项目

使用 Spring Initializr (https://start.spring.io/) 来创建一个新的 Spring Boot 项目，选择所需的依赖。例如，如果你想开始一个使用 Eureka 作为服务发现和 Ribbon 作为客户端负载均衡的项目，可以勾选以下依赖项：

Spring Web
Spring Cloud Starter Netflix Eureka Client
Spring Cloud Starter OpenFeign (可选，用于声明式的服务调用)

添加依赖

在生成的 pom.xml 文件中，你会看到类似以下的依赖被自动加入：

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Spring Cloud Starter Netflix Eureka Client -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <!-- Spring Cloud Starter OpenFeign (可选) -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

<!-- Spring Cloud Dependency Management -->
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring-cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

配置 Eureka 服务发现

在 src/main/resources/application.yml 或 application.properties 文件中，配置 Eureka 客户端：

spring:
  application:
    name: my-service # 服务名，用于注册到 Eureka

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
    register-with-eureka: true
    fetch-registry: true

启动类配置

在你的 Spring Boot 应用的主类上添加 @EnableEurekaClient 注解来启用 Eureka 客户端功能：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

@SpringBootApplication
@EnableEurekaClient
public class MyServiceApplication {


    public static void main(String[ ] args) {

        SpringApplication.run(MyServiceApplication.class, args);
    }
}

示例：服务间调用

如果要从一个服务调用另一个服务，可以使用 Feign（如果添加了相关依赖）进行声明式的服务调用：

首先，定义一个接口：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(name = "another-service") // 另一服务的名称
public interface AnotherServiceClient {
    @GetMapping("/api/data/{id}")
    String getDataById(@PathVariable("id") Long id);
}

然后，在需要调用服务的地方注入这个接口并使用：

@RestController
public class MyController {
    
    @Autowired
    private AnotherServiceClient anotherServiceClient;

    @GetMapping("/my-endpoint")
    public String myEndpoint() {
        String data = anotherServiceClient.getDataById(1L);
        return "Data from Another Service: " + data;
    }
}

断路器 Hystrix

为了提高微服务架构的容错能力，Spring Cloud 提供了断路器 Hystrix 的集成。Hystrix 能够阻止服务雪崩效应，通过快速失败机制保护系统，同时提供 fallback 方法以便在服务不可用时返回一个备选响应。

添加依赖

在 pom.xml 中添加 Hystrix 的依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>

启用 Hystrix

在主类或配置类上添加 @EnableCircuitBreaker 注解：

import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@EnableEurekaClient
@EnableCircuitBreaker
public class MyServiceApplication {
    // ...
}

使用 Hystrix

修改之前的服务调用代码，使用 HystrixCommand：

import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;

@RestController
public class MyController {
    
    @Autowired
    private AnotherServiceClient anotherServiceClient;

    @GetMapping("/my-endpoint")
    public String myEndpoint() {
        String data = anotherServiceClient.getDataByIdWithHystrix(1L);
        return "Data from Another Service: " + data;
    }

    // 在 AnotherServiceClient 接口中添加 Hystrix 命令包装
    @HystrixCommand(fallbackMethod = "getDataByIdFallback")
    @GetMapping("/api/data/{id}")
    public String getDataByIdWithHystrix(@PathVariable("id") Long id) {
        // 这里是原有逻辑，假设直接调用远程服务
        return anotherServiceClient.getDataById(id);
    }

    // Fallback 方法
    public String getDataByIdFallback(Long id) {
        return "Fallback response - Service is unavailable";
    }
}

Spring Cloud Config 服务配置中心

Spring Cloud Config 允许你将配置集中管理，从而便于配置的更改和版本控制。

创建配置服务器

添加依赖到 pom.xml:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>

配置 application.yml:

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/your-config-repo.git # 配置仓库地址
          search-paths: config-repo # 可选，配置文件的路径前缀

启用 Config Server：

import org.springframework.cloud.config.server.EnableConfigServer;
// ...

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {
    // ...
}

配置客户端应用

添加依赖到 pom.xml:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

配置 bootstrap.yml (注意是 bootstrap 不是 application):

spring:
  cloud:
    config:
      uri: http://localhost:8888 # Config Server 地址
      label: master # Git 分支标签
      name: your-service-name # 配置文件名，不包含后缀
      profile: dev # 环境标识

在服务启动类或配置类上添加 @RefreshScope 注解，使配置动态刷新：

import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.RestController;

@RefreshScope
@RestController
public class MyRestController {
    // ...