微服务-9-SpringCloud Config分布式配置中心

SpringCloud Config分布式配置中心

项目地址

概述

分布式系统面临的—配置问题

微服务意味着要将单体应用中的业务拆分成一个个子服务，每个服务的粒度相对较小，因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行，所以一套集中式的、动态的配置管理设施是必不可少的。SpringCloud提供了ConfigServer来解决这个问题，我们每一个微服务自己带着一个application.yml，上百个配置文件的管理…

是什么

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

怎么玩

SpringCloud Config分为服务端和客户端两部分。

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

客户端则是通过指定的配置中心来管理应用资源，以及与业务相关的配置内容，并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。

能干嘛

集中管理配置文件
不同环境不同配置，动态化的配置更新，分环境部署比如dev/test/prod/beta/release
运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件，服务会向配置中心统一拉取配置自己的信息
当配置发生变动时，服务不需要重启即可感知到配置的变化并应用新的配置
将配置信息以REST接口的形式暴露

与GitHub整合配置

SpringCloud Config服务端配置

1.用自己的GitHub账号在GitHub上新建一个名为microservicecloud-config的新Repository
2.由上一步获得SSH协议的git地址https://github.com/xxx/microservice-config.git
3.本地硬盘目录上新建git仓库并clone
本地地址：D:\44\mySpringCloud
git命令：git clone git@github.com:xxx/microservice-config.git
4.在本地D:\44\mySpringCloud\microservicecloud-config里面新建一个application.yml
YML内容

spring:
  profiles:
   active: dev
---
spring:
  profiles: dev #开发环境
  application:
    name: springcloud-study-config-client
---
spring:
  profiles: test #测试环境
  application:
   name: microservice-config-test
#请保存为UTF-8格式

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

	git add .
	git commit -m "init yml"
	git push origin master

6.新建Module模块microservicecloud-config-3344
7.pom文件

  <dependencies>
        <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>




        <!--注册进Eureka-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-eureka</artifactId>
        <version>1.4.7.RELEASE</version>
    </dependency>
    <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>
    <!--hystrix依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-hystrix</artifactId>
        <version>1.4.7.RELEASE</version>
    </dependency>
    <!--基础配置-->

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!--热部署,修改后立即生效-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
    <!--基础配置-->
</dependencies>

8.yml文件

server:
  port: 3344
spring:
  application:
    name: microservice-config
  cloud:
    config:
      server:
        git:
          uri: https://github.com/xxxx/microservice-config.git #GitHub上面的git仓库名字
          #uri: git@github.com:1156598192/microservicecloud-config.git  会访问不到数据要注意

eureka:
  instance:
    instance-id: microservice-config3344 #默认名称修改
    prefer-ip-address: true #访问路径可以显示IP地址
  client:
    register-with-eureka: true #是否注册
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/

#      defaultZone: http://localhost:7001/eureka/  # 注册中心访问地址
          

9.它即为Cloud的配置中心模块主启动Config_3344_StartSpringCloudApp
加入@EnableConfigServer
10.windows下修改hosts文件，
增加映射 127.0.0.1 config-3344.com
11.测试通过Config微服务是否可以从GitHub上获取配置内容
启动微服务3344
http://config-3344.com:3344/application-dev.yml
http://config-3344.com:3344/application-test.yml
http://config-3344.com:3344/application-xxx.yml(不存在的配置)
成功实现了用SpringCloud Config通过GitHub获取配置信息

12.配置读取规则
官网
/{application}-{profile}.yml
http://config-3344.com:3344/application-dev.yml
http://config-3344.com:3344/application-test.yml
http://config-3344.com:3344/application-xxx.yml(不存在的配置)
/{application}/{profile}[/{label}]
http://config-3344.com:3344/application/dev/master
http://config-3344.com:3344/application/test/master
http://config-3344.com:3344/application/xxx/master
/{label}/{application}-{profile}.yml
http://config-3344.com:3344/master/application-dev.yml
http://config-3344.com:3344/master/application-test.yml

13.成功实现了用SpringCloud Config通过GitHub获取配置信息

SpringCloud Config客户端配置与测试

1.在本地D:\44\mySpringCloud\microservicecloud-config路径下新建文件
microservice-config-client.yml
2.microservicecloud-config-client.yml内容

spring:
  profiles:
   active: dev
---
server:
  port: 8201
spring:
  profiles: dev #开发环境
  application:
    name: microservice-config-client
client:
  instance:
    instance-id: microservice-config8201 #默认名称修改
    prefer-ip-address: true #访问路径可以显示IP地址
  register-with-eureka: true #是否注册
  fetch-registry: true
  service-url:
    defaultZone: http://eureka7001.com:7001/eureka/

---
server:
  port: 8202
spring:
  profiles: test #测试环境
  application:
    name: microservice-config-client
client:
  instance:
    instance-id: microservice-config8202 #默认名称修改
    prefer-ip-address: true #访问路径可以显示IP地址
  register-with-eureka: true #是否注册
  fetch-registry: true
  service-url:
    defaultZone: http://eureka7001.com:7001/eureka/

3.将上一步提交到GitHub中
4.新建microservice-config-client-3355
5.pom文件
6.bootstrap.yml

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

applicaiton.yml是用户级的资源配置项
bootstrap.yml是系统级的，优先级更加高
Spring Cloud会创建一个Bootstrap Context，作为Spring应用的Application Context的父上下文。初始化的时候，Bootstrap Context负责从外部源加载配置属性并解析配置。这两个上下文共享一个从外部获取的Environment。Bootstrap属性有高优先级，默认情况下，它们不会被本地配置覆盖。 Bootstrap context和Application Context有着不同的约定，
所以新增了一个bootstrap.yml文件，保证Bootstrap Context和Application Context配置的分离。
7.application.yml

spring:
  application:
    name: microservice-config-client

8.windows下修改hosts文件，增加映射127.0.0.1 client-config.com
9.新建rest类，验证是否能从GitHub上读取配置

@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;
  }
  }

10.主启动类ConfigClient_3355_StartSpringCloudApp
11.测试
启动Config配置中心3344微服务并自测
http://config-3344.com:3344/application-dev.yml
启动3355作为Client准备访问
bootstrap.yml里面的profile值是什么，决定从github上读取什么
假如目前是 profile: dev
dev默认在github上对应的端口就是8201
http://client-config.com:8201/config
假如目前是 profile: test
test默认在github上对应的端口就是8202
http://client-config.com:8202/config
12.成功实现了客户端3355访问SpringCloud Config3344通过GitHub获取配置信息

SpringCloud Config配置实战

目前情况

1 Config服务端配置配置OK且测试通过，我们可以和config+GitHub进行配置修改并获得内容

2 此时我们做一个eureka服务+一个Dept访问的微服务，将两个微服务的配置统一由于github获得实现统一配置分布式管理，完成多环境的变更

步骤

1.Git配置文件本地配置

在本地D:\44\microservice-config路径下新建文件

microservice-config-eureka-client.yml

spring:
  profiles:
    active:
    - dev
---
server:
  port: 7001 #注册中心占用7001端口,冒号后面必须要有空格

spring:
  profiles: dev
  application:
    name: microservicecloud-config-eureka-client

eureka:
  instance:
    hostname: eureka7001.com #冒号后面必须要有空格
  client:
    register-with-eureka: false #当前的eureka-server自己不注册进服务列表中
    fetch-registry: false #不通过eureka获取注册信息
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/
---
server:
  port: 7001 #注册中心占用7001端口,冒号后面必须要有空格

spring:
  profiles: test
  application:
    name: microservicecloud-config-eureka-client

eureka:
  instance:
    hostname: eureka7001.com #冒号后面必须要有空格
    prefer-ip-address: true
  client:
    register-with-eureka: false #当前的eureka-server自己不注册进服务列表中
    fetch-registry: false #不通过eureka获取注册信息
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/

在本地D:\44\microservice-config路径下新建文件

microservicecloud-config-dept-client.yml
microservicecloud-config-dept-client.yml内容

spring: 
  profiles:
    active: dev
---
server:
  port: 8001
mybatis:
  configlocation: classpath:mybatis/mybatis.cfg.xml #Mybatis配置文件所在路径
  type-aliases-package: com.microservice.bean   #所有bean别名所在包
  mapper-locations:
  - classpath:mybatis/mapper/**/*.xml #mapper映射文件
spring:
  profiles: dev
  application:
    name: microservice-config-dept-client      #对外暴露的微服务名字
  datasource:                         #数据库连接
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: org.gjt.mm.mysql.Driver
    url: jdbc:mysql://localhost:3306/springcloud?characterEncoding=utf8&useSSL=false
    username: root
    password: root
      #druid连接池配置
    initialSize: 5
    minIdle: 5
    maxActive: 20
    maxWait: 60000
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: SELECT 1 FROM DUAL
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true
    # 配置监控统计拦截的filters,去掉监控界面sql无法统计，‘wall’用于防火墙
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    userGlobalDataSourceStat: true
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
eureka:
  instance:
    instance-id: dept-service8001 #默认名称修改
    prefer-ip-address: true #访问路径可以显示IP地址
  client:
    register-with-eureka: true #是否注册
    fetch-registry: true
    service-url:
     # 集群:
      #defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/
     # 单机
      defaultZone: http://localhost:7001/eureka/  # 注册中心访问地址

#Info信息显示
info:
  app.name: config01
  companny.name: www.baidu.com
  build.artifactId: $project.artifactId$
  build.version: $project.version$
  
---
server:
  port: 8001
mybatis:
  configlocation: classpath:mybatis/mybatis.cfg.xml #Mybatis配置文件所在路径
  type-aliases-package: com.microservice.bean   #所有bean别名所在包
  mapper-locations:
  - classpath:mybatis/mapper/**/*.xml #mapper映射文件
spring:
  profiles: test
  application:
    name: microservice-config-dept-client      #对外暴露的微服务名字
  datasource:                         #数据库连接
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: org.gjt.mm.mysql.Driver
    url: jdbc:mysql://localhost:3306/springcloud02?characterEncoding=utf8&useSSL=false
    username: root
    password: root
      #druid连接池配置
    initialSize: 5
    minIdle: 5
    maxActive: 20
    maxWait: 60000
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: SELECT 1 FROM DUAL
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true
    # 配置监控统计拦截的filters,去掉监控界面sql无法统计，‘wall’用于防火墙
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    userGlobalDataSourceStat: true
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
eureka:
  instance:
    instance-id: dept-service8001 #默认名称修改
    prefer-ip-address: true #访问路径可以显示IP地址
  client:
    register-with-eureka: true #是否注册
    fetch-registry: true
    service-url:
     # 集群:
      #defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/
     # 单机
      defaultZone: http://localhost:7001/eureka/  # 注册中心访问地址
#Info信息显示
info:
  app.name: config01
  companny.name: www.baidu.com
  build.artifactId: $project.artifactId$
  build.version: $project.version$

2.Config版的eureka服务端

新建工程microservice-config-eureka-client-7001
pom文件

   <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka-server</artifactId>
            <version>1.4.7.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>

        </dependency>
    </dependencies>

bootstrap.yml

spring:
  cloud:
    config:
      name: microservice-config-eureka-client     #需要从github上读取的资源名称，注意没有yml后缀名
      profile: dev
      label: master
      uri: http://config-3344.com:3344      #SpringCloudConfig获取的服务地址

application.yml

spring:
  application:
    name: microservice-config-eureka-client

主启动类Config_Git_EurekaServerApplication
@SpringBootApplication
@EnableEurekaServer
测试
先启动microservice-config-3344微服务，保证Config总配置是OK的
再启动microservice-config-eureka-client-7001微服务
http://eureka7001.com:7001/
出现eureak主页表示成功启动

Config版的dept微服务

参考之前的8001拷贝后新建工程microservice-config-dept-client-8001
pom

  <dependencies>
        <dependency>
            <groupId>com.microservice</groupId>
            <artifactId>microservice-api</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-jetty -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
            <version>2.0.9.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--热部署,修改后立即生效-->

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
        </dependency>
        <!--注册进Eureka-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
            <version>1.4.7.RELEASE</version>
        </dependency>
        <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>

    </dependencies>

bootstrap.yml

spring:
  cloud:
    config:
      name: microservicecloud-config-dept-client #需要从github上读取的资源名称，注意没有yml后缀名
      #profile配置是什么就取什么配置dev or test
      #profile: dev
      profile: test
      label: master
      uri: http://config-3344.com:3344  #SpringCloudConfig获取的服务地址

application.yml

spring:
  application:
    name: microservicecloud-config-dept-client

主启动类及其它一套业务逻辑代码
主启动类@SpringBootApplication
@EnableEurekaClient //本服务启动后会自动注册进eureka服务中
@EnableDiscoveryClient //服务发现
其它业务逻辑代码如前面的工程’

配置说明

spring:
  cloud:  
    config:    
      name: microservicecloud-config-dept-client #需要从github上读取的资源名称，注意没有yml后缀名      #profile配置是什么就取什么配置dev or test      
      #profile: dev     
       profile: test    
         label: master     
          uri: http://config-3344.com:3344  #SpringCloudConfig获取的服务地址
 
主要看bootstrap.yml文件里面的
profile: 属性具体值是什么，从而确定它能从github上取得什么样的配置
假如配置dev左图，如果配置test那就找右图，具体各自数据库不同，从而依据配置得到分布式配置的目的

测试
test配置默认访问
http://localhost:8001/dept/list
可以看到数据库配置是02
本地换配置成dev
http://localhost:8001/dept/list
可以看到数据库配置是01

架构图