Spring Cloud Config为分布式系统中的外部配置提供服务器和客户端支持。使用Config Server,您可以在所有环境中管理应用程序的外部属性。客户端和服务器上的概念映射与Spring Environment
和PropertySource
抽象相同,因此它们与Spring应用程序非常契合,但可以与任何以任何语言运行的应用程序一起使用。随着应用程序通过从开发人员到测试和生产的部署流程,您可以管理这些环境之间的配置,并确定应用程序具有迁移时需要运行的一切。服务器存储后端的默认实现使用git,因此它轻松支持标签版本的配置环境,以及可以访问用于管理内容的各种工具。很容易添加替代实现,并使用Spring配置将其插入。
1)在父工程下创建一个config-server的子项目,项目结构及pom文件如下
pom.xml
<?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.example</groupId>
<artifactId>config-server</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>config-server</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>com.example</groupId>
<artifactId>spring-cloud</artifactId>
<version>0.0.1-SNAPSHOT</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<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.SR2</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
2) 在spring-boot启动类上加上@EnableEurekaClient注解注册服务,以及@EnableConfigServer表示这是一个config-server
3)上面说过服务器存储后端的默认实现使用git,因此它轻松支持标签版本的配置环境,以及可以访问用于管理内容的各种工具。很容易添加替代实现,并使用Spring配置将其插入。所以我们需要在git服务器上面创建好需要的配置文件
HTTP服务具有以下格式的资源:
<span style="color:rgba(0, 0, 0, 0.8)"><span style="color:rgba(0, 0, 0, 0.9)">/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties</span></span>
其中“应用程序”作为SpringApplication
中的spring.config.name
注入(即常规的Spring Boot应用程序中通常是“应用程序”),“配置文件”是活动配置文件(或逗号分隔列表的属性),“label”是可选的git标签(默认为“master”)。
4)config-server的application.yml配置文件如下,其中uri是指你的git服务器的地址,search-paths配置文件所在的文件夹在仓库中的路径
5)启动config-server项目,此时访问localhost:8763/eureka-client-test.yml会出现如下图的内容即表示成功
6)既然有了config-server服务端,那就会有config-client客户端了,此时不需要新建项目,而是在其他项目中引入config-server配置git服务器上的内容。我们可以在eureka-client项目稍加改造即可引入配置。只需在eureka-client项目的pom文件加入以下依赖。
bootstrap.yml
7)如下编写测试类访问eureka-client项目localhost:8762/test,查看是否可获取到git服务器里的配置
如果能正常访问并获取到正确的值即说明成功。
8)spring-cloud-config除了能够统一配置,还有一个很强大的功能,那就是自动刷新配置
首先在client端的pom文件引入以下依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
然后大家需要安装Rabbitmq,具体的安装教程大家可以参考其他博客
安装完Rabbitmq后需要在client端修改bootstrap.yml文件,加入以下配置
然后启动项目大家会发现控制日志中会打印这个路径
此时我们修改git服务器里的配置文件,再次访问localhost:8762/test会发现获取的值并没有改变,此时我们需要访问上面控制台输出映射的三个路径,同时需要对应相应的请求方式,再次访问localhost:8762/test就会得到我们修改后的值
9)上面的内容虽然能够刷新配置,但是还是需要我们手动去访问接口刷新,所以我们可以在git服务上面配置webhooks来做到动态刷新
现在大家修改git的配置不用手动访问接口就可以自动刷新配置了
这篇文章可能会有不足的地方,文笔不好,大家可以留下你们珍贵的评论,谢谢~