文章来源于网络收集而来，版权归原创者所有，如有侵权请及时联系！

客户端详解

发布于 2024-08-18 11:12:34 字数 11302 浏览 0 评论 0 收藏 0

在学习了关于Spring Cloud Config服务端的大量配置和使用细节之后，接下来我们将通过本节内容继续学习Spring Cloud Config客户端的使用与配置。

URI指定配置中心

Spring Cloud Config的客户端在启动的时候，默认会从工程的classpath中加载配置信息并启动应用。只有当我们配置spring.cloud.config.uri的时候，客户端应用才会尝试连接Spring Cloud Config的服务端来获取远程配置信息并初始化Spring环境配置。同时，我们必须将该参数配置在bootstrap.properties、环境变量或是其他优先级高于应用Jar包内的配置信息中，才能正确加载到远程配置。若不指定spring.cloud.config.uri 参数的话，Spring Cloud Config 的客户端会默认尝试连接http://localhost:8888。

在之前的快速入门示例中，我们就是以这种方式实现的，就如下面的配置，其中spring.application.name和spring.cloud.config.profile用于定位配置信息。

spring.application.name=didispace

spring.cloud.config.profile=dev

spring.cloud.config.uri=http://localhost:7001/

服务化配置中心

在第3章中，我们已经学会了如何构建服务注册中心、如何发现与注册服务。那么Config Server是否也能以服务的方式注册到服务中心，并被其他应用所发现来实现配置信息的获取呢？答案是肯定的。在Spring Cloud中，我们也可以把Config Server视为微服务架构中与其他业务服务一样的一个基本单元。

下面，我们就来详细介绍如何将Config Server注册到服务中心，并通过服务发现来访问 Config Server 并获取 Git 仓库中的配置信息。下面的内容将基于快速入门中实现的config-server和config-client工程来进行改造实现。

服务端配置

- 在config-server的pom.xml中增加spring-cloud-starter-eureka依赖，以实现将分布式配置中心加入Eureka的服务治理体系。

……

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-config-server</artifactId>

</dependency>

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-starter-eureka</artifactId>

</dependency>

</dependencies>

……

- 在 application.properties 中配置参数 eureka.client.serviceUrl.defaultZone以指定服务注册中心的位置，详细内容如下：

spring.application.name=config-server

server.port=7001

# 配置服务注册中心

eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

# Git管理配置

spring.cloud.config.server.git.uri=http://git.oschina.net/didispace/SpringCloud-Learning/

spring.cloud.config.server.git.searchPaths=spring_cloud_in_action/config-repo

spring.cloud.config.server.git.username=username

spring.cloud.config.server.git.password=password

- 在应用主类中，新增@EnableDiscoveryClient注解，用来将config-server注册到上面配置的服务注册中心上去。

@EnableDiscoveryClient

@EnableConfigServer

@SpringBootApplication

public class Application {

public static void main（String[]args）{

new SpringApplicationBuilder（Application.class）.web（true）.run（args）;}

}

- 启动该应用，并访问http://localhost:1111/，可以在Eureka Server的信息面板中看到config-server已经被注册了。

客户端配置

- 在config-client的pom.xml中新增spring-cloud-starter-eureka依赖，以实现客户端发现config-server服务，具体配置如下：

……

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

</dependency>

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-starter-config</artifactId>

</dependency>

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-starter-eureka</artifactId>

</dependency>

</dependencies>

……

- 在bootstrap.properties中，按如下配置：

spring.application.name=didispace

server.port=7002

eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

spring.cloud.config.discovery.enabled=true

spring.cloud.config.discovery.serviceId=config-server

spring.cloud.config.profile=dev

其中，通过eureka.client.serviceUrl.defaultZone参数指定服务注册中心，用于服务的注册与发现；再将 spring.cloud.config.discovery.enabled参数设置为true，开启通过服务来访问Config Server的功能；最后利用spring.cloud.config.discovery.serviceId参数来指定Config Server注册的服务名。这里的spring.application.name和spring.cloud.config.profile如之前通过URI的方式访问的时候一样，用来定位Git中的资源。

- 在应用主类中，增加@EnableDiscoveryClient注解，用来发现config-server服务，利用其来加载应用配置：

@EnableDiscoveryClient

@SpringBootApplication

public class Application {

public static void main（String[]args）{

new SpringApplicationBuilder（Application.class）.web（true）.run（args）;

}

- 沿用之前我们创建的Controller来加载Git中的配置信息：

@RefreshScope

@RestController

public class TestController {

@Value（"${from}"）

private String from;

@RequestMapping（"/from"）

public String from（）{

return this.from;

}

- 完成上述配置之后，我们启动该客户端应用。若启动成功，访问http://localhost:1111/，可以在Eureka Server的信息面板中看到该应用已经被注册成功。

- 访问客户端应用提供的服务http://localhost:7002/from，此时，我们会返回在Git仓库中didispace-dev.properties文件中配置的from属性内容："git-dev-1.0"。

失败快速响应与重试

Spring Cloud Config的客户端会预先加载很多其他信息，然后再开始连接Config Server进行属性的注入。当我们构建的应用较为复杂的时候，可能在连接Config Server之前花费较长的启动时间，而在一些特殊场景下，我们又希望可以快速知道当前应用是否能顺利地从Config Server获取到配置信息，这对在初期构建调试环境时，可以减少很多等待启动的时间。要实现客户端优先判断Config Server获取是否正常，并快速响应失败内容，只需在bootstrap.properties中配置参数spring.cloud.config.failFast=true即可。

我们可以实验一下，在未配置该参数前，不启动Config Server，直接启动客户端应用，可以获得下面的报错信息。同时，在报错之前，可以看到客户端应用已经加载了很多内容，比如Controller的请求等。

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'scopedTarget.testController': Injection of autowired dependencies failed;

加上spring.cloud.config.failFast=true参数之后，再启动客户端应用，可以获得下面的报错信息，并且前置的加载内容少了很多，这样通过该参数有效避免了当Config Server配置有误时，不需要多等待前置的一些加载时间，实现了快速返回失败信息。

java.lang.IllegalStateException: Could not locate PropertySource and the fail fast property is set,failing

上面，我们演示了当Config Server宕机或是客户端配置不正确导致连接不到而启动失败的情况，快速响应的配置可以发挥比较好的效果。但是，若只是因为网络波动等其他间歇性原因导致的问题，直接启动失败似乎代价有些高。所以，Config 客户端还提供了自动重试的功能，在开启重试功能前，先确保已经配置了 spring.cloud.config.failFast=true，再进行下面的操作。

- 在客户端的 pom.xml 中增加 spring-retry 和 spring-boot-starter-aop依赖，具体如下：

……

<groupId>org.springframework.retry</groupId>

<artifactId>spring-retry</artifactId>

</dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-aop</artifactId>

</dependency>

……

</dependencies>

- 不需要再做其他任何配置，启动客户端应用，在控制台中可以看到如下内容。客户端在连接Config Server失败之后，会继续尝试，直到第6次失败后，才返回错误信息。通过这样的重试机制，可以避免一些间歇性问题引起的失败导致客户端应用无法启动的情况。