Spring Cloud 入门之 Config（六）附源码

﹏ヽ暗。殇╰゛Y 2024-04-17 05:52 68阅读 0赞

# 一、前言 #

本文是根据笔者上篇文章项目进行修改，若有不懂，请转[《Spring Cloud 入门 之 Zuul（五）附源码》][Spring Cloud _ _ Zuul]

# 二、介绍 #

Spring Cloud Config为分布式系统中的外部化配置提供服务器和客户端支持。使用Config Server，您可以在所有环境中管理应用程序的外部属性。

## 特征： ##

### Spring Cloud Config Server功能： ###

*  用于外部配置的HTTP，基于资源的API（名称 - 值对或等效的YAML内容）
 *  加密和解密属性值（对称或非对称）
 *  使用可轻松嵌入Spring Boot应用程序 `@EnableConfigServer`

### Config Client功能（适用于Spring应用程序）： ###

*  绑定到Config Server并`Environment`使用远程属性源初始化Spring
 *  加密和解密属性值（对称或非对称）

# 三、实战演练 #

<table> 
 <thead> 
  <tr> 
   <th>服务实例</th> 
   <th>端口</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>eureka-server</td> 
   <td>9000</td> 
   <td>注册中心（Eureka 服务端）</td> 
  </tr> 
  <tr> 
   <td>config-server</td> 
   <td>10000</td> 
   <td>配置中心（Eureka 客户端、Config 服务端）</td> 
  </tr> 
  <tr> 
   <td>api</td> 
   <td>80</td> 
   <td>服务接口（Eureka 客户端、Config 客户端）</td> 
  </tr> 
 </tbody> 
</table>

## 3.1上传配置 ##

在 GitHub 上新建一个私有仓库，名为config

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70][]

**创建[application-dev.yml][]和[application-test.yml][]，这是之前api中[application.yml][application-test.yml]的参数。**

**两者之间只有env 的值不同，其中一个是 dev ，另一个是 test。**

provider:
      # 名称
      name: provider
      # 版本
      version: 1.0
      # 版权年份
      copyrightYear: 2019
      # 文件上传路径
      profile: profile/
      # 获取ip地址开关
      addressEnabled: true
    
    env: dev1
    
    server:
      port: 80
    
    
    spring:
      application:
        name: api
    
    eureka:
      client:
    #    register-with-eureka: false # 不向注册中心注册自己
        fetch-registry: true        # 是否检索服务
        service-url:
          defaultZone: http://localhost:9000/eureka/  # 注册中心访问地址
    
    feign:
      hystrix:
        enabled: true #开启服务降级功能
      client:
        config:
          default:
            connect-timeout: 10000
            read-timeout: 20000
          service-test:
            connect-timeout: 10000
            read-timeout: 20000
    
    management:
      endpoints:
        web:
          exposure:
            include: "*"

## 3.2 创建config 服务端 ##

新建一个 spring boot 项目，名为 config-server

### 3.2.1 添加依赖 ###

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
                <version>2.1.0.RELEASE</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</artifactId>
                <version>2.1.0.RELEASE</version>
            </dependency>

### 3.2.2 application.yml ###

server:
      port: 10000
    
    spring:
      application:
        name: CONFIG
      cloud:
        config:
          server:
            git:
              uri: https://github.com/Uncle-LiuY/config.git
              username: ******
              password: ******
    eureka:
      instance:
        instance-id: config-api
      client:
        service-url:
          defaultZone: http://localhost:9000/eureka/  服务注册中心ַ

### 3.2.3 修改启动类 ###

@EnableConfigServer
    @EnableEurekaClient

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 1][]

## 3.2.4 启动测试 ##

依次启动eureka-server、config-server

在浏览器访问 [http://localhost:10000/application-dev.yml][http_localhost_10000_application-dev.yml] 和 [http://localhost:10000/application-test.yml][http_localhost_10000_application-test.yml]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 3][]

其中，访问规则如下：

**`<IP:PORT>/{name}-{profiles}.yml`**

**`<IP:PORT>/{label}/{name}-{profiles}.yml`**

name：文件名，可当作服务名称

profiles: 环境，如：dev，test，pro

lable: 分支，指定访问某分支下的配置文件，默认拉去 master 分支。

##  3.3 config 客户端 ##

对api进行修改

### 3.3.1 添加配置： ###

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-client</artifactId>
                <version>2.1.0.RELEASE</version>
            </dependency>

### 3.3.2 删除 application.yml，并新建 bootstrap.yml，保存如下内容： ###

spring:
      application:
        name: api
      cloud:
        config:
          discovery:
            enabled: true
            service-id: CONFIG  # config-server 在注册中心的名称
          profile: dev  # 指定配置文件的环境
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:9000/eureka/  # 注册中心访问地

配置中，通过 spring.cloud.config.discovery.service-id 确定配置中心，再通过 spring.application.name 的值拼接 spring.cloud.config.profile 的值，从而确定需要拉去从配置中心获取的配置文件。（如：application-dev）

**注意：必须保留 eureka 注册中心的配置，否则 API 无法连接注册中心，也就无法获取配置中心(config-server)的访问信息。**

### 3.3.4 测试类 ###

@RestController
    @RequestMapping("/test")
    public class TestController {
    
        @Value("${env}")
        private String env; // 从配置中心获取
    
        @RequestMapping("/getConfigInfo")
        public String getConfigInfo() {
            return env;
        }
    }

打开浏览器访问 [http://localhost/test/getConfigInfo][http_localhost_test_getConfigInfo]，结果如下图：

根据配置文件中的端口进行访问，这里配置的是80端口

![20190824152525947.png][]

成功获取 config-server 从远程私有仓库拉去的数据，由于在 bootstrap.yml 中配置了 spring.cloud.config.profile=dev，因此拉取到的数据就是 application-dev.yml 中的数据。

在GitHub上修改配置文件的参数，依次启动config-server、api

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 4][]

![20190824152957814.png][]

# 4.项目源码 #

## [下载][Link 1] ##

当我们修改远程私有仓库的配置文件时，Config Server 如何知道是否该重新获取远程仓库数据呢？

现在已知唯一的解决方式就是重启 Config Client 项目，在项目启动时会请求 Config Server 重新拉去远程私有仓库数据。但是，如果是在生产环境下随便重启项目必定会影响系统的正常运行，那有没有更好的方式解决上述的问题呢？

详情请查看[《Spring Cloud 整合 Bus（附源码）》][Spring Cloud _ Bus]

[Spring Cloud _ _ Zuul]: https://blog.csdn.net/qq_40369944/article/details/99541255
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/b5f524677d4d4971ac8271d5835754ee.png
[application-dev.yml]: https://github.com/Uncle-LiuY/config/blob/master/application-dev.yml
[application-test.yml]: https://github.com/Uncle-LiuY/config/blob/master/application-test.yml
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/64cdf35cf35a465da15172ebb278494f.png
[http_localhost_10000_application-dev.yml]: http://localhost:10000/application-dev.yml
[http_localhost_10000_application-test.yml]: http://localhost:10000/application-test.yml
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/b42d7a6d706c413e99fa0ab5632c8ab6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/a08febd1abb94883a24fbcb53367513a.png
[http_localhost_test_getConfigInfo]: http://localhost:8100/test/getConfigInfo
[20190824152525947.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/479f6db27fd64bb1afbabee8c84ae7e6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMzY5OTQ0_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/792830ef1bf749dd8f46b4f1ad9995f0.png
[20190824152957814.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/6477abfb9d9c42de8923a34844fdf844.png
[Link 1]: https://github.com/Uncle-LiuY/spring-cloud-test
[Spring Cloud _ Bus]: https://blog.csdn.net/qq_40369944/article/details/100053803