SpringCloudConfig 分布式配置

1. 分布式系统面临的配置文件的问题

微服务意味着要将单体应用中的业务拆分成一个个子服务, 每个服务的粒度相对较小，因此系统中会出现大量的服务，由于每个服务都需要必要的配置信息才能运行，所以一套集中式的, 动态的配置管理设施是必不可少的。
SpringCloud提供了ConfigServer来解决这个问题，我们每一个微服务自己带着一个application.yml，那上百的的配置文件要修改起来，岂不是要发疯!
image.png
Spring Cloud Config为微服务架构中的微服务提供集中化的外部配置支持,配置服务器为各个不同微服务应用的所有环节提供了一个中心化的外部配置。
Spring Cloud Config 分为服务端和客户端两部分;
服务端也称为分布式配置中心，它是一个独立的微服务应用，用来连接配置服务器并为客户端提供获取配置信息，加密，解密信息等访问接口。
客户端则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容,并在启动的时候从配置中心获取和加载配置信息。配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理。并且可以通过git客户端工具来方便的管理和访问配置内容。
[

](https://www.springcloud.cc/spring-cloud-greenwich.html#_spring_cloud_config)
SpringCloud Config官网说明

2. SpringCloud Config分布式配置中心能做什么

集中管理配置文件
不同环境，不同配置，动态化的配置更新，分环境部署，比如/dev /test/ /prod /beta /release
运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件,服务会向配置中心统一拉取配置自己的信息。
当配置发生变动时，服务不需要重启，即可感知到配置的变化,并应用新的配置
将配置信息以REST接口的形式暴露
SpringCloud config分布式配置中心与github整合
由于Spring Cloud Config默认使用Git来存储配置文件(也有其他方式，比如支持SVN和本地文件)， 但是最推荐的还是Git，而且使用的是http / https访问的形式;

Config配置服务端环境

1：在个人git中创建相关链接，使用远程git进行对服务控制

image.png

2：创建springcloud-config 控制中心服务

image.png
3：导入相关依赖，修改pom文件

  1. <?xml version="1.0"?>
  2. <project
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"
  4.     xmlns="http://maven.apache.org/POM/4.0.0"
  5.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6.     <modelVersion>4.0.0</modelVersion>
  7.     <parent>
  8.         <groupId>com.junjay</groupId>
  9.         <artifactId>SpringCloud</artifactId>
  10.         <version>0.0.1-SNAPSHOT</version>
  11.     </parent>
  12.     <groupId>com.junjay</groupId>
  13.     <artifactId>springcloud-config-server-3344</artifactId>
  14.     <version>0.0.1-SNAPSHOT</version>
  15.     <name>springcloud-config-server-3344</name>
  16.     <url>http://maven.apache.org</url>
  17.     <properties>
  18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19.     </properties>
  20.     <dependencies>
  21.         <dependency>
  22.             <groupId>junit</groupId>
  23.             <artifactId>junit</artifactId>
  24.             <scope>test</scope>
  25.         </dependency>
  27.         <!-- 消费者只需要实体类+web -->
  29.         <dependency>
  30.             <groupId>com.junjay</groupId>
  31.             <artifactId>springcloud-pai</artifactId>
  32.             <version>0.0.1-SNAPSHOT</version>
  33.         </dependency>
  35.         <dependency>
  36.             <groupId>org.springframework.boot</groupId>
  37.             <artifactId>spring-boot-starter-web</artifactId>
  38.         </dependency>
  40.         <dependency>
  41.             <groupId>org.mybatis.spring.boot</groupId>
  42.             <artifactId>mybatis-spring-boot-starter</artifactId>
  43.         </dependency>
  45.         <!-- 热部署工具 -->
  46.         <dependency>
  47.             <groupId>org.springframework.boot</groupId>
  48.             <artifactId>spring-boot-devtools</artifactId>
  49.         </dependency>
  51.         <!-- 添加负载均衡Ribbon依赖 -->
  52.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-ribbon -->
  53.         <dependency>
  54.             <groupId>org.springframework.cloud</groupId>
  55.             <artifactId>spring-cloud-starter-ribbon</artifactId>
  56.             <version>1.4.6.RELEASE</version>
  57.         </dependency>
  59.         <!-- 加入eureka依赖进行服务注册 -->
  60.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-eureka -->
  61.         <dependency>
  62.             <groupId>org.springframework.cloud</groupId>
  63.             <artifactId>spring-cloud-starter-eureka</artifactId>
  64.             <version>1.4.6.RELEASE</version>
  65.         </dependency>
  67.         <!-- 加入config控制中心 -->
  68.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-config-server -->
  69.         <dependency>
  70.             <groupId>org.springframework.cloud</groupId>
  71.             <artifactId>spring-cloud-config-server</artifactId>
  72.             <version>2.1.1.RELEASE</version>
  73.         </dependency>
  76.     </dependencies>
  77. </project>

3：添加yml配置

  1. server:
  2.   port: 3344
  3. #spring配置
  4. spring:
  5.   application:
  6.     name: springcloud-config-server
  7.   # 链接远程仓库 cloud-config cloud配置
  8.   cloud:
  9.     config:
  10.       # server 服务
  11.       server:
  12.         # 服务选择：svn，git
  13.         git:
  14.           # 是uri不是url，地址是https，不是ssh
  15.           uri: https://github.com/My-Jun/SpringCloud-Netflix-Kss-Config.git

4：编写启动类，开启enable*注解

  1. package org.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.config.server.EnableConfigServer;
  7. @SpringBootApplication
  8. @EnableConfigServer // 开启config服务
  9. public class Config_Server_3344 {
  11.     public static void main(String[] args) {
  12.         SpringApplication.run(Config_Server_3344.class, args);
  13.     }
  15. }

5：启动服务正常

image.png
6：访问启动服务地址+git中文件
http://localhost:3344/application-dev.yml
image.png
springcloud使用git作为config配置中心(解决错误404或者是No such label: master问题)
问题：默认的label为master
Github现在master改为main, 修改 default-label 属性, 否则读不到，修改yml

  1. server:
  2.   port: 3344
  3. #spring配置
  4. spring:
  5.   application:
  6.     name: springcloud-config-server
  7.   # 链接远程仓库 cloud-config cloud配置
  8.   cloud:
  9.     config:
  10.       # server 服务
  11.       server:
  12.         # 服务选择：svn，git
  13.         git:
  14.           # 是uri不是url，地址是https，不是ssh
  15.           uri: https://github.com/My-Jun/SpringCloud-Netflix-Kss-Config.git
  16.           # 默认的label为master
  17.           # Github现在master改为main, 修改 default-label 属性, 否则读不到
  18.           default-label: main

image.pngimage.png
服务的本质并没有做什么，而是通过config-server，可以链接到我们的github上，去访问其中的资源以及配置。

6：HTTP多种方式访问git地址内容
HTTP服务具有以下形式的资源：
application：应用程序，
profile-模式：（dev，test）
label：具体分支

  1. /{application}/{profile}[/{label}]
  2. /{application}-{profile}.yml
  3. /{label}/{application}-{profile}.yml
  4. /{application}-{profile}.properties
  5. /{label}/{application}-{profile}.properties

eg：http://localhost:3344/application/test/
image.png
如果访问yml中没有的内容则
image.png
[

](https://www.springcloud.cc/spring-cloud-config.html)

Config配置客户端环境

1：创建config-client.yml配置文件

image.png

2：创建客服端链接GIT

image.png
3：pom添加相关依赖jar

  1. <?xml version="1.0"?>
  2. <project
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"
  4.     xmlns="http://maven.apache.org/POM/4.0.0"
  5.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6.     <modelVersion>4.0.0</modelVersion>
  7.     <parent>
  8.         <groupId>com.junjay</groupId>
  9.         <artifactId>SpringCloud</artifactId>
  10.         <version>0.0.1-SNAPSHOT</version>
  11.     </parent>
  12.     <groupId>com.junjay</groupId>
  13.     <artifactId>springcloud-config-client-3355</artifactId>
  14.     <version>0.0.1-SNAPSHOT</version>
  15.     <name>springcloud-config-client-3355</name>
  16.     <url>http://maven.apache.org</url>
  17.     <properties>
  18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19.     </properties>
  20.     <dependencies>
  22.         <dependency>
  23.             <groupId>junit</groupId>
  24.             <artifactId>junit</artifactId>
  25.             <scope>test</scope>
  26.         </dependency>
  28.         <!-- 添加config启动jar -->
  29.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-config -->
  30.         <dependency>
  31.             <groupId>org.springframework.cloud</groupId>
  32.             <artifactId>spring-cloud-starter-config</artifactId>
  33.             <version>2.1.1.RELEASE</version>
  34.         </dependency>
  36.         <dependency>
  37.             <groupId>org.springframework.boot</groupId>
  38.             <artifactId>spring-boot-starter-web</artifactId>
  39.         </dependency>
  41.         <dependency>
  42.             <groupId>org.mybatis.spring.boot</groupId>
  43.             <artifactId>mybatis-spring-boot-starter</artifactId>
  44.         </dependency>
  47.     </dependencies>
  48. </project>

3：添加配置文件yml

image.png

  1. # 用户级别配置
  2. #spring配置
  3. spring:
  4.   application:
  5.     name: springcloud-config-client
  1. # 根配置文件，系统级别配置
  2. spring:
  3.   cloud:
  4.     config:
  5.       # 远程想要读取的文件
  6.       name: config-client
  7.       # 拿去服务配置环境dev，test
  8.       profile: dev
  9.       # 拿去哪个分支的代码
  10.       label: main
  11.       uri: http://localhost:3344

4：编写客服端Controller层

  1. package org.springcloud.controller;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. @RestController
  8. public class ConfigController {
  10.     /**
  11.     * 项目名字
  12.     */
  13.     @Value("${spring.application.name}")
  14.     private String application;
  16.     /**
  17.     * eureka服务
  18.     */
  19.     @Value("${eureka.client.service-url.defaultZone}")
  20.     private String eurekaServer;
  22.     /**
  23.     * port服务端口
  24.     */
  25.     @Value("${server.port}")
  26.     private String port;
  28.     /**
  29.     * 获取远程配置内容
  30.     * 
  31.     * @return
  32.     */
  33.     @RequestMapping("/config")
  34.     public String getConfig() {
  35.         String s = "application=%s;eurekaServer=%s;port=%s;";
  36.         return String.format(s, application, eurekaServer, port);
  37.     }
  39. }

5：编写主启动类

  1. package org.springcloud;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
  5. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
  8. @SpringBootApplication
  9. @EnableAutoConfiguration(exclude = { DataSourceAutoConfiguration.class })
  10. public class Config_Server_3355 {
  12.     public static void main(String[] args) {
  13.         SpringApplication.run(Config_Server_3355.class, args);
  14.     }
  16. }

6：启动config服务端

启动服务端正常可以 访问在git中添加的新配置文件，config-client文件
image.png
7：启动客服端访问
image.png
image.png
服务端口已变成远程配置文件中端口

7：进行访问远程git仓库中的信息

http://localhost:8201/config
image.png
image.png

8：修改bootstrap配置文件选择profile其他环境

profile: test
启动服务重现查看
image.png
服务端口已切换为git环境中的test 的port
http://localhost:8202/config
image.png

Config远程配置全yml

Config-eureka-7001远程服务

1：使用远程链接配置文件，配置eureka集群

image.png

2：导入与本地eureka服务相同jar，并添加springcloud-config包

  1. <?xml version="1.0"?>
  2. <project
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"
  4.     xmlns="http://maven.apache.org/POM/4.0.0"
  5.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6.     <modelVersion>4.0.0</modelVersion>
  7.     <parent>
  8.         <groupId>com.junjay</groupId>
  9.         <artifactId>SpringCloud</artifactId>
  10.         <version>0.0.1-SNAPSHOT</version>
  11.     </parent>
  12.     <groupId>com.junjay</groupId>
  13.     <artifactId>springcloud-config-eureka-7001</artifactId>
  14.     <version>0.0.1-SNAPSHOT</version>
  15.     <name>springcloud-config-eureka-7001</name>
  16.     <url>http://maven.apache.org</url>
  17.     <properties>
  18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19.     </properties>
  20.     <dependencies>
  21.         <dependency>
  22.             <groupId>junit</groupId>
  23.             <artifactId>junit</artifactId>
  24.             <scope>test</scope>
  25.         </dependency>
  27.         <!-- 导包eureka -->
  28.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-eureka-server -->
  29.         <dependency>
  30.             <groupId>org.springframework.cloud</groupId>
  31.             <artifactId>spring-cloud-starter-eureka-server</artifactId>
  32.             <version>1.4.6.RELEASE</version>
  33.         </dependency>
  35.         <!-- 热部署工具 -->
  36.         <dependency>
  37.             <groupId>org.springframework.boot</groupId>
  38.             <artifactId>spring-boot-devtools</artifactId>
  39.         </dependency>
  41.         <dependency>
  42.             <groupId>org.mybatis.spring.boot</groupId>
  43.             <artifactId>mybatis-spring-boot-starter</artifactId>
  44.         </dependency>
  46.         <dependency>
  47.             <groupId>org.springframework.boot</groupId>
  48.             <artifactId>spring-boot-starter-web</artifactId>
  49.         </dependency>
  51.         <!-- 添加config启动jar -->
  52.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-config -->
  53.         <dependency>
  54.             <groupId>org.springframework.cloud</groupId>
  55.             <artifactId>spring-cloud-starter-config</artifactId>
  56.             <version>2.1.1.RELEASE</version>
  57.         </dependency>
  60.     </dependencies>
  61. </project>

3：服务原来eureka服务代码至新的config-eureka中
image.png

3：配置yml文件bootstrap.yml、application.yml

bootstrap.yml

  1. # 根配置文件，系统级别配置
  2. spring:
  3.   cloud:
  4.     config:
  5.       # 远程想要读取的文件
  6.       name: config-eureka
  7.       # 拿去服务配置环境dev，test
  8.       profile: test
  9.       # 拿去哪个分支的代码
  10.       label: main
  11.       uri: http://localhost:3344

application.yml

  1. spring:
  2.   application:
  3.     name: springcloud-eureka-7001

4：启动config-eureka服务进行远程访问

image.png

5：首先访问3344开是否可以访问到config-eureka文件

http://localhost:3344/config-eureka-dev.yml
image.png

6：访问eureka中心，通过远程配置文件地址访问

http://localhost:7001/
image.png

Config-provider-dept-8001远程服务

1：新建Config-provider-dept-8001 远程服务

image.png
image.png

2：导入与springcloud-provider-dept-8081项目一样的jar和config-jar

  1. <?xml version="1.0"?>
  2. <project
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"
  4.     xmlns="http://maven.apache.org/POM/4.0.0"
  5.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6.     <modelVersion>4.0.0</modelVersion>
  7.     <parent>
  8.         <groupId>com.junjay</groupId>
  9.         <artifactId>SpringCloud</artifactId>
  10.         <version>0.0.1-SNAPSHOT</version>
  11.     </parent>
  12.     <groupId>com.junjay</groupId>
  13.     <artifactId>springcloud-config-provider-dept-8081</artifactId>
  14.     <version>0.0.1-SNAPSHOT</version>
  15.     <name>springcloud-config-provider-dept-8081</name>
  16.     <url>http://maven.apache.org</url>
  17.     <properties>
  18.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  19.     </properties>
  20.     <dependencies>
  21.         <dependency>
  22.             <groupId>junit</groupId>
  23.             <artifactId>junit</artifactId>
  24.             <scope>test</scope>
  25.         </dependency>
  28.         <!-- 我们需要拿到实体类，所以需要配置api-module -->
  29.         <dependency>
  30.             <groupId>com.junjay</groupId>
  31.             <artifactId>springcloud-pai</artifactId>
  32.             <version>0.0.1-SNAPSHOT</version>
  33.         </dependency>
  35.         <!-- 引用父工程中定义好的jar直接引用无需选择版本，因为在父工程中已经设置 -->
  36.         <dependency>
  37.             <groupId>junit</groupId>
  38.             <artifactId>junit</artifactId>
  39.         </dependency>
  40.         <dependency>
  41.             <groupId>mysql</groupId>
  42.             <artifactId>mysql-connector-java</artifactId>
  43.         </dependency>
  44.         <dependency>
  45.             <groupId>com.alibaba</groupId>
  46.             <artifactId>druid</artifactId>
  47.         </dependency>
  48.         <dependency>
  49.             <groupId>ch.qos.logback</groupId>
  50.             <artifactId>logback-core</artifactId>
  51.         </dependency>
  52.         <dependency>
  53.             <groupId>org.mybatis.spring.boot</groupId>
  54.             <artifactId>mybatis-spring-boot-starter</artifactId>
  55.         </dependency>
  57.         <!-- test -->
  58.         <dependency>
  59.             <groupId>org.springframework.boot</groupId>
  60.             <artifactId>spring-boot-test</artifactId>
  61.         </dependency>
  62.         <!-- web -->
  63.         <dependency>
  64.             <groupId>org.springframework.boot</groupId>
  65.             <artifactId>spring-boot-starter-web</artifactId>
  66.         </dependency>
  68.         <!-- jetty 内置是tomcat 也可以使用jetty -->
  69.         <dependency>
  70.             <groupId>org.springframework.boot</groupId>
  71.             <artifactId>spring-boot-starter-jetty</artifactId>
  72.         </dependency>
  74.         <!-- 热部署工具 -->
  75.         <dependency>
  76.             <groupId>org.springframework.boot</groupId>
  77.             <artifactId>spring-boot-devtools</artifactId>
  78.         </dependency>
  80.         <!-- Failed to configure a DataSource: 'url' attribute is not specified 
  81.             and -->
  82.         <!-- no embedded 的三种解决办法 -->
  83.         <!-- 导致这个问题的原因是因为，在 pom.xml 配置文件中，配置了数据连接技术 spring-boot-starter-jdbc 包 
  84.             ，在启动配置文件时 ，Spring Boot 的自动装配机制就会去配置文件中找，相关的数据库的连接配置信息，如果找不到则抛出异常信息（具体源码就不在这儿分析了，有兴趣的可以自行去查看 -->
  85.         <dependency>
  86.             <groupId>org.springframework.boot</groupId>
  87.             <artifactId>spring-boot-starter-jdbc</artifactId>
  88.         </dependency>
  90.         <!-- 加入eureka依赖进行服务注册 -->
  91.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-eureka -->
  92.         <dependency>
  93.             <groupId>org.springframework.cloud</groupId>
  94.             <artifactId>spring-cloud-starter-eureka</artifactId>
  95.             <version>1.4.6.RELEASE</version>
  96.         </dependency>
  99.         <!-- actuator 完善监控信息 -->
  100.         <dependency>
  101.             <groupId>org.springframework.boot</groupId>
  102.             <artifactId>spring-boot-starter-actuator</artifactId>
  103.         </dependency>
  105.         <dependency>
  106.             <groupId>org.springframework.cloud</groupId>
  107.             <artifactId>spring-cloud-starter-hystrix-dashboard</artifactId>
  108.             <version>1.4.6.RELEASE</version>
  109.         </dependency>
  110.         <dependency>
  111.             <groupId>org.springframework.cloud</groupId>
  112.             <artifactId>spring-cloud-starter-hystrix</artifactId>
  113.             <version>1.4.6.RELEASE</version>
  114.         </dependency>
  116.         <!-- 加入config控制中心 -->
  117.         <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-config-server -->
  118.         <dependency>
  119.             <groupId>org.springframework.cloud</groupId>
  120.             <artifactId>spring-cloud-config-server</artifactId>
  121.         </dependency>
  123.         <dependency>
  124.             <groupId>org.springframework.cloud</groupId>
  125.             <artifactId>spring-cloud-starter-config</artifactId>
  126.             <version>2.1.1.RELEASE</version>
  127.         </dependency>
  129.     </dependencies>
  130. </project>

3：配置yml文件以及复制原8001代码

application.yml

  1. # 用户级别配置
  2. #spring配置
  3. spring:
  4. application:
  5.     name: springcloud-config-eureka-7001

bootstrap.yml

  1. # 根配置文件，系统级别配置
  2. spring:
  3. cloud:
  4. config:
  5. # 远程想要读取的文件
  6. name: config-eureka
  7. # 拿去服务配置环境dev，test
  8. profile: test
  9. # 拿去哪个分支的代码
  10. label: main
  11. uri: http://localhost:3344

image.png

4：启动服务进行访问测试

先测试3344 是否能拿到config-dept文件
image.png
5：通过config-dept 访问服务
http://localhost:8081/dept/queryById/1，因为本地配置的是dev环境所以数据库是db01
image.png
修改bootstrap.yml中的profile: dev 改为test 测试是否 成功访问数据库db02

  1. # 根配置文件，系统级别配置
  2. spring:
  3.   cloud:
  4.     config:
  5.       # 远程想要读取的文件
  6.       name: config-dept
  7.       # 拿去服务配置环境dev，test
  8.       profile: test
  9.       # 拿去哪个分支的代码
  10.       label: main
  11.       uri: http://localhost:3344

重启访问即可