22、SpringCloud ConfigServer配置中心

程序员文章站 2022-07-03 21:03:19

...

概述

使用Spring Cloud开发微服务时，ConfigServer是常用的组件，它的作用是将Spring相关的配置项统一起来，其他微服务可以根据实际需要从ConfigServer fetch配置。配置服务器为各应用的所有环境提供了一个中心化的外部配置。它实现了对服务端和客户端对Spring Environment和PropertySource抽象的映射，所以它除了适用于Spring构建的应用程序，也可以在任何其他语言运行的应用程序中使用。作为一个应用可以通过部署管道来进行测试或者投入生产，我们可以分别为这些环境创建配置，并且在需要迁移环境的时候获取对应环境的配置来运行。

配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。当然他也提供本地化文件系统的存储方式，下面从这两方面介绍如何使用分布式配置来存储微服务应用多环境的配置内容。

本文内容：

1. 部署ConfigServer（配置文件使用native存放而不是git仓库）

2. 如何覆盖ConfigServer中的配置项

构建ConfigServer

通过Spring Cloud构建一个Config Server，非常简单，只需要三步

（1） pom.xml中引入 spring-cloud-config-server 依赖

<dependency>

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

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

</dependency>

（2）创建Spring Boot的程序主类，并添加 @EnableConfigServer 注解，开启Config Server

@EnableConfigServer

@SpringBootApplication

public class Application {

    public static void main(String[] args) {

        new SpringApplicationBuilder(Application.class).web(true).run(args);

    }

}

（3） application.properties 中配置服务信息以及git信息

服务配置

spring.application.name=config-server

server.port=7001

GIT配置：

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

spring.cloud.config.server.git.searchPaths=Chapter9-1-4/config-repo 

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

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

说明：

spring.cloud.config.server.git.uri：配置git仓库位置

spring.cloud.config.server.git.searchPaths：配置仓库路径下的相对搜索位置，可以配置多个

spring.cloud.config.server.git.username：访问git仓库的用户名

spring.cloud.config.server.git.password：访问git仓库的用户密码

为了验证上面完成的配置服务器，在 http://git.oschina.net/didispace/SpringBoot-Learning/Chapter9-1-4/ 下创建了一个config-repo目录作为配置仓库，并根据不同环境新建了下面四个配置文件：

didispace.properties

didispace-dev.properties

didispace-test.properties

didispace-prod.properties

其中设置了一个from属性，为每个配置文件分别设置了不同的值，如：

from=git-default-1.0

from=git-dev-1.0

from=git-test-1.0

from=git-prod-1.0

为了测试版本控制，在master中，我们都加入1.0的后缀，同时创建一个config-label-test分支，并将各配置文件中的值用2.0作为后缀。

完成了这些准备工作之后，我们就可以通过浏览器或POSTMAN等工具直接来访问到我们的配置内容了。

URL与配置文件的映射关系如下：

/{application}/{profile}[/{label}]

/{application}-{profile}.yml

/{label}/{application}-{profile}.yml

/{application}-{profile}.properties

/{label}/{application}-{profile}.properties

上面的url会映射 {application}-{profile}.properties 对应的配置文件， {label} 对应git上不同的分支，默认为master。

我们可以尝试构造不同的url来访问不同的配置内容，比如：要访问config-label-test分支，didispace应用的prod环境，可以通过这个url： http://localhost:7001/didispace/prod/config-label-test

本地配置：

server.port=8888 #使用本地的配置文件

spring.profiles.active=native

上述的配置很简单，直接使用native 来存放配置文件，Config Server会默认从应用的 src/main/resource 目录下检索配置文件，也可以通过 spring.cloud.config.server.native.searchLocations=file:F:/properties/ 属性来指定配置文件的位置。虽然Spring Cloud Config提供了这样的功能，但是为了支持更好的管理内容和版本控制的功能，还是推荐使用git的方式。

到这里，使用一个通过Spring Cloud Config实现，并使用git管理内容的配置中心已经完成了，启动该应用，成功后开始下面的内容。

{ 

“name”: “didispace”, 

“profiles”: [ 

“prod” 

], 

“label”: “config-label-test”, 

“version”: “19de8a25575a7054a34230f74a22aa7f5575a9d1”, 

“propertySources”: [ 

{ 

“name”: “http://git.oschina.net/didispace/SpringBoot-Learning/Chapter9-1-4/config-repo/didispace-prod.properties“, 

“source”: { 

“from”: “git-prod-2.0” 

} 

}, 

{ 

“name”: “http://git.oschina.net/didispace/SpringBoot-Learning/Chapter9-1-4/config-repo/didispace.properties“, 

“source”: { 

“from”: “git-default-2.0” 

} 

} 

] 

}

使用ConfigServer

（1）在pom.xml中引入spring-cloud-starter-config依赖

<dependency>

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

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

</dependency>

（2）创建最基本的Spring Boot启动主类

@SpringBootApplication

public class Application {

    public static void main(String[] args) {

        new SpringApplicationBuilder(Application.class).web(true).run(args);

    }

}

（3）创建 bootstrap.properties 配置，来指定config server

server.port=7002

spring.application.name=didispace

spring.cloud.config.profile=dev

spring.cloud.config.label=master

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

说明：

spring.application.name：对应前配置文件中的{application}部分 

spring.cloud.config.profile：对应前配置文件中的{profile}部分 

spring.cloud.config.label：对应前配置文件的git分支 

spring.cloud.config.uri：配置中心的地址

这里需要格外注意：上面这些属性必须配置在 bootstrap.properties 中，config部分内容才能被正确加载。因为config的相关配置会先于 application.properties ，而 bootstrap.properties 的加载也是先于 application.properties 。

（4）强制刷新

@RefreshScope

@RestController         // 如果代码中需要动态刷新配置，在需要的类上加上该注解就行

class TestController {

    @Value("${from}")

    private String from;



    @RequestMapping("/from")

    public String from() {



        return this.from;

    }

}

需到此配置中心配置基本

代码实例

父项目pom.xml配置：

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <!-- 项目基本信息 -->

  <modelVersion>4.0.0</modelVersion>

  <groupId>com.easystudy</groupId>

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

  <version>0.0.1-SNAPSHOT</version>

  <packaging>pom</packaging>

  <name>配置中心实例父项目</name>

  <description>为配置中心其他组件提供基础的依赖和包管理</description>



  <!-- 包含模块 -->

  <modules>

     <module>spring-config-server-native</module>

     <module>spring-config-server-client</module>

     <module>spring-config-server-git</module>

  </modules>



  <!-- 项目属性 -->

  <properties>

      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

      <java.version>1.8</java.version>

      <spring-cloud.version>Finchley.BUILD-SNAPSHOT</spring-cloud.version>

  </properties>



  <!-- spring boot项目 -->

  <parent>

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

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

      <version>2.0.2.RELEASE</version>

      <relativePath/> <!-- lookup parent from repository -->

  </parent>



  <!-- 项目依赖管理声明，统一管理项目依赖的版本信息，继承项目无需声明版本 -->

  <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>



  <!-- 远程仓库：*仓库找不到时候，从远程仓库中查找 -->

  <repositories>

      <repository>

          <id>spring-snapshots</id>

          <name>Spring Snapshots</name>

          <url>https://repo.spring.io/snapshot</url>

          <snapshots>

              <enabled>true</enabled>

          </snapshots>

      </repository>

      <repository>

          <id>spring-milestones</id>

          <name>Spring Milestones</name>

          <url>https://repo.spring.io/milestone</url>

          <snapshots>

              <enabled>false</enabled>

          </snapshots>

      </repository>

  </repositories>



  <!-- 项目依赖 -->

  <dependencies>

     <!-- spring boot web依赖 -->

     <dependency>

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

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

     </dependency>

     <!--spring boot测试-->

     <dependency>

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

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

          <scope>test</scope>

     </dependency>

     <!-- 监控系统健康情况的工具 -->

     <dependency>

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

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

     </dependency>

     <!-- 修改自动检测加载工具 -->

    <dependency>

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

          <artifactId>spring-boot-devtools</artifactId>

          <optional>true</optional>

     </dependency>

     <!-- RESTFul接口文档：通过接口访问文档：http://localhost:8762/swagger-ui.html，8762为服务配置的监听端口，默认8080-->

     <dependency>

          <groupId>io.springfox</groupId>

          <artifactId>springfox-swagger2</artifactId>

          <version>2.2.2</version>

     </dependency>

     <dependency>

          <groupId>io.springfox</groupId>

          <artifactId>springfox-swagger-ui</artifactId>

          <version>2.2.2</version>

     </dependency>

     <!--Lombok：消除模板代码-->

     <dependency>

          <groupId>org.projectlombok</groupId>

          <artifactId>lombok</artifactId>

     </dependency>

     <!-- @slf4j:log4j -->

     <dependency>

        <groupId>log4j</groupId>

        <artifactId>log4j</artifactId>

        <version>1.2.17</version>

    </dependency>

  </dependencies>

     

  <!-- 编译插件 -->

  <build>

      <plugins>

            <!-- SpringBoot编译插件 -->

          <plugin>

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

              <artifactId>spring-boot-maven-plugin</artifactId>

          </plugin>

      </plugins>

  </build>



</project>

提供了可继承的公共属性、依赖版本管理、共同的依赖以及编译管理；

（1）ConfigServer配置中心服务器

本地存储

a、pom.xml配置

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <!-- 项目基本信息 -->

  <modelVersion>4.0.0</modelVersion>

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

  <name>本地化存储配置中心</name>

  <description>本地化存储配置中心</description>



  <!-- 父项目信息 -->

  <parent>

    <groupId>com.easystudy</groupId>

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

    <version>0.0.1-SNAPSHOT</version>

  </parent>



  <!-- 项目依赖 -->

  <dependencies>

     <!-- 配置中心服务器 -->

     <dependency>

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

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

    </dependency>

  </dependencies>



</project>

重点是该项目依赖了spring-cloud-config-server包；

b、application.yml配置

#服务配置

server:

  #监听端口

  port: 7000

  #服务名称

  application:

    name: config-server

   

#spring配置

spring:

  profiles:

    #使用本地配置文件存储方式-默认就在resources目录下查找对应配置，当然可以通过如下配置修改

    active: native

  #cloud配置

  cloud:

    config:

      server:

        native:

          #search-locations: file:F:/properties/

          #在resource目录下创建config目录,配置clientA-dev.yml,clientA-test.yml等

          #search-locations: classpath:/config

指定了使用本地文件存储：spring.profiles.active: native

在resources目录建立如下三个文件

文件lixx-dev.yml内容：

#服务配置

server:

  #监听端口

  port: 7001

  #服务名称

  application:

    name: config-server-client-dev-new

文件lixx-prod.yml内容：

#服务配置

server:

#监听端口

port: 7002

#服务名称

application:

文件lixx-test.yml内容：

#服务配置

server:

#监听端口

port: 7003

#服务名称

application:

GIT存储

在码云上建立仓库：https://gitee.com/，我的地址是：https://gitee.com/sand_in_the_shell/config-server 标签名：master即主干，搜索路径是：blob/，也就是完整路径是：https://gitee.com/sand_in_the_shell/config-server/tree/master

所有application.yml配置如下：

#服务配置

server:

#监听端口

port: 7000

#服务名称

application:

#spring配置

spring:

#cloud配置

cloud:

#配置中心

config:

#服务器配置

server:

#git配置

git:

#项目地址

uri:https://gitee.com/sand_in_the_shell/config-server

#项目文件夹地址

searchPaths: blob/

#标签/{label}/{application}-{profile}.yml

label: master

#以上连路径：可以blob/master 或者 searchPaths=blob/且label=master都可以

#用户名

username:[email protected]

#密码

password: 此处请填写自己用户名

注意：里面的地址根据自己的实际情况填写！

启动入口：

package com.easystudy;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

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



@SpringBootApplication

@EnableConfigServer                // 开启配置中心服务

public class ConfigServerGitApplication {



    public static void main(String[] args) {

        // TODO Auto-generated method stub

        SpringApplication.run(ConfigServerGitApplication.class, args);

    }



}

（2）客户端配置

a、系统pom.xml配置

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <!-- 项目信息 -->

  <modelVersion>4.0.0</modelVersion>

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

  <name>配置中心客户端</name>

  <description>如何使用配置中心文件</description>



  <!-- 父项目 -->

  <parent>

    <groupId>com.easystudy</groupId>

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

    <version>0.0.1-SNAPSHOT</version>

  </parent>



  <!-- 项目依赖 -->

  <dependencies>

     <!-- 中心配置client -->

     <dependency>

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

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

     </dependency>

  </dependencies>



</project>

b、系统配置文件配置

application.yml 文件配置：

spring:

application:

bootstrap.yml 文件配置(必须配置在bootstrap.yml中，因为比application.yml先加载，否则出错，原因见上所说）：

spring:

#配置中心配置-使用配置中心配置

cloud:

config:

#配置中心地址

uri:http://localhost:7000/

#对应前配置文件中的{application}部分

#对应前配置文件中的{profile}部分,最后定向到文件：lixx-dev.[properties|yml]

profile: dev

c、系统控制层

package com.easystudy.controller;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.cloud.context.config.annotation.RefreshScope;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;



@RestController

@RefreshScope

public class HelloController {

    @Value("${server.application.name}")

    private String applicationName;

    

    @RequestMapping("/hello")

    public String hello(){

        System.out.println("当前服务名：" + applicationName);

        return applicationName;

    }

}

请注意：refrshScope的作用：这里面的属性有可能会更新的，git中的配置中心变化的话就要刷新，没有这个注解内，配置就不能及时更新

d、系统入口

package com.easystudy;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication

public class ConfigServerClientApplication {



    public static void main(String[] args) {

        SpringApplication.run(ConfigServerClientApplication.class, args);

    }

}

启动configServe（native或git都可以），启动客户端：访问地址：http://localhost:7001/hello 即可显示spring.name名称；

特别说明

为了演示refreshScope的作用，我们做如下操作：

（1）我们更新git里面的值spring.name

（2）在用postman去请求客户端的/refresh接口，动态去刷新配置（localhost:7001/refresh），为节省时间，我下面盗用一张图（仅仅做展示，不是本项目真实截图）

22、SpringCloud ConfigServer配置中心

（3）再次请求http://localhost:7001/hello，我们会发现请求的名称发生了变化

评价：

虽然服务没有重启，但是我们要一个服务一个服务的发送post请求，我们能受的了吗？这比之前的没配置中心好多了，那么我们如何继续避免挨个挨个的向服务发送Post请求来告知服务，你的配置信息改变了，需要及时修改内存中的配置信息。

这时候我们就不要忘记消息队列的发布订阅模型。让所有为服务来订阅这个事件，当这个事件发生改变了，就可以通知所有微服务去更新它们的内存中的配置信息。这时Bus消息总线就能解决，这留到下一篇随笔讲解

配置中心实例：

#服务器配置

server:

  port: 7000

  servlet:

    context-path: /config

#环境生效配置

spring:

  application:

    name: config

  #配置加载环境：native、subversion、git

  profiles:

    active: subversion

---

#开发环境

spring:

  profiles: native

#注册中心       

eureka:

  instance:

    prefer-ip-address: true

    registry-fetch-interval-seconds: 30

    lease-renewal-interval-in-seconds: 10

    lease-expiration-duration-in-seconds: 30

  client:

      service-url:

        defaultZone: http://127.0.0.1:7002/eureka/,http://127.0.0.1:7003/eureka/

---

#生产环境

spring:

  profiles: subversion

  #cloud配置

  cloud:

    #配置中心

    config:

      #服务器配置

      server:

        #snv配置

        svn:

          #项目地址,svn为host名:svn://192.168.12.130/svnrepos

          uri:svn://svn.dondown.com/Config/

          #想分环境来读取配置文件,使用{application}占位符,否则不识别文件夹

          #用来根据客户端的spring.application.name来动态搜索配置目录

          #search-paths: "{application}"

          #search-paths: test

          #如search-paths为test，在http://192.168.8.18:201/svn/Config/下有一个文件夹test

          #里面的label必须一test-name.yml命名，前缀test（与文件夹相同）表示环境类型，如prod,test

          #标签

          default-label: ""

          #用户名

          username: admin

          #密码

          password: dw123456

#注册中心       

eureka:

  instance:

    prefer-ip-address: true

    registry-fetch-interval-seconds: 30

    lease-renewal-interval-in-seconds: 10

    lease-expiration-duration-in-seconds: 30

  client:

      service-url:

        defaultZone:http://eureka1:7002/eureka/,http://eureka2:7003/eureka/

---

#互联网环境

spring:

  profiles: git

  #cloud配置

  cloud:

    #配置中心

    config:

      #服务器配置

      server:

        #git配置

        git:

          #项目地址

          uri:https://gitee.com/sand_in_the_shell/config

          #项目文件夹地址[点击查看某文件后，浏览器多出的部分]

          searchPaths: blob/

          #标签/{label}/{application}-{profile}.yml

          #以上连路径：可以blob/master 或者 searchPaths=blob/且label=master都可以

          label: master

          #用户名

          username: admin

          #密码[不能出现特殊字符-密码修改无特殊字符密码]

          password: dw123456

#注册中心       

eureka:

  instance:

    prefer-ip-address: true

    registry-fetch-interval-seconds: 30

    lease-renewal-interval-in-seconds: 10

    lease-expiration-duration-in-seconds: 30

  client:

      service-url:

        defaultZone: ${ADDITIONAL_EUREKA_SERVER}

eclipse配置：

22、SpringCloud ConfigServer配置中心

上一篇： xlwings：操作Excel，通过宏调用Pyhton（VBA调Python）

下一篇：蓝桥杯之01字符串

22、SpringCloud ConfigServer配置中心

概述

跟我学SpringCloud | 第六篇：Spring Cloud Config Github配置中心

springcloud学习之路: (五) springcloud集成SpringCloudConfig分布式配置中心

Nacos（四）：SpringCloud项目中接入Nacos作为配置中心

SpringCloud之分布式配置中心Spring Cloud Config高可用配置实例代码

Springcloud 2.x 版本分布式配置中心

跟我学SpringCloud | 第七篇：Spring Cloud Config 配置中心高可用和refresh

SpringCloud学习系列之五-----配置中心(Config)和消息总线(Bus)完美使用版

SpringCloud学习笔记(7)：使用Spring Cloud Config配置中心

SpringCloud实战（六）-高可用的分布式配置中心(Spring Cloud Config)

Springcloud结合zookeeper配置中心

22、SpringCloud ConfigServer配置中心

概述

跟我学SpringCloud | 第六篇：Spring Cloud Config Github配置中心

springcloud学习之路: (五) springcloud集成SpringCloudConfig分布式配置中心

Nacos（四）：SpringCloud项目中接入Nacos作为配置中心

SpringCloud之分布式配置中心Spring Cloud Config高可用配置实例代码

Springcloud 2.x 版本 分布式配置中心

跟我学SpringCloud | 第七篇：Spring Cloud Config 配置中心高可用和refresh

SpringCloud学习系列之五-----配置中心(Config)和消息总线(Bus)完美使用版

SpringCloud学习笔记(7)：使用Spring Cloud Config配置中心

SpringCloud实战（六）-高可用的分布式配置中心(Spring Cloud Config)

Springcloud结合zookeeper配置中心

Springcloud 2.x 版本分布式配置中心