第九章SpringCloudConfig

9-1. Spring Cloud Config是什么&＃xff1f;

​   在分布式的系统中&＃xff0c;尤其是当我们的分布式项目越来越多&＃xff0c;每个项目都有自己的配置文件&＃xff0c;对配置文件的统一管理就成立一种需要&＃xff0c;而Spring Cloud Config就提供了对各个分布式项目配置文件的统一管理支持。Spring Cloud Config也叫分布式配置中心&＃xff0c;市面上开源的分布式配置中心有很多&＃xff0c;比如国内的&＃xff0c;360的QConf、淘宝的diamond、百度的disconf都是解决分布式系统配置管理问题&＃xff0c;国外也有很多开源的配置中心&＃xff0c;Apache的Apache Commons Configuration 、 owner、cfg4j等等。

​   Spring Cloud Config是一个解决分布式系统的配置管理方案。它包含Client和Server两个部分&＃xff0c;Server提供配置文件的存储、以接口的形式将配置文件的内容提供出去&＃xff0c;Client通过接口获取数据、并依据数据初始化自己的应用。Spring Cloud使用git或svn存放配置文件&＃xff0c;默认情况下使用git.

9-2.构建Spring Cloud Config配置中心

1. 创建一个Spring boot项目

2. 在pom.xml文件中添加依赖

   <dependency><groupId>org.springframework.cloudgroupId><artifactId>spring-cloud-config-serverartifactId>
dependency>


3. 在入口类的方法上添加注解&＃64;EnableConfigServer

4. 在application.properties中配置一下git仓库信息&＃xff0c;此处我们使用GitHub(也可以使用码云 gitee),首先在我的GitHub上创建一个名为spring-cloud-config的项目&＃xff0c;创建之后&＃xff0c;再做以下配置&＃xff1a;

   server.port&＃61;3721
spring.application.name&＃61;springcloud-config-serverspring.cloud.config.server.git.uri&＃61;http://github.com/项目名/spring-cloud-config.git
spring.cloud.config.server.git.search-paths&＃61;config-center
spring.cloud.config.server.git.username&＃61;xxx&＃64;163.com
spring.cloud.config.server.git.password&＃61;xxxxxx


   1. uri:表示配置中心所在仓库的位置
   2. search-paths:表示仓库下的子目录
   3. username&＃xff1a;GitHub的用户名
   4. password&＃xff1a;GitHub的密码

9-3. 构建Spring Cloud Config配置中心仓库

​   接下来我们需要在GitHub上设置好配置中心&＃xff0c;首先在本地 创建一个文件夹叫config,然后在里面创建一个文件夹叫config-center&＃xff0c;然后在config-center中创建四个配置文件&＃xff1a;如下

• application.properties
• application-dev.properties // 生产环境下的配置文件
• application-test.properties // 测试环境下的配置文件
• application-online.properties // 上线环境下的配置文件

在四个文件中分别写上要测试的内容

• url&＃61;http://www.zjtd.com
• url&＃61;http://dev.zjtd.com
• url&＃61;http://test.zjtd.com
• url&＃61;http://online.zjtd.com

然后回到config目录下&＃xff0c;一次执行如下命令将本地文件同步到GitHub的仓库中&＃xff1a;

说明&＃xff1a;在使用命令之前先从http://git-scm.com/网站下载安装git的Windows客户端

1. 添加提交人的账号信息&＃xff0c;git需要知道提交人的信息作为表示

   git config --global user.name &＃39;xxx&＃39;
git config --global user.email &＃39;xxx&＃64;163.com&＃39;


2. 将该目录变为git可以管理的目录

   git init


3. 将文件添加到暂存区

   git add config-center/


4. 把文件提交到本地仓库

   git commit -m &＃39;add config-center&＃39;


5. 添加到远程主机 origin为主机名称

   git remote add origin http://github.com/项目名/spring-cloud-congfig.git


6. 将本地的master 分支推送到origin主机

   git push -u origin master


  至此&＃xff0c;我们的配置文件就上传到GitHub上了。

  此时启动我们的配置中心&＃xff0c;通过/{application}/{profile}/{label}就能访问到我们的配置文件了&＃xff1b;

• &＃xff5b;application&＃xff5d;表示配置文件的名字
• &＃xff5b;profile&＃xff5d;表示环境有dev/test/online及默认
• &＃xff5b;label&＃xff5d;表示分支&＃xff0c;默认我们放在master分支上

  通过浏览器访问http://localhost:3721/application/dev/master返回的JSON格式的数据&＃xff1a;

  name表示配置文件名application部分&＃xff0c;

  profiles表示环境部分&＃xff0c;

  label表示分支&＃xff0c;

v  ersion表示GitHub上提交时产生的版本号&＃xff0c;

  同时当我们访问成功后&＃xff0c;在控制台会打印出相关的日志信息&＃xff0c;

  当访问成功后配置中心会通过git clone 命令将远程的配置文件在本地也保存一份&＃xff0c;以确保在git仓库故障时我们的应用还可以继续正常使用。

9-4.构建Spring Cloud Config配置中心客户端

1. 创建一个springboot工程 名叫spring-cloud-config-client

2. 添加相关依赖

   <dependency><groupId>org.springframework.cloudgroupId><artifactId>spring-cloud-starter-configartifactId>
dependency>


3. 创建bootstarp.properties文件&＃xff0c;用于获取配置信息&＃xff0c;文件内容如下&＃xff08;注意配置信息一定要放在bootstarp.properties文件中才有效&＃xff09;&＃xff1a;

   server.port&＃61;3722
spring.application.name&＃61;application
spring.cloud.config.profile&＃61;dev
spring.cloud.config.label&＃61;master
spring.cloud.config.uri&＃61;http://localhost:3721/


   • name 对应配置文件中的application部分
   • profile对应的是profile部分
   • label对应的是label部分、
   • uri表示配置中心的地址

4. 创建一个Controller进行测试

   1. 第一种方式获取

   &＃64;RestController
public class ConfigController{&＃64;Value("${url}")private String url;&＃64;RequestMapping("/cloud/url")public String url(){return url;}
}


   ​ 2.第二种方式获取

   &＃64;RestController
public class ConfigController{&＃64;Autowiredprivate Environment env;&＃64;RequestMapping("/cloud/url2")public String url2(){return env.getProperty("url");}
}


  我们可以直接使用&＃64;Value注解注入配置的属性值&＃xff0c;也可以通过Environment对象来获取配置的属性值。

9-5. Spring Cloud配置中心的工作原理

Spring Cloud Config Server的工作过程如下图所示&＃xff1a;

1. 首先需要一个远程git仓库&＃xff0c;平时测试可以使用GitHub &＃xff0c;在实际生产环境中&＃xff0c;需要搭建一个git 服务器&＃xff0c;远程Git仓库的主要作用是保存我们的配置文件。
2. 除了远程的Git仓库之外&＃xff0c;我们还需要一个本地的Git仓库&＃xff0c;每当Config Server访问远程Git仓库时&＃xff0c;都会克隆一份到本地&＃xff0c;这样当远程仓库无法连接时&＃xff0c;就直接使用本地存储的配置信息。
3. 微服务A和B则是我们具体的应用&＃xff0c;这些应用在启动的时候会从config server 中获取相应的配置文件。
4. 当微服务A和B尝试从config server中加载配置信息时&＃xff0c;config server会先通过Git clone 命令克隆一份配置文件保存到本地。
5. 由于配置文件是存储在Git仓库中&＃xff0c;所以配置文件天然具有版本管理功能。

9-6.Spring Cloud 的安全保护

​ 生产环境中我们的配置中心肯定是不能随随便便被人访问的&＃xff0c;我们可以加上适当的保护机制&＃xff0c;由于微服务是构建在Spring Boot之上的&＃xff0c;所以整合Spring Security是最方便的方式。

1. 在spring cloud config server 项目中添加依赖

   <dependency><groupId>org.springframework.bootgroupId><artifactId>spring-cloud-starter-securityartifactId>
dependency>


2. 在spring cloud config server项目的application.properties中配置用户名和密码

   spring.security.user.name&＃61;admin
spring.security.user.password&＃61;123456


3. 在spring cloud config client项目的bootstrap.properties中配置用户名和密码

   spring.cloud.config.username&＃61;admin
spring.cloud.config.password&＃61;123456


4. 最后验证测试