SpringCloud Config 分布式服务配置

SpringCloud Config Server

官方参考文档 ： https://cloud.spring.io/spring-cloud-config/reference/html/

demo： JavaAdvancedTrain/springcloud-config/**

按照下面的步骤一次接入相关组件

SpringCloud-Config配置Maven引用

服务端pom.xml

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-config-serverartifactId>
    <exclusions>
        <exclusion>
            <groupId>org.bouncycastlegroupId>
            <artifactId>bcprov-jdk15onartifactId>
        exclusion>
        <exclusion>
            <groupId>org.bouncycastlegroupId>
            <artifactId>bcpkix-jdk15onartifactId>
        exclusion>
    exclusions>
dependency>

如果是SpringBoot环境加入**@EnableConfigServer**注解

客户端pom.xml

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-configartifactId>
    <exclusions>
        <exclusion>
            <groupId>org.bouncycastle<]/groupId>
            <artifactId>bcprov-jdk15onartifactId>
        exclusion>
        <exclusion>
            <groupId>org.bouncycastlegroupId>
            <artifactId>bcpkix-jdk15onartifactId>
        exclusion>
    exclusions>
dependency>

SpringCloud-Config配置方式

SpringCloud-config配置方式有三种：

1. git
2. svn
3. native

​ 可以使用compose三种同时使用，根据优先级进行覆盖，或者单独配置

native

服务端

application.yaml文件

server:
  port: 8888
  
spring:
  application:
    name: config-server
  # 如果添加了devtools,需要按照这个处理 Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
  # 不使用默认属性
  devtools:
    add-properties: false
  profiles:
    #active: native
    active: composite
  cloud:
    config:
      ## You can change the priority of all overrides in the client to be more like default values, letting applications supply their own values in environment variables or System propertie
      overrideNone: true
      server:
        composite:
          - type: native
            # target目录下的文件
            search-locations: classpath:/conf/
            # 本地磁盘配置
            #search-locations: D:/temp/springcloud-config-native/conf/
        bootstrap: true

conf/config-info-dev.yaml 文件

testnihao: testNo55555

客户端

bootstrap.yaml

server:
  port: 8082

spring:
  application:
    name: config-client
  profiles:
    active: dev
  cloud:
    config:
      enabled: true
      #如果连接不上获取配置有问题，快速响应失败
      fail-fast: true
      request-read-timeout: 10000
      request-connect-timeout: 10000
      uri: http://localhost:8888/
      name: config-info
      profile: dev
      # 本地多了一层文件夹 :   根目录/demo/config-info-dev.yaml
      label: demo
      # 重试
      retry:
        #下一间隔时间的乘数，默认是 1.1
        multiplier: 1.1
        #默认重试的间隔时间，默认 1000ms
        initial-interval: 1000
        #最大重试次数，默认 6 次
        max-attempts: 6
        #最大间隔时间，最大 2000ms
        max-interval: 2000

URL与配置文件的映射关系
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties

git方式

服务端

application.yaml文件

server:
  port: 8888

spring:
  application:
    name: config-server
  # 如果添加了devtools,需要按照这个处理 Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
  # 不使用默认属性
  devtools:
    add-properties: false
  cloud:
    config:
      ## You can change the priority of all overrides in the client to be more like default values, letting applications supply their own values in environment variables or System propertie
      overrideNone: true
      server:
        bootstrap: true
        git:
          basedir: C:\temp\springcloud-config
          uri: https://gitee.com/nydia/spring-cloud-config-repo.git
          search-paths: conf
          username: *******
          password: **********

conf/config-info-dev.yaml 文件

testnihao: testNo55555

客户端

bootstrap.yaml

server:
  port: 8082

spring:
  application:
    name: config-client
  profiles:
    active: dev
  cloud:
    config:
      enabled: true
      #如果连接不上获取配置有问题，快速响应失败
      fail-fast: true
      request-read-timeout: 10000
      request-connect-timeout: 10000
      uri: http://localhost:8888/
      name: config-info
      profile: dev
      # git仓库的branch
      label: master
      # 重试
      retry:
        #下一间隔时间的乘数，默认是 1.1
        multiplier: 1.1
        #默认重试的间隔时间，默认 1000ms
        initial-interval: 1000
        #最大重试次数，默认 6 次
        max-attempts: 6
        #最大间隔时间，最大 2000ms
        max-interval: 2000

URL与配置文件的映射关系
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties

svn方式

svn方式同git方式，目前使用较少，暂不做介绍

compose结合native，git，svn

服务端

application.yaml文件

server:
  port: 8888
  
spring:
  application:
    name: config-server
  # 如果添加了devtools,需要按照这个处理 Devtools property defaults active! Set 'spring.devtools.add-properties' to 'false' to disable
  # 不使用默认属性
  devtools:
    add-properties: false
  profiles:
    #active: native
    active: composite
  cloud:
    config:
      ## You can change the priority of all overrides in the client to be more like default values, letting applications supply their own values in environment variables or System propertie
      overrideNone: true
      server:
        composite:
          # 根据优先级，自上而下覆盖
          - type: native
            # target目录下的文件
            search-locations: classpath:/conf/
            # 本地磁盘配置
            #search-locations: D:/temp/springcloud-config-native/conf/
          - type: git
            uri: file:///path/to/rex/git/repo
          - type: svn
          	uri: file:///path/to/svn/repo
        bootstrap: true

conf/config-info-dev.yaml 文件

testnihao: testNo55555

客户端

bootstrap.yaml

server:
  port: 8082

spring:
  application:
    name: config-client
  profiles:
    active: dev
  cloud:
    config:
      enabled: true
      #如果连接不上获取配置有问题，快速响应失败
      fail-fast: true
      request-read-timeout: 10000
      request-connect-timeout: 10000
      uri: http://localhost:8888/
      name: config-info
      profile: dev
      # 本地多了一层文件夹 :   根目录/demo/config-info-dev.yaml
      label: demo
      # 重试
      retry:
        #下一间隔时间的乘数，默认是 1.1
        multiplier: 1.1
        #默认重试的间隔时间，默认 1000ms
        initial-interval: 1000
        #最大重试次数，默认 6 次
        max-attempts: 6
        #最大间隔时间，最大 2000ms
        max-interval: 2000

URL与配置文件的映射关系
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties

刷新配置

环境的配置默认是不会自动刷新到程序中的，可使用的刷新方式：
1） 、服务器重启
2）、actuator方式手动刷新
3）、集成消息总线（spring-cloud-bus）自动刷新 / WebHooks
手动刷新和自动刷新都不需要重启服务器，在公司使用中不建议自动刷新，因为对性能不是很好，还是 建议使用手动刷新。（但是自动刷新怕配置是有必要性的）

自动刷新配置的途径：

1、WebHooks动态刷新（git仓库里面调用刷新接口）

2、spring-cloud-bus消息总线动态刷新

spring-cloud-bus动态刷新

springcloud-bus消息总线 + springcloud actuator组件 + rabbitmq 实现动态刷新，可以调用config配置中心的刷新接口（…/actuator/refresh）刷新配置中心后发送mq消息，所有的client端接受到刷新消息会同步更新所有的配置，好处是不用调用每个client的刷新接口刷新配置。

坏处是原来如果没有用rabbitmq那单独为了刷新消息去搞个消息中心，得不偿失。

服务端

pom.xml添加

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-actuatorartifactId>
dependency>
<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-bus-amqpartifactId>
dependency>	

application.yaml添加

spring
  cloud:
    bus:
      trace:
        enabled: true

  #rabbitmq  for auto reflesh config
  rabbitmq:
    host: 127.0.0.1
    port: 5672
    username: guest
    password: guest
    virtual-host: /

#是否开启基本的鉴权，默认为true
security:
  basic:
    enabled: false

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: ALWAYS

客户端

pom.xml文件

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-actuatorartifactId>
dependency>
<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-bus-amqpartifactId>
dependency>

application-dev.yaml文件

spring:
  #rabbitmq  for auto reflesh config
  rabbitmq:
    host: 192.168.23.147
    port: 5672
    username: guest
    password: guest
    virtual-host: /

#打开info,health等断点，所以需要添加management.endpoints.web.exposure.include=*配置，其他的不变
management:
  endpoints:
    web:
      exposure:
        include: '*'
  endpoint:
    health:
      show-details: always

使用配置类的java文件

@RefreshScope

WebHooks动态刷新

暂不做介绍，后续补充

接入Eureka注册中心

Eureka注册中心

pom.xml

<properties>
    <java.version>1.8java.version>
    <spring-cloud.version>2020.0.1spring-cloud.version>
properties>
<dependencies>
    <dependency>
        <groupId>org.springframework.cloudgroupId>
        <artifactId>spring-cloud-starter-netflix-eureka-serverartifactId>
    dependency>

    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-testartifactId>
        <scope>testscope>
    dependency>
dependencies>
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-dependenciesartifactId>
            <version>${spring-cloud.version}version>
            <type>pomtype>
            <scope>importscope>
        dependency>
    dependencies>
dependencyManagement>

application.yaml

server:
  port: 8761

spring:
  application:
    name: cloud-server

eureka:
  server:  
    shouldUseReadOnlyResponseCache: true #eureka是CAP理论种基于AP策略，为了保证强一致性关闭此切换CP 默认不关闭 false关闭  
    enable-self-preservation: false    #关闭服务器自我保护，客户端心跳检测15分钟内错误达到80%服务会保护，导致别人还认为是好用的服务  
    eviction-interval-timer-in-ms: 60000 #清理间隔（单位毫秒，默认是60\*1000）5秒将客户端剔除的服务在服务注册列表中剔除#  
    response-cache-update-interval-ms: 3000  #eureka server刷新readCacheMap的时间，注意，client读取的是readCacheMap，这个时间决定了多久会把readWriteCacheMap的缓存更新到readCacheMap上 #eureka server刷新readCacheMap的时间，注意，client读取的是readCacheMap，这个时间决定了多久会把readWriteCacheMap的缓存更新到readCacheMap上默认30s
    response-cache-auto-expiration-in-seconds: 180   #eureka server缓存readWriteCacheMap失效时间，这个只有在这个时间过去后缓存才会失效，失效前不会更新，过期后从registry重新读取注册服务信息，registry是一个ConcurrentHashMap。
  client:  
    register-with-eureka: true  #false:不作为一个客户端注册到注册中心  
    fetch-registry: false      #为true时，可以启动，但报异常：Cannot execute request on any known server  
    instance-info-replication-interval-seconds: 10  
    service-url:  
      defaultZone: http://127.0.0.1:8761/eureka
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    instance-id: ${spring.application.name}:${eureka.instance.ip-address}:${server.port}
    lease-renewal-interval-in-seconds: 30    # 续约更新时间间隔（默认30秒）
    lease-expiration-duration-in-seconds: 90 # 续约到期时间（默认90秒）   
ribbon:  
  ServerListRefreshInterval: 1000

Application.java

package com.server.eureka;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@EnableEurekaServer
@SpringBootApplication
public class EurekaServerApplication {

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

}

Config服务端

application.yaml

eureka:
  client:
    serviceUrl:
      defaultZone: http://127.0.0.1:8761/eureka/
    register-with-eureka: true
    fetch-registry: false
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    instance-id: ${spring.application.name}:${eureka.instance.ip-address}:${server.port}

Config客户端

bootstrap.yaml

spring:
  cloud:
    config:
      discovery:
        enabled: true
        # config server's application name
        service-id: config-server

application-dev.yaml

eureka:
  client:
    serviceUrl:
      defaultZone: http://127.0.0.1:8761/eureka/
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    instance-id: ${spring.application.name}:${eureka.instance.ip-address}:${server.port}

参考

• 本地配置官方参考 https://cloud.spring.io/spring-cloud-config/reference/html/#_file_system_backend
• 本地配置自动刷新参考 https://blog.csdn.net/goodcto/article/details/102615901
• spring cloud actuator 、spring cloud bus 、webhook https://www.cnblogs.com/spec-dog/p/12371899.html

配置刷新的接口变更

• 服务端的请求刷新的页面由原来1.5.x的localhost:8888/bus/refresh变成：http://localhost:8888/actuator/bus-refresh。
• 老的版本中用 /actuator/bus-flesh , 后来变成了 /actuator/busflesh

问题

• If you are using the git profile, you need to set a Git URI in your configuration. If you have set spring.cloud.config.server.bootstrap=true, you need to use a composite configuration.

• spring-boot的application.yml文件，其中spring.cloud.config.name默认值就是spring.application.name

• springboot2.0.1和springcloud Finchley.SR1 启动遇到的循环依赖问题

  问题现象

  The dependencies of some of the beans in the application context form a cycle:
  
     servletEndpointRegistrar defined in class path resource [org/springframework/boot/actuate/autoconfigure/endpoint/web/ServletEndpointManagementContextConfiguration.class]
        ↓
     healthEndpoint defined in class path resource [org/springframework/boot/actuate/autoconfigure/health/HealthEndpointConfiguration.class]
        ↓
     org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorAutoConfiguration
  ┌─────┐
  |  dataSource
  ↑     ↓
  |  scopedTarget.dataSource defined in class path resource [org/springframework/boot/autoconfigure/jdbc/DataSourceConfiguration$Hikari.class]
  ↑     ↓
  |  org.springframework.boot.autoconfigure.jdbc.DataSourceInitializerInvoker
  └─────┘
  
  

  问题原因：

  DataSourceHealthIndicatorAutoConfiguration
  
  ->  DataSourceAutoConfiguration
  -> DataSourceInitializationConfiguration
  -> DataSourceInitializationConfiguration -> Registrar # registerBeanDefinitions
  -> DataSourceInitializerPostProcessor # postProcessAfterInitialization
  -> DataSourceInitializerInvoker # DataSourceInitializerInvoker(dataSource)
  
  

  调试的时候可以参考下面的流程：

  

​ 参考; curl -X POST http://localhost:8888/actuator/busrefresh