Spring Cloud 系列之 Config 配置中心

Love The Way You Lie 2022-12-03 08:41 266阅读 0赞

配置文件是我们再熟悉不过的，在微服务系统中，每个微服务不仅仅只有代码，还需要**「连接其他资源」**，例如数据库的配置或功能性的开关 MySQL、Redis 、Security 等相关的配置。除了项目运行的基础配置之外，还有一些配置是与我们业务有关系的，比如说七牛存储、短信和邮件相关，或者一些业务上的开关。

但是随着微服务系统的不断迭代，整个微服务系统可能会成为一个**「网状结构」**，这个时候就要考虑整个微服务系统的**「扩展性、伸缩性、耦合性」**等等。其中一个很重要的环节就是**「配置管理」**的问题。

## ***2***|***0*****常规配置管理解决方案缺点** ##

*  硬编码（需要修改代码、繁琐、风险大）
 *  properties 或者 yml（集群环境下需要替换和重启）
 *  xml（重新打包和重启）

## ***3***|***0*****为什么使用 Spring Cloud Config** ##

[![format_png][]][format_png 1]

由于常规配置管理有很大的缺点，所以采用 Spring Cloud Config **「集中式」**的配置中心来管理**「每个服务」**的配置信息。

Spring Cloud Config 在微服务分布式系统中，采用 **「Server 服务端」**和 **「Client 客户端」**的方式来提供可扩展的配置服务。服务端提供配置文件的存储，以接口的形式将配置文件的内容提供出去；客户端通过接口获取数据、并依据此数据初始化自己的应用。

配置中心负责**「管理所有服务」**的各种环境配置文件。

配置中心默认采用 `Git` 的方式存储配置文件，因此我们可以很容易的部署和修改，有助于环境配置进行版本管理。

## ***4***|***0*****Spring Cloud Config 解决了什么问题** ##

Spring Cloud Config 解决了微服务配置的**「中心化、版本控制、平台独立、语言独立」**等问题。其特性如下：

*  提供服务端和客户端支持（Spring Cloud Config Server 和 Spring Cloud Config Client）
 *  集中式管理分布式环境下的应用部署
 *  属性值的加密和解密（对称加密和非对称加密）
 *  基于 Spring 环境，无缝与 Spring 应用集成
 *  可用于任何语言开发的程序
 *  默认实现基于 Git ，可以进行版本管理

接下来，我们主要从以下几块来讲一下 Config 的使用。

1.  基础版的配置中心（不集成 Eureka）
2.  集成 Eureka 版的高可用配置中心
3.  基于 Actuator 实现配置的自动刷新
4.  配置中心属性值的加密和解密（对称加密和非对称加密）
5.  基于 Spring Cloud Bus 实现配置的自动刷新
6.  配置中心用户安全认证

## ***5***|***0*****环境准备** ##

### ***5***|***1*****项目** ###

`config-demo` 聚合工程。`SpringBoot 2.2.4.RELEASE`、`Spring Cloud Hoxton.SR1`。

*  `eureka-server`：注册中心（用于集成 Eureka 版的配置中心）
 *  `eureka-server02`：注册中心（用于集成 Eureka 版的配置中心）
 *  `order-service`：订单服务（用于集成 Eureka 版的配置中心）

[![format_png 2][]][format_png 2 1]

### ***5***|***2*****仓库** ###

`config-repo` 仓库。

[![format_png 3][]][format_png 3 1]

*  `Repository name`：仓库名称
 *  `Description(可选)`：仓库描述介绍
 *  `Public，Private`：仓库权限（公开共享，私有或指定合作者）
 *  `Initialize this repository with a README`：添加一个 README.md
 *  `Add .gitignore`：不需要进行版本管理的文件类型，生成对应文件 `.gitignore`
 *  `Add a license`：证书类型，生成对应文件 `LICENSE`

不同环境的配置文件，上传至 `config-repo` 仓库。

[![format_png 4][]][format_png 4 1]

> ❝
> 
> 配置文件的名称不是乱起的，例如 `config-client-dev.yml` 和 `config-client-prod.yml` 这两个文件是同一个项目的不同环境，项目名称为 `config-client`， 一个对应开发环境，一个对应正式环境。`test` 表示测试环境。

----- config-client.yml
    
    server:
      port: 7777 # 端口
    
    spring:
      application:
        name: config-client # 应用名称
    
    # 自定义配置
    name: config-client-default

-------  config-client-dev.yml
    
    server:
      port: 7778 # 端口
    
    spring:
      application:
        name: config-client # 应用名称
    
    # 自定义配置
    name: config-client-dev

--------  config-client-test.yml
    
    server:
      port: 7779 # 端口
    
    spring:
      application:
        name: config-client # 应用名称
    
    # 自定义配置
    name: config-client-test

---------   config-client-prod.yml
    
    server:
      port: 7780 # 端口
    
    spring:
      application:
        name: config-client # 应用名称
    
    # 自定义配置
    name: config-client-prod

入门案例讲解：基础版的配置中心（不集成 Eureka）

官方文档：https://cloud.spring.io/spring-cloud-static/spring-cloud-config/2.2.2.RELEASE/reference/html/

### ***6***|***1*****创建服务端** ###

点击链接观看：[Config 入门案例创建服务端视频][Config]（获取更多请关注公众号「哈喽沃德先生」）

在 `config-demo` 父工程下创建子项目 `config-server`。

**添加依赖**

添加 `spring-cloud-config-server` 依赖，完整 `pom.xml` 文件如下：

<?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>com.example</groupId>
        <artifactId>config-server</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        
        <parent>
            <groupId>com.example</groupId>
            <artifactId>config-demo</artifactId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
    </project>

**配置文件**

server:
      port: 8888 # 端口
    
    spring:
      application:
        name: config-server # 应用名称
      cloud:
        config:
          server:
            git:
              uri: https://github.com/imrhelloworld/config-repo # 配置文件所在仓库地址
              #username:             # Github 等产品的登录账号
              #password:             # Github 等产品的登录密码
              #default-label: master # 配置文件分支
              #search-paths:         # 配置文件所在根目录

**启动类**

启动类添加 `@EnableConfigServer` 注解。

package com.example;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.config.server.EnableConfigServer;
    
    // 配置中心服务端注解
    @EnableConfigServer
    @SpringBootApplication
    public class ConfigServerApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigServerApplication.class, args);
        }
    
    }

**访问规则**

Spring Cloud Config 有一套访问规则，我们通过这套规则在浏览器上直接访问即可。

/{application}/{profile}[/{label}]
    /{application}-{profile}.yml
    /{label}/{application}-{profile}.yml
    /{application}-{profile}.properties
    /{label}/{application}-{profile}.properties

*  `{application}`：应用名称（目标服务名称）
 *  `{profile}`：获取指定环境配置，项目有开发环境、测试环境、生产环境，对应到配置文件就是以 application-\{profile\}.yml 加以区分，例如 application-dev.yml、application-test.yml、application-prod.yml。默认值为 default。
 *  `{label}`：表示 git 分支，默认是 master 分支，如果项目是以分支做区分也是可以的，那就可以通过不同的 label 来控制访问不同的配置文件。

**「测试」**

http://localhost:8888/config-client/default

http://localhost:8888/config-client/dev/master

http://localhost:8888/config-client-test.yml

http://localhost:8888/master/config-client-prod.yml

访问以上地址，如果可以正常返回数据，说明配置中心服务端一切正常。

### ***6***|***2*****创建客户端** ###

点击链接观看：[Config 入门案例创建客户端视频][Config 1]（获取更多请关注公众号「哈喽沃德先生」）

在 `config-demo` 父工程下创建子项目 `config-client`。

**添加依赖**

添加 `spring-cloud-starter-config` 依赖，完整 `pom.xml` 文件如下：

<?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>com.example</groupId>
        <artifactId>config-client</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        
        <parent>
            <groupId>com.example</groupId>
            <artifactId>config-demo</artifactId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-config</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
    </project>

### **配置文件** ###

客户端配置文件名称必须叫 `bootstrap.yml：`

spring:
      cloud:
        config:
          name: config-client # 配置文件名称，对应 git 仓库中配置文件前半部分
          uri: http://localhost:8888 # config-server 服务端地址
          label: master # git 分支
          profile: default # 指定环境

客户端配置文件名称必须叫 `bootstrap.yml`

**控制层**

添加一个 RestController 用于测试获取配置文件信息。

package com.example.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class ConfigController {
    
        @Value("${name}")
        private String name;
    
        @GetMapping("/name")
        public String getName() {
            return name;
        }
    
    }

**启动类**

package com.example;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class ConfigClientApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ConfigClientApplication.class, args);
        }
    
    }

**测试**

访问：http://localhost:7777/name 结果如下：

[![format_png 5][]][format_png 5 1]

修改配置文件为 `dev` 环境：

spring:
      cloud:
        config:
          name: config-client # 应用名称，对应 git 仓库中配置文件前半部分
          uri: http://localhost:8888 # config-server 服务端地址
          label: master # git 分支
          profile: dev # 指定环境

访问：http://localhost:7778/name 结果如下：

[![format_png 6][]][format_png 6 1]

## ***7***|***0*****Spring Cloud Config 高可用** ##

以上讲了 Spring Cloud Config 最基础的用法，如果我们的项目中使用了 Eureka 作为服务注册发现中心，那么 Spring Cloud Config 也应该注册到 Eureka，方便其他服务使用，并且可以注册多个配置中心服务端，实现高可用。

接下来就集成 Spring Cloud Config 到 Eureka。关于 Eureka 的相关知识大家可翻阅我的历史文章进行学习。

### ***7***|***1*****添加配置文件** ###

在 Github 仓库中增加配置文件。

[![format_png 7][]][format_png 7 1]

order-service-dev.yml

server:
      port: 9090 # 端口
    
    spring:
      application:
        name: order-service # 应用名称
    
    # 配置 Eureka Server 注册中心
    eureka:
      instance:
        prefer-ip-address: true       # 是否使用 ip 地址注册
        instance-id: ${spring.cloud.client.ip-address}:${server.port} # ip:port
      client:
        service-url:                  # 设置服务注册中心地址
          defaultZone: http://localhost:8761/eureka/,http://localhost:8762/eureka/
    
    # 自定义配置
    name: order-service-dev

order-service-prod.yml

server:
      port: 9091 # 端口
    
    spring:
      application:
        name: order-service # 应用名称
    
    # 配置 Eureka Server 注册中心
    eureka:
      instance:
        prefer-ip-address: true       # 是否使用 ip 地址注册
        instance-id: ${spring.cloud.client.ip-address}:${server.port} # ip:port
      client:
        service-url:                  # 设置服务注册中心地址
          defaultZone: http://localhost:8761/eureka/,http://localhost:8762/eureka/
    
    # 自定义配置
    name: order-service-prod

### ***7***|***2*****整合注册中心** ###

案例已经给大家准备好了，无需创建注册中心直接使用即可，为了清楚，把依赖和配置信息给大家贴出来。

**依赖**

`eureka-server` 和 `eureka-server02` 核心依赖部分一致。

<?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>com.example</groupId>
        <artifactId>eureka-server</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        
        <parent>
            <groupId>com.example</groupId>
            <artifactId>config-demo</artifactId>
            <version>1.0-SNAPSHOT</version>
        </parent>
    
        
        <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-web</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
    </project>

配置文件

`eureka-server` 的 application.yml

server:
      port: 8761 # 端口
    
    spring:
      application:
        name: eureka-server # 应用名称(集群下相同)
    
    # 配置 Eureka Server 注册中心
    eureka:
      instance:
        hostname: eureka01            # 主机名，不配置的时候将根据操作系统的主机名来获取
        prefer-ip-address: true       # 是否使用 ip 地址注册
        instance-id: ${spring.cloud.client.ip-address}:${server.port} # ip:port
      client:
        # 设置服务注册中心地址，指向另一个注册中心
        service-url:                  # 注册中心对外暴露的注册地址
          defaultZone: http://localhost:8762/eureka/

`eureka-server02` 的 application.yml

server:
      port: 8762 # 端口
    
    spring:
      application:
        name: eureka-server # 应用名称(集群下相同)
    
    # 配置 Eureka Server 注册中心
    eureka:
      instance:
        hostname: eureka02            # 主机名，不配置的时候将根据操作系统的主机名来获取
        prefer-ip-address: true       # 是否使用 ip 地址注册
        instance-id: ${spring.cloud.client.ip-address}:${server.port} # ip:port
      client:
        # 设置服务注册中心地址，指向另一个注册中心
        service-url:                  # 注册中心对外暴露的注册地址
          defaultZone: http://localhost:8761/eureka/

启动类

`eureka-server` 和 `eureka-server02` 启动类核心代码一致。

package com.example;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
    
    @SpringBootApplication
    // 开启 EurekaServer 注解
    @EnableEurekaServer
    public class EurekaServerApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(EurekaServerApplication.class, args);
        }
    
    }

[format_png]: /images/20221123/85adc1931a254828b21f354f236c0225.png
[format_png 1]: https://user-gold-cdn.xitu.io/2020/5/11/1720138430013595?w=726&h=580&f=png&s=48799
[format_png 2]: /images/20221123/ba6f3209776a47eeac4c2cde898a1542.png
[format_png 2 1]: https://user-gold-cdn.xitu.io/2020/5/11/172013843336cd0a?w=372&h=173&f=png&s=6975
[format_png 3]: /images/20221123/a6d7b53c409d44f6a9d1406e2b619d81.png
[format_png 3 1]: https://user-gold-cdn.xitu.io/2020/5/11/172013843562baa8?w=751&h=672&f=png&s=54717
[format_png 4]: /images/20221123/2b726d334e7348edb25a3efd15f817da.png
[format_png 4 1]: https://user-gold-cdn.xitu.io/2020/5/11/1720138435569d10?w=1014&h=298&f=png&s=34768
[Config]: https://video.zhihu.com/video/1243099097307230208
[Config 1]: https://video.zhihu.com/video/1243099218782777344
[format_png 5]: /images/20221123/21f15120857c4c04a5cee7ced43a57db.png
[format_png 5 1]: https://user-gold-cdn.xitu.io/2020/5/11/17201384351a416a?w=312&h=101&f=png&s=5275
[format_png 6]: /images/20221123/34087778a9844d699eec369fb78508d2.png
[format_png 6 1]: https://user-gold-cdn.xitu.io/2020/5/11/1720138437fcfcac?w=310&h=98&f=png&s=5218
[format_png 7]: /images/20221123/d278606abf054c84a8d25c8ec65a384c.png
[format_png 7 1]: https://user-gold-cdn.xitu.io/2020/5/11/1720138461a0c865?w=1012&h=372&f=png&s=41435