博客

【SpringCloud总结】12 SpringCloud Config 分布式配置中心

  • Post author:
  • Post category:其他


一、简介

微服务意味着要将单体应用中的业务拆分成一个个子服务，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行，所以一套


集中式的、动态的


配置管理设施是必不可少的。SpringCloud提供了


ConfigServer


来解决这个问题。

SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持，配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。


1.  SpringCloud Config

SpringCloud Config分为


服务端


和


客户端


两部分。

服务端也称为分布式配置中心，它是一个独立的微服务应用，用来连接配置服务器并为客户端提供获取配置信息，加密/解密信息等访问接口

客户端则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息


配置服务器


默认采用


git






来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。


2. 能干嘛

（1）集中管理配置文件

（2）不同环境不同配置，动态化的配置更新，分环境部署比如dev/test/prod/beta/release

（3）将配置信息以REST接口的形式暴露

二、服务端的准备工作

1. 用自己的GitHub账号在GitHub上新建一个名为


microservicecloud-config


的新Repository

2. 由上一步获得SSH协议的git地址

git@github.com:zzyybs/microservicecloud-config.git

3. 本地硬盘目录上新建git仓库并clone

（1）本地地址：D:\44\mySpringCloud

（2）git命令：git clone git@github.com:zzyybs/microservicecloud-config.git

4. 在本地D:\44\mySpringCloud\microservicecloud-config里面新建一个

application.yml
 

# 不同的开发环境，不同的微服务名字
spring:
  profiles:
    active:
    - dev
---
spring:
  profiles: dev     #开发环境
  application: 
    name: microservicecloud-config-atguigu-dev
---
spring:
  profiles: test   #测试环境
  application: 
    name: microservicecloud-config-atguigu-test
#  请保存为UTF-8格式

【注意】


保存格式必须为UTF-8

5. 将上一步的YML文件推送到github上 

git add .
git commit -m "init yml"
git push origin master #origin是git远程库的别名，master是分支

三、SpringCloud Config服务端配置

1. 新建Module模块


microservicecloud-config-3344


它即为Cloud的配置中心模块

2. pom文件 

<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>
  
  <parent>
   <groupId>com.atguigu.springcloud</groupId>
   <artifactId>microservicecloud</artifactId>
   <version>0.0.1-SNAPSHOT</version>
  </parent>
  
  <artifactId>microservicecloud-config-3344</artifactId>

  <dependencies>
   <!-- springCloud Config -->
   <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-config-server</artifactId>
   </dependency>
   <!-- 避免Config的Git插件报错：org/eclipse/jgit/api/TransportConfigCallback  -->
   <dependency>
       <groupId>org.eclipse.jgit</groupId>
       <artifactId>org.eclipse.jgit</artifactId>
       <version>4.10.0.201712302008-r</version>
   </dependency>
  </dependencies> 
  
</project>

3. yml文件 

server: 
  port: 3344 
  
spring:
  application:
    name:  microservicecloud-config
  cloud:
    config:
      server:
        git:
          uri: git@github.com:zzyybs/microservicecloud-config.git #GitHub上面的git仓库名字

【提示】通过git仓库的地址去仓库拉取配置文件信息

4. 主启动类





Config_3344_StartSpringCloudApp
 

package com.atguigu.springcloud;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;


@SpringBootApplication
@EnableConfigServer
public class Config_3344_StartSpringCloudApp
{
  public static void main(String[] args)
  {
   SpringApplication.run(Config_3344_StartSpringCloudApp.class,args);
  }
}


5 .测试

（1）

http://config-3344.com:3344/application-dev.yml


http://config-3344.com:3344/application-test.yml

根据REST接口的不同，浏览器返回的信息也不同。

（2）

http://config-3344.com:3344/application/dev/master


http://config-3344.com:3344/application/test/master

这里面的master是git的分支

（3）

http://config-3344.com:3344/master/application-dev.yml


http://config-3344.com:3344/master/application-test.yml

【提示】个人比较喜欢方式二，比较简洁清晰。同时这里面做了hosts的映射 127.0.0.1

config-3344.com

。


6. 总结

通过restFul风格API访问git远程库的配置文件。

四、客户端的准备工作

1. 在本地D:\44\mySpringCloud\microservicecloud-config路径下新建文件


microservicecloud-config-client.yml

 

spring:
  profiles:
    active:
    - dev
---
server: 
  port: 8201 
spring:
  profiles: dev
  application: 
    name: microservicecloud-config-client
eureka: 
  client: 
    service-url: 
      defaultZone: http://eureka-dev.com:7001/eureka/   
---
server: 
  port: 8202 
spring:
  profiles: test
  application: 
    name: microservicecloud-config-client
eureka: 
  client: 
    service-url: 
      defaultZone: http://eureka-test.com:7001/eureka/

2. 把文件提交到git仓库

三、SpringCloud Config客户端配置与测试

1. 新建


microservicecloud-config-client-3355

2. pom文件 

<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>
  
  <parent>
   <groupId>com.atguigu.springcloud</groupId>
   <artifactId>microservicecloud</artifactId>
   <version>0.0.1-SNAPSHOT</version>
  </parent>
  
  <artifactId>microservicecloud-config-client-3355</artifactId>
  
 
  <dependencies>
   <!-- SpringCloud Config客户端 -->
   <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-config</artifactId>
   </dependency> 
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-actuator</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-hystrix</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-eureka</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-config</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-jetty</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-test</artifactId>
   </dependency> 
   <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>springloaded</artifactId>
   </dependency>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-devtools</artifactId>
   </dependency>
  </dependencies> 
</project>
 



3. bootstrap.yml

 

spring:
  cloud:
    config:
      name: microservicecloud-config-client #需要从github上读取的资源名称，注意没有yml后缀名
      profile: dev   #本次访问的配置项
      label: master   
      uri: http://config-3344.com:3344  #本微服务启动后先去找3344号服务，通过SpringCloudConfig获取GitHub的服务地址


applicaiton.yml是用户级的资源配置项

bootstrap.yml是系统级的，优先级更加高

【提示】


通过uri找到git仓库，通过name找到仓库下的文件


。

4. application.yml 

spring:
  application:
    name: microservicecloud-config-client

5. 新建rest类，验证是否能从GitHub上读取配置 

package com.atguigu.springcloud.rest;


import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class ConfigClientRest {


  @Value("${spring.application.name}")
  private String applicationName;
  
  @Value("${eureka.client.service-url.defaultZone}")
  private String eurekaServers;
  
  @Value("${server.port}")
  private String port;
  
  @RequestMapping("/config")
  public String getConfig()
  {
   String str = "applicationName: "+applicationName+"\t eurekaServers:"+eurekaServers+"\t port: "+port;
   System.out.println("******str: "+ str);
   return "applicationName: "+applicationName+"\t eurekaServers:"+eurekaServers+"\t port: "+port;
  }
}

6. 主启动类ConfigClient_3355_StartSpringCloudApp 

package com.atguigu.springcloud;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication
public class ConfigClient_3355_StartSpringCloudApp
{
  public static void main(String[] args)
  {
   SpringApplication.run(ConfigClient_3355_StartSpringCloudApp.class,args);
  }
}

7. 测试

（1）启动Config配置中心3344微服务

（2）启动3355作为Client准备访问

（3）bootstrap.yml里面的profile值是什么，决定从github上读取什么

* 假如目前是 profile: dev

http://client-config.com:8201/config

* 假如目前是 profile: test

http://client-config.com:8202/config

通过手动更改bootstrap.yml文件里面profile的值来实现动态的更新配置信息的目的。

【提示】hosts里面做了域名映射 127.0.0.1

client-config.com