开启springcloud全家桶7：使用spring cloud config来统一管理配置文件

谁践踏了优雅 2023-01-20 09:52 162阅读 0赞

这篇文章主要介绍了详解使用spring cloud config来统一管理配置文件，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

当一个系统中的配置文件发生改变的时候，我们需要重新启动该服务，才能使得新的配置文件生效，spring cloud config可以实现微服务中的所有系统的配置文件的统一管理，而且还可以实现当配置文件发生变化的时候，系统会自动更新获取新的配置。

其架构原理图大致如下：

![9c21a630cc4c0c291e4b2b6b6904eef2.png][]

我们将配置文件放入git或者svn等服务中，通过一个Config Server服务来获取git中的配置数据，而我们需要使用的到配置文件的Config Client系统可以通过Config Server来获取对应的配置。

下面我们通过一个示例来演示一下config是如何被各个微服务系统获取到的。

**1.向git中上传示例配置文件**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>jdbc.driverClassName=com.mysql.jdbc.Driver</code> <code>jdbc.url=jdbc:mysql://127.0.0.1:3306/taotao?useUnicode=true&amp;characterEncoding=utf8&amp;autoReconnect=true&amp;allowMultiQueries=true</code> <code>jdbc.username=root</code> <code>jdbc.password=root</code> </td> 
 </tr> 
 </tbody> 
</table>

文件名分别为：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>microservice-dev.properties</code> <code>microservice-production.properties</code> <code>microservice-test.properties</code> </td> 
 </tr> 
 </tbody> 
</table>

对应不同的三个环境。

该文件的命名规则是：\{application\}-\{profile\}.properties

**2.搭建Config Server**

2.1 添加依赖

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 </td> 
 <td> <code>&lt;</code><code>parent</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.boot&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-boot-starter-parent&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>version</code><code>&gt;1.5.4.RELEASE&lt;/</code><code>version</code><code>&gt;</code> <code>&lt;/</code><code>parent</code><code>&gt;</code> &nbsp; <code>&lt;!-- 导入Spring Cloud的依赖管理 --&gt;</code> <code>&lt;</code><code>dependencyManagement</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>dependencies</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.cloud&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-cloud-dependencies&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>version</code><code>&gt;Dalston.SR3&lt;/</code><code>version</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>type</code><code>&gt;pom&lt;/</code><code>type</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>scope</code><code>&gt;import&lt;/</code><code>scope</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.cloud&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-cloud-starter-eureka-server&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>exclusions</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>exclusion</code><code>&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;com.fasterxml.jackson.dataformat&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;jackson-dataformat-xml&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>exclusion</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>exclusions</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/</code><code>dependencies</code><code>&gt;</code> <code>&lt;/</code><code>dependencyManagement</code><code>&gt;</code> &nbsp; <code>&lt;</code><code>dependencies</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.cloud&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-cloud-config-server&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;!-- 使用bus总线的方式通知所有的微服务配置文件需要刷新 --&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.cloud&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-cloud-starter-bus-amqp&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/</code><code>dependency</code><code>&gt;</code> <code>&lt;/</code><code>dependencies</code><code>&gt;</code> &nbsp; <code>&lt;</code><code>build</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>finalName</code><code>&gt;${project.artifactId}&lt;/</code><code>finalName</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>plugins</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- 资源文件拷贝插件 --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>plugin</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.apache.maven.plugins&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;maven-resources-plugin&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>configuration</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>encoding</code><code>&gt;UTF-8&lt;/</code><code>encoding</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>configuration</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>plugin</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!-- java编译插件 --&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>plugin</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.apache.maven.plugins&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;maven-compiler-plugin&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>configuration</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>source</code><code>&gt;1.8&lt;/</code><code>source</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>target</code><code>&gt;1.8&lt;/</code><code>target</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;</code><code>encoding</code><code>&gt;UTF-8&lt;/</code><code>encoding</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>configuration</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/</code><code>plugin</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/</code><code>plugins</code><code>&gt;</code> <code>&lt;/</code><code>build</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

2.2 编写ConfigApplication

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>@EnableDiscoveryClient</code> <code>@EnableConfigServer</code> <code>//开启配置服务</code> <code>@SpringBootApplication</code> <code>public</code> <code>class</code> <code>ConfigApplication { </code> &nbsp; <code>&nbsp;&nbsp;</code><code>public</code> <code>static</code> <code>void</code> <code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>SpringApplication.run(ConfigApplication.</code><code>class</code><code>, args);</code> <code>&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

2.3 编写yml配置文件

这是我们启动该服务，访问该配置文件，访问路径示例如下(以该配置为例)： 127.0.0.1:6688/microservice-dev.properties

访问路径的写法也有多种方式：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>/{application}/{profile}/[label]</code> <code>/{application}-{profile}.yml</code> <code>/{label}/{application}-{profile}.yml</code> <code>/{application}-{profile}.properties</code> <code>/{label}/{application}-{profile}.properties</code> <code>其中{label}是指分支，默认是master。</code> </td> 
 </tr> 
 </tbody> 
</table>

**3. Config Client的搭建**

3.1 添加依赖

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>&lt;</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.cloud&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-cloud-starter-config&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&lt;/</code><code>dependency</code><code>&gt;</code> <code>&lt;</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.boot&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-boot-starter-actuator&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&lt;/</code><code>dependency</code><code>&gt;</code> <code>&lt;</code><code>dependency</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>groupId</code><code>&gt;org.springframework.cloud&lt;/</code><code>groupId</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>artifactId</code><code>&gt;spring-cloud-starter-bus-amqp&lt;/</code><code>artifactId</code><code>&gt;</code> <code>&lt;/</code><code>dependency</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

3.2 添加yml配置文件

注意，这里的yml配置文件是：bootstrap.yml，它和application.yml文件一样，会被spring boot加载，但是bootstrap.yml会优先加载。

3.3 在application.yml文件中添加配置

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>management:</code> <code>&nbsp;</code><code>security:</code> <code>&nbsp;&nbsp;</code><code>enabled: false #是否开启actuator安全认证</code> </td> 
 </tr> 
 </tbody> 
</table>

3.4 利用git的webhook实现实时更新通知

![3f26fecd477e3e73301723f0d054737e.png][]

![2855d866159ac159bdef530916c562bf.png][]

![231b04cafb744fa2984c7b02126fb4bb.png][]

这个时候，我么通过@Value的方式，就可以获取到对应的配置了。

再次测试，我们发现当我们修改了git中的配置文件的内容之后，client系统中读取到的属性也是修改之后的了。

到此为止，其架构变成如下：

![ee3e246bf7ee3447cd2483b9675d524d.png][]

[9c21a630cc4c0c291e4b2b6b6904eef2.png]: /images/20221021/41b8bb6eb7e6485ca3d31a6b2b55321a.png
[3f26fecd477e3e73301723f0d054737e.png]: /images/20221021/f1eb0b960e564cec8ab776a28402181e.png
[2855d866159ac159bdef530916c562bf.png]: /images/20221021/9ab50a06f28148f184301a3dc609c1af.png
[231b04cafb744fa2984c7b02126fb4bb.png]: /images/20221021/48c8d92ae4764b31ae61df74aef8c9cd.png
[ee3e246bf7ee3447cd2483b9675d524d.png]: /images/20221021/3c0f712c5b284a0caf0c721dffdf0791.png