史上最简单的SpringCloud教程 | 第六篇: 分布式配置中心(Spring Cloud Config)

今天药忘吃喽~ 2022-06-16 23:47 242阅读 0赞

转载请标明出处：
https://www.fangzhipeng.com/springcloud/2017/06/06/sc06-config.html
本文出自方志朋的博客

个人博客纯净版：https://www.fangzhipeng.com/springcloud/2017/06/06/sc06-config.html

最新Finchley版本：
https://www.fangzhipeng.com/springcloud/2018/08/06/sc-f6-config.html
或者
http://blog.csdn.net/forezp/article/details/81041028

在上一篇文章讲述zuul的时候，已经提到过，使用配置服务来保存各个服务的配置文件。它就是Spring Cloud Config。

一、简介

在分布式系统中，由于服务数量巨多，为了方便服务配置文件统一管理，实时更新，所以需要分布式配置中心组件。在Spring Cloud中，有分布式配置中心组件spring cloud config ，它支持配置服务放在配置服务的内存中（即本地），也支持放在远程Git仓库中。在spring cloud config 组件中，分两个角色，一是config server，二是config client。

二、构建Config Server

创建一个spring-boot项目，取名为config-server,其pom.xml:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  6.     <groupId>com.forezp</groupId>
  7.     <artifactId>config-server</artifactId>
  8.     <version>0.0.1-SNAPSHOT</version>
  9.     <packaging>jar</packaging>
  11.     <name>config-server</name>
  12.     <description>Demo project for Spring Boot</description>
  14.     <parent>
  15.         <groupId>org.springframework.boot</groupId>
  16.         <artifactId>spring-boot-starter-parent</artifactId>
  17.         <version>1.5.2.RELEASE</version>
  18.         <relativePath/> <!-- lookup parent from repository -->
  19.     </parent>
  21.     <properties>
  22.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  23.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  24.         <java.version>1.8</java.version>
  25.     </properties>
  27.     <dependencies>
  28.         <dependency>
  29.             <groupId>org.springframework.cloud</groupId>
  30.             <artifactId>spring-cloud-config-server</artifactId>
  31.         </dependency>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-test</artifactId>
  36.             <scope>test</scope>
  37.         </dependency>
  39.         <dependency>
  40.             <groupId>org.springframework.cloud</groupId>
  41.             <artifactId>spring-cloud-starter-eureka</artifactId>
  42.         </dependency>
  43.     </dependencies>
  45.     <dependencyManagement>
  46.         <dependencies>
  47.             <dependency>
  48.                 <groupId>org.springframework.cloud</groupId>
  49.                 <artifactId>spring-cloud-dependencies</artifactId>
  50.                 <version>Camden.SR6</version>
  51.                 <type>pom</type>
  52.                 <scope>import</scope>
  53.             </dependency>
  54.         </dependencies>
  55.     </dependencyManagement>
  58.     <build>
  59.         <plugins>
  60.             <plugin>
  61.                 <groupId>org.springframework.boot</groupId>
  62.                 <artifactId>spring-boot-maven-plugin</artifactId>
  63.             </plugin>
  64.         </plugins>
  65.     </build>
  67.     <repositories>
  68.         <repository>
  69.             <id>spring-milestones</id>
  70.             <name>Spring Milestones</name>
  71.             <url>https://repo.spring.io/milestone</url>
  72.             <snapshots>
  73.                 <enabled>false</enabled>
  74.             </snapshots>
  75.         </repository>
  76.     </repositories>
  79. </project>

在程序的入口Application类加上@EnableConfigServer注解开启配置服务器的功能，代码如下：

  1. @SpringBootApplication
  2. @EnableConfigServer
  3. public class ConfigServerApplication {
  5.     public static void main(String[] args) {
  6.         SpringApplication.run(ConfigServerApplication.class, args);
  7.     }
  8. }

需要在程序的配置文件application.properties文件配置以下：

  1. spring.application.name=config-server
  2. server.port=8888
  5. spring.cloud.config.server.git.uri=https://github.com/forezp/SpringcloudConfig/
  6. spring.cloud.config.server.git.searchPaths=respo
  7. spring.cloud.config.label=master
  8. spring.cloud.config.server.git.username=your username
  9. spring.cloud.config.server.git.password=your password
  • spring.cloud.config.server.git.uri：配置git仓库地址
  • spring.cloud.config.server.git.searchPaths：配置仓库路径
  • spring.cloud.config.label：配置仓库的分支
  • spring.cloud.config.server.git.username：访问git仓库的用户名
  • spring.cloud.config.server.git.password：访问git仓库的用户密码

如果Git仓库为公开仓库，可以不填写用户名和密码，如果是私有仓库需要填写，本例子是公开仓库，放心使用。

远程仓库https://github.com/forezp/SpringcloudConfig/ 中有个文件config-client-dev.properties文件中有一个属性：

foo = foo version 3

启动程序：访问http://localhost:8888/foo/dev

  1. {"name":"foo","profiles":["dev"],"label":"master",
  2. "version":"792ffc77c03f4b138d28e89b576900ac5e01a44b","state":null,"propertySources":[]}

证明配置服务中心可以从远程程序获取配置信息。

http请求地址和资源文件映射如下:

  • /{application}/{profile}[/{label}]
  • /{application}-{profile}.yml
  • /{label}/{application}-{profile}.yml
  • /{application}-{profile}.properties
  • /{label}/{application}-{profile}.properties

三、构建一个config client

重新创建一个springboot项目，取名为config-client,其pom文件：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  6.     <groupId>com.forezp</groupId>
  7.     <artifactId>config-client</artifactId>
  8.     <version>0.0.1-SNAPSHOT</version>
  9.     <packaging>jar</packaging>
  11.     <name>config-client</name>
  12.     <description>Demo project for Spring Boot</description>
  14.     <parent>
  15.         <groupId>org.springframework.boot</groupId>
  16.         <artifactId>spring-boot-starter-parent</artifactId>
  17.         <version>1.5.2.RELEASE</version>
  18.         <relativePath/> <!-- lookup parent from repository -->
  19.     </parent>
  21.     <properties>
  22.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  23.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  24.         <java.version>1.8</java.version>
  25.     </properties>
  27.     <dependencies>
  28.         <dependency>
  29.             <groupId>org.springframework.cloud</groupId>
  30.             <artifactId>spring-cloud-starter-config</artifactId>
  31.         </dependency>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-web</artifactId>
  36.         </dependency>
  38.         <dependency>
  39.             <groupId>org.springframework.boot</groupId>
  40.             <artifactId>spring-boot-starter-test</artifactId>
  41.             <scope>test</scope>
  42.         </dependency>
  43.     </dependencies>
  45.     <dependencyManagement>
  46.         <dependencies>
  47.             <dependency>
  48.                 <groupId>org.springframework.cloud</groupId>
  49.                 <artifactId>spring-cloud-dependencies</artifactId>
  50.                 <version>Dalston.RC1</version>
  51.                 <type>pom</type>
  52.                 <scope>import</scope>
  53.             </dependency>
  54.         </dependencies>
  55.     </dependencyManagement>
  57.     <build>
  58.         <plugins>
  59.             <plugin>
  60.                 <groupId>org.springframework.boot</groupId>
  61.                 <artifactId>spring-boot-maven-plugin</artifactId>
  62.             </plugin>
  63.         </plugins>
  64.     </build>
  66.     <repositories>
  67.         <repository>
  68.             <id>spring-milestones</id>
  69.             <name>Spring Milestones</name>
  70.             <url>https://repo.spring.io/milestone</url>
  71.             <snapshots>
  72.                 <enabled>false</enabled>
  73.             </snapshots>
  74.         </repository>
  75.     </repositories>
  78. </project>

其配置文件bootstrap.properties：

  1. spring.application.name=config-client
  2. spring.cloud.config.label=master
  3. spring.cloud.config.profile=dev
  4. spring.cloud.config.uri= http://localhost:8888/
  5. server.port=8881
  • spring.cloud.config.label 指明远程仓库的分支

  • spring.cloud.config.profile

    • dev开发环境配置文件
    • test测试环境
    • pro正式环境
  • spring.cloud.config.uri= http://localhost:8888/ 指明配置服务中心的网址。

程序的入口类，写一个API接口“／hi”，返回从配置中心读取的foo变量的值，代码如下：

  1. @SpringBootApplication
  2. @RestController
  3. public class ConfigClientApplication {
  5.     public static void main(String[] args) {
  6.         SpringApplication.run(ConfigClientApplication.class, args);
  7.     }
  9.     @Value("${foo}")
  10.     String foo;
  11.     @RequestMapping(value = "/hi")
  12.     public String hi(){
  13.         return foo;
  14.     }
  15. }

打开网址访问：http://localhost:8881/hi，网页显示：

foo version 3

这就说明，config-client从config-server获取了foo的属性，而config-server是从git仓库读取的,如图：

在这里插入图片描述

本文源码下载：
https://github.com/forezp/SpringCloudLearning/tree/master/chapter6

四、参考资料

spring_cloud_config

更多阅读

史上最简单的 SpringCloud 教程汇总

SpringBoot教程汇总

Java面试题系列汇总

SouthEast
扫码关注公众号有惊喜

（转载本站文章请注明作者和出处 方志朋的博客）

发表评论

表情：
评论列表 （有 0 条评论，242人围观）

还没有评论，来说两句吧...

相关阅读