Spring Cloud Config

Posted 2021-02-11 超轶绝尘

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Cloud Config相关的知识，希望对你有一定的参考价值。

一、分布式系统面临的--配置问题

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

二、SpringCloud Config 是什么？

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

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

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

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

3、配置服务器默认采用Git来存储配置信息。这样有助于对环境配置进行版本管理，并且可以通过Git客户端工具来方便地管理和访问配置内容

三、SpringCloud Config 能干嘛

1、集中管理配置文件

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

3、运行期间动态调整配置，不再需要在每个服务部署的机器上编写配置文件，服务会向配置中心统一拉取配置自己的信息

4、当配置发生变动是，服务不需要重启即可感知到配置文件的变化并应用新的配置

5、将配置信息以REST接口的形式暴露

6、由于SpringCloud Config默认使用Git来存储配置文件（也有其他方式，比如支持SVN和本地文件），但最推荐的还是Git，而且使用的是http/https访问的形式

四、SpringCloud Config 服务端使用步骤

application.yml

spring: 
    profiles: 
        active: 
            - dev
---
spring: 
    profiles: dev #开发环境
    application: 
        name: microservicecloud-config-everjiankang-dev
---
spring: 
    profiles: test #测试环境
    application: 
        name: microservicecloud-config-everjiankang-test
#请保存为UTF-8编码格式

*注意*：profiles 和application是平级，一开始把application写在了profiles下面，结果一直报错

将yml文件推送到git上

git add .

git commit -m "init yml"

git push origin master

新建项目microservicecloud-config-3344

pom.xml

<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>
        <!-- 图形化监控 -->
        <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>

application.yml

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

主启动类

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

修改host文件：

127.0.0.1　　config-3344.com

测试通过config微服务是否可以从github上获取配置内容

1）启动3344项目

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

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

4）http://config-3344.com:3344/application-xxx.yml (不存在的配置)

官网

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

http://localhost:3344/application/dev/master

http://localhost:3344/application/test/master

http://localhost:3344/application/dev/master

http://localhost:3344/master/application-dev.yml

五、SpringCloud Config 客户端使用步骤

1、新建microservicecloud-config-client.yml并提交到github

spring: 
    profiles: 
        active: 
            一 dev
---

server: 
    port: 8201
sprlng : 
    profiles: dev
    application: 
        name: microservicecloudconfig-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-dev.com:7001/eureka/

2、新建项目microservicecloud-config-config-3355

设置pom.xml

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

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\'配置的分离。

bootstrap.yml

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

application.yml

spring:
  application:
    name: microservicecloud-config-client

配置host映射

127.0.0.1    client-config.com

创建Controller，从gitHub的配置文件中获取信息

package com.everjiankang.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;
    }
}

主启动类

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

启动配置中心3344微服务

启动3355微服务作为client访问3344微服务

3355微服务的bootstrap.yml里的profile的值是什么，决定github上读取什么

3355微服务作为client访问3344微服务通过github获取配置信息

以上是关于Spring Cloud Config的主要内容，如果未能解决你的问题，请参考以下文章

无法通过 spring.cloud.config.enabled:false 禁用 Spring Cloud Config

0701-spring cloud config-简介Config Server开发Config Client开发

问题 spring-cloud-config 和 spring-cloud-bus

spring-cloud-config——Quick Start

spring cloud config 8888端口可以变么

spring cloud 学习 - config server