统一文档服务器,Spring Cloud Config(统一配置中心服务端和客户端)

Spring Cloud Config

Spring Cloud Config为分布式系统中的外部化配置提供服务器和客户端支持。Spring Cloud Config 是一种用来动态获取Git、SVN、本地的配置文件的一种工具。可以在所有环境中管理应用程序的外部属性。可以与任何语言运行的任何应用程序一起使用。当应用程序通过部署从开发到测试并进入生产时，可以管理这些环境之间的配置，并确保应用程序具有迁移时需要运行的所有内容。服务器存储后端的默认实现使用git，可以轻松支持配置环境的标签版本，以及可用于管理内容的各种工具。添加替代实现并使用Spring配置插入很容易。

Github地址：https://github.com/spring-cloud/spring-cloud-config

官方指引：https://spring.io/projects/spring-cloud-config

Spring Cloud Config Server功能：

1.用于外部配置的HTTP，基于资源的API(名称 - 值对或等效的YAML内容)

2.加密和解密属性值(对称或非对称)

3.使用可轻松嵌入Spring Boot应用程序 @EnableConfigServer

Spring Cloud Config Client功能(适用于Spring应用程序)：

1.绑定到Config Server并Environment使用远程属性源初始化Spring

2.加密和解密属性值(对称或非对称)

SpringBoot集成Spring Cloud Config Server

版本说明

SpringBoot：2.1.3.RELEASE

SpringCloud：Greenwich.SR1

引入Spring Cloud Config Server依赖

org.springframework.cloud

spring-cloud-config-server

这里使用Eureka注册中心，所以需要加上

org.springframework.cloud

spring-cloud-starter-netflix-eureka-client

配置很简单 只需要在启动类上加@EnableEurekaClient开启Eureka客户端，@EnableConfigServer开启统一配置中心

@SpringBootApplication

@EnableEurekaClient

@EnableConfigServer

public class SpringcloudConfigApplication {

public static void main(String[] args) {

SpringApplication.run(SpringcloudConfigApplication.class, args);

}

}

创建配置仓库

可以在私人Gitlab,码云,Github等等创建

我这里是在Github上创建的配置文件，一般都是yml或者properties配置文件

eureka:

client:

service-url:

defaultZone: http://localhost:8761/eureka/

需要在项目的配置文件中指定连接的仓库，用户名和密码

image.png

spring.cloud.config.server.git.uri就是仓库的访问地址

spring:

application:

name: config

cloud:

config:

server:

git:

uri: 项目配置仓库的位置，这个位置可以是：git文件夹、svn文件夹或者github项目位置，任何能访问到文件的地方。

username: 登录用户名

password: 登录密码

下面进行测试

先启动Eureka注册中心，在启动统一配置中心

image.png

在控制台可以看到 会在临时目录中创建一份配置文件

验证配置是否生效

image.png

官方提供http查看方式

/{application}-{profile}.yml

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

/{application}-{profile}.properties

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

application：应用名 ,也就是spring.application.name

label：分支名，默认master

profile：环境名，环境可以在配置文件的属性名是env,不设置也可以

SpringBoot集成Spring Cloud Config Client

版本说明

SpringBoot：2.1.3.RELEASE

SpringCloud：Greenwich.SR1

引入Spring Cloud Config Client依赖

org.springframework.cloud

spring-cloud-config-client

这里使用Eureka注册中心，所以需要加上

org.springframework.cloud

spring-cloud-starter-netflix-eureka-client

不需要在启动类中加入注解

由于是统一配置中心的客户端，所以需要在yml配置文件中配置

spring:

cloud:

config:

discovery:

enabled: true

service-id: config

profile: dev

spring.cloud.config.discovery.enabled：开启配置服务发现

spring.cloud.config.discovery.service-id：配置服务实例名称，也就是Config Server的应用名

spring.cloud.config.label：是配置分支名，默认是master,可以不配置

spring.cloud.config.profile：环境名，对应Config Server的env

dev:开发环境

test:测试环境

pro:正式环境

重点：需要把配置文件名由application.yml改名为bootstrap.yml

场景：当使用Spring Cloud的时候，配置信息一般是从Config Server加载的，为了取得配置信息(比如密码等)，需要提早读取配置。因此，把 Config Server 信息放在bootstrap.yml，用来加载需要的配置信息

原理：bootstrap.yml是被一个父级的 Spring ApplicationContext加载的。这个父级的 Spring ApplicationContext是先加载的，在加载application.yml 的 ApplicationContext之前。

bootstrap与application

bootstrap.yml(bootstrap.properties)用来程序引导时执行，应用于更加早期配置信息读取，如可以使用来配置application.yml中使用到参数等

application.yml(application.properties) 应用程序特有配置信息，可以用来配置后续各个模块中需使用的公共参数等。

配置完启动就可以读取远程仓库的配置文件了