SpringCloud之spring-cloud-config-

作者: 青衣敖王侯 | 来源:发表于2019-04-21 15:31 被阅读10次

1.为什么需要统一配置中心

1.1方便维护

在项目开发中，大家肯定都会对同一个配置文件做修改，有时候A希望使用这个配置开发，B希望临时更改一个配置然后在测试一下，等等然后配置文件就该乱了，导致配置非常难维护

1.2配置内容安全与权限

在大公司里面，我们从来都不会在配置文件中看到数据库的密码以及其他一些敏感的配置信息，所以把关键的配置信息隔离出来是非常有必要的

1.3更新项目配置需要重启

这个就不多说了~

2.统一配置中心架构

架构图

统一配置中心有一个config-server端，它会从远端的git拉取配置，并且同步到本地git中，所以即使远端git挂掉了，本地git依然能够提供支持。右边的product和order两个微服务是统一配置的客户端，可以从config-server获取配置。

3.configServer端配置

3.1依赖

pom.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<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>

    <groupId>com.imooc</groupId>
    <artifactId>config</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>config</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR2</spring-cloud.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
        </dependency>

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

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3.2注解

main函数上面加注解，注意，即是eureka的客户端，同时又是config的server端

@SpringBootApplication
@EnableDiscoveryClient
@EnableConfigServer
public class ConfigApplication {

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

3.3配置

在application.yml中加相应的配置

spring:
  application:
    name: config
  cloud:
    config:
      server:
        git:
          uri: https://gitlab-demo.com/SpringCloud_Sell/config-repo.git
          username: mikezzmeric
          password: 嘿嘿嘿嘿
          basedir: /Users/admin/code/myProjects/java/imooc/SpringCloud_Sell/config/basedir
eureka:
  client:
    service-url:
      defaultZone: http://eureka1:8761/eureka/,http://eureka2:8762/eureka/
management:
  endpoints:
    web:
      expose: "*"

上面的配置文件中配置了git地址，这样我们可以从git上获取配置文件
同时也把自己注册到eureka上，作为一个微服务
baseDir是什么意思呢，因为统一配置中心是要把配置文件从服务器上放到本地存储一份，这个baseDir就是存储配置文件的路径

3.4启动应用

访问http://localhost:8080/order-a.yml或者http://localhost:8080/order-b.yml我们发现都有输出而且与git上的配置文件一模一样，但是如果访问http://localhost:8080/order.yml就会什么都看不到

为什么会这样？！我们可以看一下ConfigServer时候，控制台输出的信息如下图：

通过控制台我们可以看到很多访问配置文件的形式和格式。这里我们换成properties去访问这个路径会发现和之前通过yml的形式去访问又不一样了

假设我们故意写错配置文件，然后再次通过yml的形式去访问，我们再来看一下结果：

其实这里有两种常用的配置文件规则(个人倾向于用/{name}-{profiles}.yml文件)：

为了理解这两种常用的配置文件规则，我们在git上在创建一个order-dev.yml的配置文件，相比于刚才的order.yml多出一个配置项，如下图所示，以表示区分：

我们访问一下order-dev这个配置文件：

特别注意一下，在浏览器这里我输入的是order-dev这个文件是在远程仓库中有的文件名，而刚才我输入order.yml却报错了，一定要注意这个细节，我后面会讲为什么会这样！接下来我们在git上再创建一个分支release，并且将release分支的order-dev.yml做一点修改：

接下来我们按照label的形式来访问一下配置文件，也可以访问到对应的文件：

到这里为止，我还是没有给大家解答为什么order.yml不能访问，但是order-a.yml能访问的问题，这里先卖个关子，大家先回忆一下在教程开篇的时候我们提到过，config-server会把配置文件从git端放到本地，那么我们访问到的配置文件究竟放到哪里了呢？我们可以看一下控制台的日志：

我们在线上的时候，不可能有这么一个随意的路径，那怎么更改这个路径呢：

4.configServer Client端

好了3中的遗留问题我们就放在这里给大家解答，在此之前我们看一下Client是如何搭建的。

4.1pom.xml

引入config-client的客户端即可

4.2bootstrap.yml

很奇怪为什么不再是application.yml了，而是bootstrap.yml了，首先这里的bootstrap不是前端的bootstrap，之所以使用bootstrap.yml是因为我们现在要从配置中心去获取数据库的配置，如果使用application.yml这个配置文件去配置中心获取配置，我们会发现数据库无法正常连接，因为springboot不知道是从config-server拿配置在前还是先连接数据库在前，所以我们使用bootstrap.yml这个文件可以解决这个问题。

spring:
  application:
    name: order
  cloud:
    config:
      discovery:
        enabled: true
        service-id: CONFIG
      profile: test
eureka:
  client:
    service-url:
      defaultZone: http://eureka1:8761/eureka/,http://eureka2:8762/eureka/
  instance:
    prefer-ip-address: true

service-id:CONFIG表示配置中心的ID，profile表示要获取的是哪一个配置文件。
启动客户端应用的时候，我们的client端会去访问eureka，通过eureka拿到config服务所在的地址，然后在通过这个服务地址去获取配置文件。这里我们回答一下3中留下的问题，我们可以在访问order-test.yml的时候，通过截图我们可以看到访问了两个配置文件，order.yml和order-test.yml，两个配置文件访问后，会做合并返回给客户端，这就是为什么即使我们输入不存在的order-a.yml也能正确返回文件的原因。所以我们会把公共的配置放在order.yml中！

5.SpringCloudBus自动刷新配置

我们之前讲的ConfigServer还不能做到配置更新后不重启服务器，要做到不重启，我们需要借助SpringCloudBus这个东西。我们可以回想一下，为什么之前我们做不到配置实时更新呢？原因就是配置更新后，没有将更新通知到对应的服务。所以我们这里需要借助一个消息队列，当发生更新后，让消息队列来通知各个服务。configServer引入了Bus之后，会提供一个bus-refresh的http接口，通过这个接口可以告诉config-server配置更新了，从图里面我们可以看出git可以在更新后访问这个接口来告诉config-server。

5.1ConfigServer端配置

5.1.1pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<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>

    <groupId>com.imooc</groupId>
    <artifactId>config</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>config</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR2</spring-cloud.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
        </dependency>

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

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

5.1.2application.yml配置

spring:
  application:
    name: config
  cloud:
    config:
      server:
        git:
          uri: https://github.com/mikezzmeric/config-repo.git
          username: mikezzmeric
          password: 嘿嘿
          basedir: F:/SpringCloud/config/basedir
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/,http://localhost:8762/eureka/
management:
  endpoints:
    web:
      expose: "*"

这里要把management配置出来，否则bus-refresh接口暴露不出来

5.2Order端配置

5.2.1pom.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<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>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.configclient</groupId>
    <artifactId>order</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>order</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.SR2</spring-cloud.version>
    </properties>

    <dependencies>
        <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>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

5.2.2Config

package com.configclient.order.com.configclient.order.controller.zzmconfig;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.stereotype.Component;

@Data
@Component
@ConfigurationProperties(prefix = "girl")
@RefreshScope
public class ZZMConfig {

    private String name;

    private Integer age;
}

一定要加上RegreshScope，否则完全即使修改了文件内容，也不会更新配置

5.2.3Controller

package com.configclient.order.com.configclient.order.controller;

import com.configclient.order.com.configclient.order.controller.zzmconfig.ZZMConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ZZMController {
    @Autowired
    private ZZMConfig zzmConfig;

    @GetMapping("/zzm/print")
    public String print(){
        return "name:" +zzmConfig.getName()+",age:"+zzmConfig.getAge();
    }
}

5.2.4更新配置

当在git上修改对应的配置文件后，发起post请求

5.2.5查看结果

image.png

这样可以不启停应用，配置也更新了,但是我们发现，每次更新完成后，都必须要发起一个post请求，能否有办法自动触发这个更新呢？答案是在github上配置一个webhooks，可以参考下图：

注意图中写的不再是bus-refresh而是使用的monitor，这里是一个细节要注意一下。

好的，SpringCloud配置中心就讲到这里，欢迎大家指正