spring cloud config

Posted 2020-11-03

config的用途？
将cloud中各微服务的配置文件外部集中化，实行统一管理。尤其在一个服务负载时，配置的集中管理将显得非常方便。

spring cloud config 的使用
* config client
1.dependcy

 <dependency>
            <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-config</artifactId>
            <version>1.3.1.RELEASE</version>
 </dependency>

2.引入bootstrap.yml配置文件
这个文件的作用就是，在application启动的时候加载这些配置。它是applicationContext的父级上下文，而application.yml配置文件对应的是applicationContext。bootstrap.yml的配置将是application默认的配置参数，可以设置被application的相同参数所override.比如：

spring:
  cloud:
    config:
      allow-override: true
      name: web-demo
      uri: http://localhost:8888
      fail-fast: true
      profile: test
            retry:
        initial-interval: 1000
        max-attempts: 6
        max-interval: 2000

spring.cloud.config.allow-override用于参数是否允许被覆盖；
spring.cloud.config.name微服务的配置{application}名称，如果不设置默认采用spring.application.name;
spring.cloud.config.uri指的是spring cloud config server 的uri，默认是localhost:8888;
spring.cloud.config.fail-fast指的是如果连接不上直接启动失败；
spring.cloud.config.profile指的是当前使用哪个配置文件,通常有dev、test、pro；
spring.cloud.config.usernam连接用户名
spring.cloud.config.password连接密码
spring.cloud.config.retry.inital-interval失败重连的间隔；
spring.cloud.config.retry.max-interval失败重连的最大间隔；
spring.cloud.config.retry.max-attempts失败重连得最大次数；

3.远程配置文件的使用
使用起来很简单，可以在application.yml等配置文件中通过${}来引入；也可以像application.yml的配置参数直接通过注解被java代码使用。比如：
config server中web-demo-test.yml的配置参数：

#sys config
server:
  port: 8081

#business config
user:
  username: yangyc
  password: 123456

config client 中application-test.yml的配置参数：

server:
  port: ${server.port}

#business config
user:
  username: ${user.username}
  password: ${user.password}

注：其中${server.port}就会使用config server 的参数来替换；

* config server
1.depandcy

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
    </dependencies>

2.启动时增加@EnableConfigServer 注解

@SpringBootApplication
@EnableConfigServer
public class ConfigDemoApplication {

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

3.config backend 存储的分类
3.1 native本地存储

spring.application.name=config-demo
server.port=8888
spring.profiles.active=native
spring.cloud.config.server.native.search-locations=classpath:/config/{application}
spring.cloud.config.server.native.add-label-locations=false
spring.cloud.config.server.accept-empty=false
logging.level.root=debug

spring.profiles.active:配置文件的类型。native本地文件；jdbc/svn/git/vault。
spring.cloud.config.server.native.search-locations:本地文件路径。可以是磁盘文件，也可以是classpath;
注：path中可以使用占位符{application}、{profiles}、{label}。也就是文件目录中可以对应创建相应目录，从而达到动态适配的效果。
spring.cloud.config.server.native.add-label-locations:表示配置文件目录是否包括label。
spring.cloud.config.server.accept-empty：表示是否允许获取空数据。

3.2 JDBC存储
增加依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

配置数据源

spring.datasource.url=
spring.datasource.username=
spring.datasource.password=

配置config server

spring.profiles.active=jdbc
spring.cloud.config.server.jdbc.sql=SELECT `KEY`,`VALUE` FROM PROPERTIES WHERE APPLICATION =? AND `PROFILE`=? AND LABEL=?
spring.cloud.config.server.jdbc.order=0

注：其中APPLICATION对应的是{application}，PROFILE对应{profile},LABLE对应{label}。会自动设置。

数据库建表

create table PROPERTIES
(
  APPLICATION VARCHAR(100),
  `PROFILE`  VARCHAR(100),
  LABEL VARCHAR(100),
  `KEY` VARCHAR(100),
  `VALUE` VARCHAR(100)
) ENGINE=INNODB DEFAULT CHARSET=UTF8;

3.3 SVN存储
增加依赖

         <dependency>
            <groupId>org.tmatesoft.svnkit</groupId>
            <artifactId>svnkit</artifactId>
            <version>1.9.2</version>
      </dependency>

spring.profiles.active=subversion
spring.cloud.config.server.svn.uri=
spring.cloud.config.server.svn.username=
spring.cloud.config.server.svn.password=
spring.cloud.config.server.svn.default-label=config
spring.cloud.config.server.svn.search-paths=

spring.profiles.active=subversion 表示配置文件使用的backend方式
spring.cloud.config.server.svn.uri表示SVN仓库地址
spring.cloud.config.server.svn.username用户名
spring.cloud.config.server.svn.password密码
spring.cloud.config.server.svn.default-label必须配置Git也是一样，指的是uri下的最后一级目录，默认是trunk，否则需要指定。
spring.cloud.config.server.svn.search-paths指的是本地仓库的获取地址

3.4 git存储

spring.profiles.active=git
spring.cloud.config.server.git.basedir=
spring.cloud.config.server.git.clone-on-start=false
spring.cloud.config.server.git.force-pull=true
spring.cloud.config.server.git.host-key=
spring.cloud.config.server.git.host-key-algorithm=
spring.cloud.config.server.git.delete-untracked-branches=true
spring.cloud.config.server.git.ignore-local-ssh-settings=true
spring.cloud.config.server.git.known-hosts-file=
spring.cloud.config.server.git.order=1
spring.cloud.config.server.git.passphrase=
spring.cloud.config.server.git.password=
spring.cloud.config.server.git.preferred-authentications=
spring.cloud.config.server.git.private-key=
spring.cloud.config.server.git.refresh-rate=
spring.cloud.config.server.git.search-paths=
spring.cloud.config.server.git.strict-host-key-checking=true
spring.cloud.config.server.git.timeout=5
spring.cloud.config.server.git.uri=
spring.cloud.config.server.git.username=

spring.cloud.config.server.git.basedir：像SVN/GIT会先将remote中的文件check out / clone到本地，默认是/temp临时目录下，但有些操作系统会将临时文件删除，因而需要修改对应的目录。而这个配置文件也就是配置本地库的地址。
spring.cloud.config.server.git.force-pul：指是否从remote 仓库中强拉取最新数据。
spring.cloud.config.server.git.uri：remote repository地址
spring.cloud.config.server.git.username:用户名
spring.cloud.config.server.git.password:密码
spring.cloud.config.server.git.search-paths：uri下的子目录，是可以使用占位符{application}

spring:
  cloud:
    config:
      server:
        git:
          uri: https://git/common/config-repo.git
          repos:
            team-a:
                pattern: team-a-*
                cloneOnStart: true
                uri: http://git/team-a/config-repo.git
            team-b:
                pattern: team-b-*
                cloneOnStart: false
                uri: http://git/team-b/config-repo.git
            team-c:
                pattern: team-c-*
                uri: http://git/team-a/config-repo.git

3.5 Vault 存储

spring.profiles.active=vault
spring.cloud.config.server.vault.host=
spring.cloud.config.server.vault.port=
spring.cloud.config.server.vault.scheme=http
spring.cloud.config.server.vault.profile-separator=,
spring.cloud.config.server.vault.order=1
spring.cloud.config.server.vault.backend=secret

3.6 多种类型复合使用

spring:
  profiles:
    active: git, svn
  cloud:
    config:
      server:
        svn:
          uri: file:///path/to/svn/repo
          order: 2
        git:
          uri: file:///path/to/git/repo
          order: 1

3.7 通过实现EnvironmentRepository，自定义获取配置参数
http://www.mamicode.com/info-detail-1784908.html

参考文档
http://cloud.spring.io/spring-cloud-static/spring-cloud-config/2.0.0.RC1/single/spring-cloud-config.html
https://springcloud.cc/spring-cloud-config.html