Spring Cloud Config 配置中心

2019-10-17 0 By admin

Spring Cloud Config为分布式系统中的外部化配置提供服务器和客户端支持。
使用Config Server,您可以在所有环境中管理应用程序的外部属性。客户端和服务器上的概念映射与Spring Environment和PropertySource抽象,因此它们非常适合Spring应用程序,并可以与任何语言运行的任何应用程序一起使用。
当应用程序通过部署管道从开发到测试并进入生产时,您可以管理这些环境之间的配置,并确保应用程序具有迁移时需要运行的所有内容。服务器存储后端的默认实现使用git,因此它可以轻松支持配置环境的标记版本,以及可用于管理内容的各种工具。添加替代实现并使用Spring配置插入它们很容易。

一、Spring Cloud Config 特点

Spring Cloud Config Server 功能

  1. 用于外部配置的HTTP,基于资源的API(名称 – 值对或等效的YAML内容)
  2. 加密和解密属性值(对称或非对称)
  3. 使用可轻松嵌入Spring Boot应用程序 @EnableConfigServer

Spring Cloud Config Client 功能

  1. 绑定到Config Server并Environment使用远程属性源初始化Spring
  2. 加密和解密属性值(对称或非对称)

二、Config Server 构建(配置方案:本地文件)

2.1、pom.xml 文件添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

2.2、工程启动类添加注释

package com.miniooc.configserver;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
/**
 * ConfigServerApplication
 */
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigServerApplication.class, args);
    }
}

2.3、工程配置文件

server:
  port: 13801
 
spring:  
  application:
    name: config-server
  profiles:
    active: native # 加载本地配置
  cloud:
    config:
      server:
        native:
          # 不指定路径的话,默认搜索 resources 目录
          search-locations: C:/openspace/springcloud-config-server/config/

三、Config Client 构建

3.1、pom.xml 文件添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

3.2、工程配置文件 bootstrap.yml

spring:
  application:
    name: config-client
  cloud:
    config:
      label: master
      profile: dev
      fail-fast: true
      uri: http://localhost:13801

3.3、工程配置文件 application.yml

客户端从服务端获取资源配置的路径规则如下:

    /{application}/{profile}[/{label}]
    /{application}-{profile}.yml
    /{label}/{application}-{profile}.yml
    /{application}-{profile}.properties
    /{label}/{application}-{profile}.properties

本例,使用的是第二条规则,命名文件。

配置内容:

server:
  port: 52601
 
spring:
  application:
    name: config-client

#生效的配置参数,不适用于yaml
spring.cloud.config.prefile=dev
spring.cloud.config.lable=master
spring.cloud.cofnig.url=http://localhost:7001/

# 配置客户端输出演示用
info: local-config-client-dev

3.4、编写客户端的控制类

package com.miniooc.configclient.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;

/**
 * ConfigClientController
 */
@RestController
public class ConfigClientController {
    @Value("${info}")
    private String info;
    /**
     * 提供的一个restful服务
     *
     * @return 返回  配置中的info信息
     */
    @RequestMapping("/info")
    public String info() {
        return info;
    }
}

四、修改Config Server 配置方案(配置方案:远程Git)

4.1、工程配置文件

server:
  port: 13801
spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          # 配置git仓库的地址
          uri: https://gitee.com/songchuanlu/springcloud-config-repo/
          # git仓库地址下的相对地址,可以配置多个,用,分割。
          # search-paths: config-repo
          # git仓库的账号
          # username:
          # git仓库的密码
          # password:
 
eureka:
  instance:
    hostname: localhost
    # 表示eureka client间隔多久去拉取服务注册信息
    lease-renewal-interval-in-seconds: 15
    # 表示eureka server至上一次收到client的心跳之后,等待下一次心跳的超时时间
    #在这个时间内若没收到下一次心跳,则将移除该instance。
    # 默认为90秒
    # 如果该值太大,则很可能将流量转发过去的时候,该instance已经不存活了。
    # 如果该值设置太小了,则instance则很可能因为临时的网络抖动而被摘除掉。
    # 该值至少应该大于 leaseRenewalIntervalInSeconds
    lease-expiration-duration-in-seconds: 45
  client:
    serviceUrl:
      defaultZone: http://localhost:9527/eureka/

五、修改Config Client 配置(通过服务名访问配置中心)

5.1、工程配置文件

工程配置文件 bootstrap.yml

spring:
  application:
    name: config-client
  cloud:
    config:
      label: master
      profile: dev
      fail-fast: true
      #uri: http://localhost:13801
      discovery:
        enabled: true
        service-id: config-server