分布式配置中心：Spring Cloud Config

时间  2021-06-02 标签 java git spring bootstrap 浏览器 安全 网络 架构 app ide

构建配置中心

  • 建立一个基础Spring Boot工程，命名为config-server，并在pom.xml中引入如下依赖：
<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
  • 在程序主类中添加@EnableConfigServer注解
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConfigServerApplication.class, args);
    }
}
  • 在application.properties文件中添加配置服务的基本信息和git仓库的相关信息
spring.application.name=config-server
server.port=7001
#git路径，精确到具体仓库位置
spring.cloud.config.server.git.uri=https://gitee.com/dongspace/config-file/
#git uri下的相对搜索位置，能够配置多个，以","分隔
spring.cloud.config.server.git.search-paths=config-client,demo
spring.cloud.config.server.git.username=***
spring.cloud.config.server.git.password=***

Git配置仓库

  • 新建一个仓库，命名为config-file
  • 新建两个文件夹，分别命名为config-client和demo

  • 在config-client下新建配置文件application.properties、application-stg1.properties，并添加以下配置java

    from=master
#stg1中的配置
from=master-stg1

  • 在demo文件夹下新建dongspace.properties、dongspace-stg1.properties，并添加以下配置git

    from=dong-master
#stg1中的配置
from=dong-master-stg1

配置规则详解

配置信息的URL与配置文件的映射关系以下：spring

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

上面的URL对应{application}-{profile}.properties，其中{application}对应配置文件名，{label}对应代码分支，默认为default
以上经过浏览器访问的路径对应为：bootstrap

客户端配置

  • 建立一个基础Spring Boot工程，命名为config-client，并在pom.xml中引入如下依赖：
<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
  • 在bootstrap.properties中加入如下配置：
server.port=7002
spring.application.name=config-client
spring.cloud.config.profile=stg1
spring.cloud.config.label=master
spring.cloud.config.uri=http://localhost:7001/
  • 建立一个测试类
@RestController
public class TestConfigController {

    @Value("${from}")
    private String from;
    
    @RequestMapping("/testConfig")
    public Object testConfig() {
        return from;
    }
}

服务端的占位符配置

实现多个服务对应一个仓库中的不一样目录浏览器

spring.cloud.config.server.git.uri=https://gitee.com/dongspace/config-file/
#{application}对应访问服务的应用名
spring.cloud.config.server.git.search-paths={application}

实现一个服务对应目录下的一个仓库安全

spring.cloud.config.server.git.uri=https://gitee.com/dongspace/{application}-conf

基础架构

config-server架构图

客户端应用从config-server中获取配置信息听从下面的执行流程：网络

  1. 应用启动时，根据bootstrap.properties中配置的{application}、{profile}、{label}，向Config Server请求获取配置信息。
  2. Config Server根据本身维护的Git仓库信息和客户端传递过来的配置定位信息去查找配置信息。
  3. 经过git clone命令将找到的配置信息下载到Config Server的文件系统中。
  4. Config Server建立Spring的ApplicationContext实例，并从Git本地仓库中加载配置文件，返回给客户端使用。
  5. 客户端应用得到外部配置信息后，加载到客户端的ApplicationContext实例。该配置内容的优先级高于Jar包内部的配置内容，在jar包中重复的内容将不会被加载。

健康监测

当使用占位符配置URI时，Config Server会默认加载application为app的仓库，根据以前的配置规则，服务端的健康检测器会不断检查https://gitee.com/dongspace/a... 仓库是否能够连通，这时访问配置中心的/health端点时返回的服务状态为"DOWN"，当服务化配置中心时，将影响它的可用性判断，此时有两种解决方案：1.建立名为app-config的仓库；2.改变健康监测的配置以下架构

spring.cloud.config.server.health.repositories.check.name=app2
spring.cloud.config.server.health.repositories.check.label=master
spring.cloud.config.server.health.repositories.check.profiles=default

服务化配置中心

config-server改造

在pom.xml文件中添加eureka依赖，以加入Eureka的服务治理体系。app

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

在入口类上添加@EnableDiscoveryClient注解,表示这是一个Eureka客户端。ide

@SpringBootApplication
@EnableConfigServer
@EnableDiscoveryClient
public class ConfigServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(ConfigServerApplication.class, args);
    }
}

在application.properties中配置eureka注册中心地址。

spring.application.name=config-server
server.port=7001
eureka.client.service-url.defaultZone=http://localhost:1111/eureka/

#spring.cloud.config.server.git.uri=https://gitee.com/dongspace/{application}-conf
spring.cloud.config.server.git.uri=https://gitee.com/dongspace/config-file/
#git uri下的相对搜索位置，能够配置多个
spring.cloud.config.server.git.search-paths={application}
spring.cloud.config.server.git.username=416974870@qq.com
spring.cloud.config.server.git.password=a1991122911
# 从新设定git仓库链接性检测的地址，需新建命名为app2的仓库
#spring.cloud.config.server.health.repositories.check.name=app2
#spring.cloud.config.server.health.repositories.check.label=master
#spring.cloud.config.server.health.repositories.check.profiles=default

config-client改造

前两步同config-server的改造，最后修改bootstrap.properties配置文件

server.port=7002
spring.application.name=config-client

eureka.client.service-url.defaultZone=http://localhost:1111/eureka/
spring.cloud.config.profile=stg1
spring.cloud.config.label=master
# 开启经过服务名来访问配置中心
spring.cloud.config.discovery.enabled=true
# 配置中心服务名为config-server
spring.cloud.config.discovery.service-id=config-server
#spring.cloud.config.uri=http://localhost:7001/

测试

分别启动eureka-server、config-server、config-client，访问http://localhost:1111，能够看到两个应用已经成功注册：

图片描述

测试config-client的/testConfig接口，结果以下：

图片描述

失败快速响应

config-client在启动时，若是访问不到config-server会报错，若是不作任务额外配置，客户端的响应较慢，在报错时已经打印出不少日志。
添加以下配置，可让客户端在启动时优先检查配置中心的链接状况：

spring.cloud.config.fail-fast=true

重试机制

config-client启动没法链接配置中心时，咱们但愿客户端能重试链接几回，这样能够避免因网络抖动而致使应用没法启动的状况。
首先确保客户端的快速响应机制打开，再添加以下重试配置：

# 配置重试次数，默认为6
spring.cloud.config.retry.max-attempts=6
# 间隔乘数，默认1.1，如第一次间隔为1000ms，则第二次间隔为1100ms
spring.cloud.config.retry.multiplier=1.1
# 初始重试间隔时间，默认1000ms
spring.cloud.config.retry.initial-interval=1000
# 最大间隔时间，默认2000ms
spring.cloud.config.retry.max-interval=2000

动态刷新配置

其余配置

安全保护

在Config Server中引入Spring Security便可实现配置中心的密码访问。
首先在pom.xml文件中添加依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

而后在application.properties中配置用户名密码：

security.user.name=admin
security.user.password=admin

最后在配置中心客户端配置用户名和密码:

security.user.name=admin
security.user.password=admin

加密与解密

出现的问题

1、初始提交码云时报push to origin/master was rejected错误

解决方案以下：

1.切换到本身项目所在的目录，右键选择GIT BASH Here，Idea中可以使用Alt+F12

2.在terminl窗口中依次输入命令：

git pull

git pull origin master

git pull origin master --allow-unrelated-histories

3.在idea中从新push本身的项目，成功！！！

参考资料

1.《Spring Cloud微服务实战》

联系我们 沪ICP备2021010478号-7