config 简介

前言

配置文件大家都很熟悉，比如之前spring mvc框架中的properties文件，在配置文件中配置数据库、redis、支付等相关配置，或者自定义属性配置等，如：

my.name = 黎明
my.sex = 1
my.age = 40

说明

• demo github地址

config server也是一样，就是一个配置相关服务，可以从本地读取配置文件，也可以从github仓库读取。

• 本地仓库是指将所有的配置文件统一配置在config server 工程目录下，再暴露http api接口,config client 通过调用config server的http API接口来读取配置文件
• config server 需要引入 spring-cloud-config-server依赖，并且在需要在启动类添加@EnableConfigServer注解，表示开启config server功能；config client端需要引入 spring-cloud-starter-config依赖

1 config server从本地读取配置文件DEMO

本章节不在之前的eureka-master工程中进行配置，重新新建一个工程

1.1 主要文件如下图：

• springcloud-config project
• config-server module 即config server配置服务端
• config-client module 即 config client 客户端
• bootstrap.yml 相对于application.yml优先执行，在config章节中起到关键作用，如果吧配置都写在application.yml文件中，获取不到config server中的配置，启动报错
• config-server服务中的config-client-dev.yml即是config-client的配置文件，{项目名}-{xx}即bootstrap文件中变量{spring.application.name}和变量{spring.profiles.active}，两者用“-”相连
  

springcloud-config的pomxml

• springboot版本是2.0.4，cloud对应Finchley.SR3
• 如果springboot是1.5.x，spring cloud是Dalston.RELEASE，对应很多配置不一样

<?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.qgg</groupId>
<artifactId>springcloud-config</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>config-server</module>
<module>config-client</module>
</modules>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.4.RELEASE</version>
<!--<version>1.5.2.RELEASE</version>-->
<relativePath/>
</parent>
<properties>
<spring-could.version>Finchley.SR3</spring-could.version>
<!--<spring-could.version>Dalston.SR1</spring-could.version>-->
<java.version>1.8</java.version>
<p.version>1.4.3.RELEASE</p.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-could.version}</version>
<type>pom</type>
<scope>import</scope>
<!-- 开启import，子项目可以继承父项目中的依赖版本-->
</dependency>
</dependencies>
</dependencyManagement>
</project>

1.2 config-server服务

pom.xml

• 引入 spring-cloud-config-server依赖 configServer

<?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">
<parent>
<artifactId>springcloud-config</artifactId>
<groupId>com.qgg</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>config-server</artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
<!--<version>${p.version}</version>-->
</dependency>
</dependencies>
</project>

application.yml

# 读取本地配置文件demo---------------------------------------
# 读取本地配置文件demo---------------------------------------
spring:
application:
name: config-server # 服务名称
profiles:
active: native # 配置config server从本地读取配置
cloud:
config:
server:
native:
search-locations: classpath:/shared # 读取配置的路径为classpath下的shared目录
server:
port: 8769
#服务端口

config-client-dev.yml

• config-client-dev.yml文件对应 {客户端项目名}-{xx}，即bootstrap文件中变量{spring.application.name}和变量{spring.profiles.active}，两者用“-”相连（这里dev是开发环境）

server:
port: 8763
# config-client服务需要读取的端口
qia: 测试-version 1
# 测试的属性以及值

启动类

@SpringBootApplication
@EnableConfigServer
// 开启config server的功能
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}

1.3 config-client服务

pom.xml

• spring-cloud-starter-config 是configClient依赖

<?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">
<parent>
<artifactId>springcloud-config</artifactId>
<groupId>com.qgg</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>config-client</artifactId>
<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>
</dependencies>
</project>

bootstrap.yml

# bootstrap.yml 在application.yml之前加载
spring:
cloud:
config:
uri: http://localhost:8769 # 想Url地址为http://localhost:8769的 Config Server读取配置文件
fail-fast: true # 如果没有读取成功，则快速失败
profiles:
active: dev

application.xml

# bootstrap.yml 在application.yml之前加载
spring:
application:
name: config-client # 服务名，一定需要
server:
port: 8762 # 这里配置只是为了对比，可以把此端口号配置去掉

controller类

@RestController
//@RefreshScope // 只有添加了该注释，才会在不重启的服务的情况下更新配置
public class ConfigClientController {
@Value("${qia}")
private String value;
@GetMapping("/getName/{name}")
public String getName(@PathVariable String name) {
return name+"---"+value;
}
}

启动类

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

1.4 结果

• 1、先启动config-server
• 2、启动config-client,在控制台看到打印的端口是config-server服务中config-client-dev.yml配置文件的端口表示读取配置文件成功
• 3、在浏览器访问 http://localhost:8763/getName/恰，得到如下图，表示成功
  

2 config server从github仓库读取配置文件DEMO

• 这个demo在1的基础上进行修改，只修改config-server服务的application.yml配置文件
• 通过github仓库好处就是同意配置管理，并且可以通过spring cloud bus在不用人工重启程序进行刷新 Config Client客户端配置
• 首先将config-client-dev.yml配置文件上传github指定仓库的配置文件中，如下图
  

application.yml

# 读取本地配置文件demo---------------------------------------
#spring:
#
application:
#
name: config-server # 服务名称
#
profiles:
#
active: native # 配置config server从本地读取配置
#
cloud:
#
config:
#
server:
#
native:
#
search-locations: classpath:/shared # 读取配置的路径为classpath下的shared目录
#server:
#
port: 8769
#服务端口
# 从远程GIT仓库读取配置文件demo-----------------------------
server:
port: 8769
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://github.com/qiaziliping/qz_document.git # uri是远程git仓库地址
search-paths: config
# serach-path是仓库文件夹地址
username: 597721793@qq.com # github用户名，公开的仓库也要有password这个属性，值为空即可
password:
default-label: main #分支名称

1.4 结果

• 1、先启动config-server
• 2、在浏览器访问 http://localhost:8763/getName/恰，得到如下图，表示成功
  

3 构建高可用的config server（DEMO）

• 在 demo 2的基础上进行重构
• 当服务实例很多时，所有的服务实例需要同时从配置中心Config Server读取配置文件，这是可以考虑将配置中心Config Server做成一个微服务，并且将其集群，从而达到高可用
• Config Server和Config Client 想Eureka Server注册，且将Config Server多实例集群部署；如下图
  

3.1 构建Eureka Server

• 在springboot-config基础上新建module，eurek-server

3.3.1 pom.xml

• 引入 spring-cloud-starter-netflix-eureka-server，不要使用老版本spring-cloud-starter-eureka-server

<?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">
<parent>
<artifactId>springcloud-config</artifactId>
<groupId>com.qgg</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>eureka-server</artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
</dependencies>
</project>

3.1.2 application.yml

spring:
application:
name: eureka-server
#Eureka Server 服务名称
server:
port: 8761
eureka:
client:
register-with-eureka: false
# 不自己注册自己
fetch-registry: false
# 不自己注册自己
service-url:
defaultZone: http://localhost:${server.port}/eureka/
# eureka server注册地址
server:
enable-self-preservation: false
# 关闭自我保护机制，生产环境一般配置为true

3.1.3 启动文件

• @EnableEurekaServer 开启 eureka Server功能

@SpringBootApplication
@EnableEurekaServer
// 开启 eureka Server功能
public class EurekaServerApplication {
public static void main(String[] args) {
SpringApplication.run(EurekaServerApplication.class, args);
}
}

3.2 改造config-server服务

• 在pom.xml添加 spring-cloud-starter-netflix-eureka-client
• eureka客户端注册地址，在application.yml文件中添加如下

eureka:
client:
service-url:
DEFAULT_URL: http://localhost:8761/eureka/

• 在启动文件添加@EnableEurekaClient,标注服务是一个eureka客户端

3.3 改造config-client服务

• 在pom.xml添加 spring-cloud-starter-netflix-eureka-client
• 在启动文件添加@EnableEurekaClient,标注服务是一个eureka客户端
• eureka客户端注册地址，在application.yml文件中添加如下

eureka:
client:
service-url:
DEFAULT_URL: http://localhost:8761/eureka/

• 修改bootstrap.yml文件，添加配置服务发现,通过service-id获取config-server的实例

# bootstrap.yml 在application.yml之前加载
#spring:
#
cloud:
#
config:
#
uri: http://localhost:8769 # 向Url地址为http://localhost:8769的 Config Server读取配置文件
#
fail-fast: true # 如果没有读取成功，则快速失败
#
profiles:
#
active: dev
# -- 在构建高可用config server的demo中用到
spring:
cloud:
config:
fail-fast: true
# 如果没有读取成功，则快速失败
discovery:
# 配置服务发现
enabled: true
service-id: config-server
# 向service-id为config-server的配置服务读取配置文件
profiles:
active: dev
# 读取配置开发环境dev的文件

3.4 结果

• 一次启动eureka-server;启动config-server 8769,和config-server 8768两个服务；在多次启动config-client服务，控制台会轮流出现获取不同的config server端口,说明会获取不同的配置服务
  
  第二次启动config-client
  

4 使用SpringCloud Bus刷新配置（DEMO）

• Spring Cloud Bus 是用轻量级的消息代理将分布式的节点连接起来，可以用于广播配置文件的更改或者服务的监控管理；核心思想就是消息总线可以为微服务做监控，也可以实现应用程序之间互相通信

• Spring Cloud Bus 可选的消息代理组件有RabbitMQ，AMQP和kafka等；此demo使用rabbitmq作为消息代理

• 当微服务有几十个时，修改了配置，每个都要重启，非常麻烦，使用cloud Bus 想某一个服务发送一个“/actuator/bus-refresh”POST请求，通过消息组件通知其他微服务实例重新拉取配置文件，如下图：
  

• 在 demo 3的基础上进行重构，只改造config-client工程

安装RabbitMq

• 请参照： https://www.cnblogs.com/saryli/p/9729591.html

把github上config-client-dev文件的服务端口注释掉

• 因为需要启动config-client服务的多个实例，端口号不能重复
  

只改造config-client工程

pom.xml

• 引入用RabbitMQ实现的Spring Cloud Bus 的起步依赖spring-cloud-starter-bus-amqp

<?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">
<parent>
<artifactId>springcloud-config</artifactId>
<groupId>com.qgg</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>config-client</artifactId>
<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>
<!-- spring-cloud-starter-eureka在构建高可用config server的demo中用到
-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--
这个只支持springboot1.5.x版本
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
<!-- springboot1.5.x版本不需要用到spring-boot-starter-actuator
-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
</dependencies>
</project>

修改application.yml文件

• 添加rabbitmq相关配置
• 添加management.endpoints.web.exposure.include = bus-refresh，屏蔽安全验证，include必须=bus-refresh，值改为refresh也访问不了

# bootstrap.yml 在application.yml之前加载
spring:
application:
name: config-client # 服务名
rabbitmq:
# rabbitmq相关配置
host: localhost
port: 5672
username: guest
password: guest
management:
# 屏蔽安全验证，不然访问不了/bus/refresh接口，就刷新不了
#
security:
#
enabled: false
#
如果是SpringBoot1.5.x的版本，那么配置改成management.security.enabled=false即可。
endpoints:
web:
exposure:
include: bus-refresh
# SpringBoot2.x,配置exposure.include
#
include: refresh,health,info # 打开部分
#
base-path: /
# 默认是/actuator 前缀，可以在这里修改
eureka:
client:
service-url:
DEFAULT_URL: http://localhost:8761/eureka/
# 向eureka-server注册
server:
port: 8762

需要更新的配置类添加@RefreshScope注解

• 只有加了该注解，才会不重启服务的情况下更新配置

@RestController
@RefreshScope // 只有添加了该注释，才会在不重启的服务的情况下更新配置
public class ConfigClientController {
@Value("${qia}")
private String value;
@GetMapping("/getName/{name}")
public String getName(@PathVariable String name) {
return name+"---"+value;
}
}

结果

• 首先启动rabbitmq服务，进入安装目录D:Program FilesRabbitMQ Serverrabbitmq_server-3.7.14sbin，双击rabbitmq-server.bat文件启动
• 依次启动eureka-server、config-server，在启动config-client:8762、config-client:8763
• 在启动config-client两个实例时，在控制台可以看到刷新配置的接口，/actuator/bus-refresh 和 /actuator/bus-refresh/{destination} （只刷新某一个端口号实例）
  
• 查看运行状况
  
  
  
• 通过github desktop工具修改config-client-dev.yml文件
  
• 通过postman工具发送 /actuator/bus-refresh 请求， /actuator/bus-refresh/config-client 只刷新单个实例
  
• 重新访问config-client的两个实例接口，发现只请求了config-client:8762实例，通过消息总线同时也刷新了config-client:8763的配置
  

最后

以上就是纯真豌豆为你收集整理的【spring cloud 第九篇】spring-cloud config 配置中心config 简介1 config server从本地读取配置文件DEMO2 config server从github仓库读取配置文件DEMO3 构建高可用的config server（DEMO）4 使用SpringCloud Bus刷新配置（DEMO）的全部内容，希望文章能够帮你解决【spring cloud 第九篇】spring-cloud config 配置中心config 简介1 config server从本地读取配置文件DEMO2 config server从github仓库读取配置文件DEMO3 构建高可用的config server（DEMO）4 使用SpringCloud Bus刷新配置（DEMO）所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。