SpringCloud(六)-手把手教你搭建SpringCloud Config配置中心


1. 新建springcloud-config-server-8600

新建springcloud-config-server-8600 子项目，用来管理配置文件

springcloud 统一配置中心_ide

8600的项目结构

1.1 pom.xml依赖

其中springcloud-config-server-8600的pom.xml配置如下，主要是引入spring-cloud-config-server。

<?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">
    <parent>
        <artifactId>springcloudtest</artifactId>
        <groupId>com.elio.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springcloud-config-server-8600</artifactId>

    <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-web</artifactId>
        </dependency>
    </dependencies>
</project>

1.2 application.yml配置

application.yml的配置内容如下,其中git地址，账号，密码需要根据自己的实际情况来配置。

server:
 port: 8600 #端口号

spring:
 application:
   name: springcloud-config-server # 应用名称
 cloud:
   config:
     server:
       git:
         uri: https:  #git地址
         username:  # git账号名
         password: # git账号密码

eureka:
 instance:
   instance-id: ${spring.application.name}:${server.port}
 client:
   fetch-registry: true
   register-with-eureka: true
   service-url:
     defaultZone: http://localhost:8300/eureka/,http://localhost:8301/eureka/

1.3 ConfigServer8600主启动类

ConfigServer8600主启动类内容如下，主要是加的是@EnableConfigServer这个注解

package com.elio.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableDiscoveryClient
@EnableConfigServer
public class ConfigServer8600 {
    public static void main(String[] args){
        SpringApplication.run(ConfigServer8600.class, args);
    }
}

2. 新建springcloud-config-server仓库

2.1 新增springcloud-config-server仓库

登录码云账户，然后点击菜单栏的新建仓库按钮，跳转后输入仓库的基本信息。

springcloud 统一配置中心_springcloud 统一配置中心_02

新增仓库

springcloud 统一配置中心_spring_03

填写仓库信息

springcloud 统一配置中心_springcloud 统一配置中心_04

点击创建

点击新增文件 > 新建configtest-pro.yml配置文件，文件内容如下

hello from configtest-pro

点击新增文件 > 新建configtest-dev.yml配置文件，文件内容如下

hello from configtest-dev

springcloud 统一配置中心_ide_05

新建配置文件

springcloud 统一配置中心_spring_06

新增configtest-dev.yml

springcloud 统一配置中心_springcloud 统一配置中心_07

最终仓库如下

2.2 修改配置

找到springcloud-config-server-8600项目的application.yml配置，配置仓库的路径，git账号和密码等信息。

cloud:
    config:
      server:
        git:
          uri:  #git地址
          username: # git账号名
          password:  # git账号密码

2.3 测试

依次启动启动eureka-server-8300、eureka-server-8301、config-server-8600后，在浏览器中输入地址

http://localhost:8600/configtest-pro.yml

springcloud 统一配置中心_配置文件_08

configtest-pro.yml

http://localhost:8600/configtest-dev.yml

springcloud 统一配置中心_ide_09

configtest-dev.yml

 

可见都已成功的通过配置中心访问到git上的配置文件内容，接下来就是要通过config客户端来访问了我们的配置文件内容了。

3. config客户端配置

3.1 product-provider-8100修改

我们复用product-provider-8100这个子项目作为配置客户端，就不新增新的子项目了。

springcloud 统一配置中心_ide_10

product-provider-8100结构

3.1 新增bootstrap.yml配置

bootstrap.yml配置文件内容如下，其中eureka相关配置在此不详述了。其中

  • spring.cloud.config.name 配置文件名
  • spring.cloud.config.profile 配置的策略pro-生产 test-测试 dev-开发
  • spring.cloud.config. master 分支
  • spring.cloud.config. discovery.enabled 开启配置信息发现
  • spring.cloud.config. discovery.service-id 指定配置中心的service-id
spring:
  cloud:
    config:
      name: configtest # 获取配置文件的名称
      profile: pro # 配置的策略pro-生产 test-测试 dev-开发
      label: master # 分支
      discovery:
        enabled: true # 开启配置信息发现
        service-id: springcloud-config-server # 指定配置中心的service-id
eureka:
  instance:
    instance-id: ${spring.application.name}:${server.port}
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:8300/eureka/,http://localhost:8301/eureka/

3.2 pom.xml引入依赖

pom.xml引spring-cloud-config-client入依赖

<!--config-client -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-client</artifactId>
        </dependency>

3.3 编写测试方法

ProductProviderController中新增方法，其中hello就是配置文件中的键值。

@Value("${hello}")
    private String hello;

    @GetMapping("product/provider/get/config/info")
    public Result getConfigInfo()throws Exception{
        return new Result(200,"",this.hello);
    }

3.4 启动测试

依次启动启动eureka-server-8300、eureka-server-8301、config-server-8600、product-provider-8100后，在浏览器中输入地址

http://localhost:8100/product/provider/get/config/info

springcloud 统一配置中心_配置文件_11

成功返回配置中心的结果

3.5 修改远程配置文件

现在码云上有配置文件，但是实际生产中，我们会经常修改配置，现在假如修改配置提交，将configtest-pro.yml内容修改如下，表示修改了一次。

hello: hello from configtest-pro modified once

springcloud 统一配置中心_spring_12

image.png

然后再次在浏览器中输入,发现没有动态刷新http://localhost:8100/product/provider/get/config/info

springcloud 统一配置中心_配置文件_13

image.png

4. 实现手动刷新

动态刷新是当远程配置文件修改后，客户端获取的配置能够实时刷新。

4.1 添加@RefreshScope注解

要实现动态刷新，我们需要在product-provider-8100项目的 ProductProviderController中加上
@RefreshScope注解，表示要刷新。

@RestController
@Slf4j
@RequestMapping("/")
@RefreshScope
public class ProductProviderController {

4.2 修改bootstrap.yml配置

还要修改product-provider-8100项目的bootstrap.yml配置文件添加如下内容

management:
  endpoints:
    web:
      exposure:
        include: refresh,health

4.2 pom.xml引入监控依赖

修改product-provider-8100项目的pom.xml添加如下配置

<!-- actuator监控信息完善 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

4.3 测试

实现动态刷新的相关依赖和配置我们都已经操作完毕，接下来就是测试。
首先修改码云上configtest-pro.yml的配置文件，将文件内容修改如下

hello: hello from configtest-pro modified twice

springcloud 统一配置中心_ide_14

修改configtest-pro.yml

然后访问链接，依旧没有刷新
http://localhost:8100/product/provider/get/config/info

springcloud 统一配置中心_springcloud 统一配置中心_15

依旧没有刷新

我们还差一步，需要通过post请求方式去访问api[http://localhost:8100/actuator/refresh]来刷新配置文件，打开cmd使用curl命令来访问

curl -X POST http://localhost:8100/actuator/refresh

springcloud 统一配置中心_ide_16

访问结果

然后访问链接http://localhost:8100/product/provider/get/config/info

springcloud 统一配置中心_springcloud 统一配置中心_17

发现实时刷新了

以上就是实现动态刷新的基本内容了。

5 总结

本文简单的介绍了如何通过搭建config配置中心来获取远程配置的文件内容，但是问题就是每次修改了远程配置文件，都要访问http://localhost:8100/actuator/refresh刷新接口，微服务较少还好，微服务过多的话，我们就很难实现手动刷新了，所以下一篇文章将介绍如何通过Bus总线来实现自动刷新。