查看原文
其他

SpringCloud Config配置中心详解教程

一航 一行Java 2022-08-09


废话不多说,本文是基于SpringCloud Config、SpringCloud Bus实现的配置中心和自动刷新的方案;但是在实际的使用中,这种方式用起来还是有那么一点点别扭;目前的生产环境,并没有使用这种方案,而是基于携程的Apollo来作为配置中心;不同的方式,但是目的只有一个,统一管理配置;咱一个个来慢慢说,在这里先来玩一下SpringCloud Config。

代码下载

点击下载测试源码:https://gitee.com/pengfeilu/spring-boot-config

配置文件地址:https://gitee.com/pengfeilu/config-info

项目说明

项目名端口作用
eureka-server8762服务注册中心
config-server9001配置中心
busi-a8090模拟业务服务a
busi-b8091模拟业务服务b

知识点

本文使用SpringCloud Config、SpringCloud Bus、RabbitMQ、WebHooks实现配置自动刷新,远程Git仓库使用的是码云

基本流程图

  • 流程简单说明一下
    • 第一步,配置中心(Config Server)配置远端的Git,将远端的配置拉去到本地
    • 第二步,业务模块关联配置中心
    • 第三步,配置中心和业务模块全部加到RabbitMQ的消息队列
    • 第四步,远端Git服务器通过WebHooks调用配置中心的接口,通知配置中心,配置文件已经修改了,配置中心获取最新配置
    • 第五步,配置中心向RabbitMQ发送消息,通知要更新消息的服务模块
    • 第六步,服务模块向配置中心获取最新的配置,重新载入 完成更新

准备工作

  • RabbitMQ安装 由于SpringCloud Bus的自动更新需要用到RabbitMQ,因此,提前安装一下,这里使用Docker安装

    • 下载RabbitMQ的镜像

      docker pull rabbitmq:management
    • 运行RabbitMQ 5672 为消息队列的端口 15672 为RabbitMQ的管理平台端口

      docker run --name rabbitmq -p 5672:5672 -p 15672:15672 -d rabbitmq:management
    • 访问管理平台 http://localhost:15672 默认用户名: guest 默认密码: guest

撸码

Eureka Server

关于Eureka Server的部分,这里就不占用篇幅了,可以直接看源码中eureka-server项目,配置很简单,不涉及到任何业务代码,只是作为注册中心。也不是本篇文章的核心部分,需要测试的,只要down一下代码,跑起来就好了。

Config Server
  • 作用 配置中心,用于管理各个项目的配置文件,其他的业务项目通过别名将自己注册到配置中心,这样,就可以通过配置中心来管理各个业务项目的配置文件了,当远端配置文件发生变化的时候,配置最新会获取最新的配置,这个上面也有说过,不再过多赘述。

  • 第一步,创建项目 右键New一个Spring Boot项目,选中,Eureka Client、Config Server、Cloud Bus

  • 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>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.2.RELEASE</version>
            <relativePath/> <!-- lookup parent from repository -->
        </parent>
        <groupId>com.lupf</groupId>
        <artifactId>config-server</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>config-server</name>
        <description>Demo project for Spring Boot</description>

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

        <dependencies>
            <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>
            <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-actuator</artifactId>
            </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>
    • 注意点Spring Boot的版本务必为 > 2.0.2.RELEASE < Cloud的版本为:> Finchley.RELEASE <目前测试了其他的几个版本,都出现WebHook调用能收到通知,但是没有去下载最新的配置并通知MQ更新,以上是我测试成功的版本,如果在使用过程中,出现能收到通知,但是未加载最新配置的问题,可以尝试更换以上两个版本试试
  • application.yml配置 不做多的解释,看注释即可

    #监听的端口
    server:
      port: 9001

    #将自己注册到eureka-server
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8762/eureka

    spring:
      application:
        #服务别名
        name: config-server
      cloud:
        config:
          server:
            git:
              #这里配置git的仓库地址、用户名及密码
              #github的配置
              #uri: https://github.com/xxxx/config-info.git
              #username: xxx@qq.com
              #password: ***
              #以下为码云的地址
              uri: https://gitee.com/xxx/config-info.git
              username: xxxx@qq.com
              password: ***
              #basedir: 用于配置配置文件的本地保存路径 可以自定义路径;注意,务必注意,这里不要将路径配置在项目的根目录,否则整个目录会被清空的
      #rabbitmq的地址信息配置
      rabbitmq:
        host: 192.168.1.208
        port: 5672
    #配置不拦截任何请求
    management:
      endpoints:
        web:
          exposure:
            #这里务必要使用引号引起来,否则yml格式下这里会报错
            include: "*"
    • 注意事项 这里的RebbitMQ的地址以及Git的地址需要根据自己的实际情况调整配置
  • 启动类ConfigServerApplication

    package com.lupf.configserver;

    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.config.server.EnableConfigServer;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

    @SpringBootApplication
    //指明当前项目为一个Eureka的客户端
    @EnableEurekaClient
    //指明当前项目配置中心的服务端
    @EnableConfigServer
    public class ConfigServerApplication {
        public static void main(String[] args) {
            SpringApplication.run(ConfigServerApplication.class, args);
        }
    }
  • 启动项目即可 红框部分为需要注意的一些细节

配置文件说明
常用文件名结构

以下两种结构的配置文件基本就可以满足日常开发的需要 具体选型,也就根据自己的喜好来了...

  • /{name}-{profiles} /{服务名称}-{环境} 如:/busia-dev.yml  或  /busia-test.yml
  • /{label}/{name}-{profiles} /{分支}/{服务名称}-{环境} 如: /master/busi-dev.yml 或者 /master/busi-test.yml
配置示例

以下我们为BUSIA业务项目添加几个需要的配置,如下图:具体配置可以点此查看详细内容

https://gitee.com/pengfeilu/config-info

  • busia.yml 项目的基础配置,数据库连接及RebbitMQ的配置
  • busia-dev.yml
  • busia-test.yml
  • 配置中心测试 本地访问: http://127.0.0.1:9001/busia-dev.yml 可以看到以下结果,说明配置最新启动已经正常
  • 配置测试结果分析 1.busia.yml配置由于没有指定环境,不符合使用命名条件,无法在项目中直接使用 2.busia.yml会自动合并到下属配置中,如busia-dev.yml会自动把busia.yml下的配置合并到一起使用,这一点务必要注意,刚刚使用的时候,可能会在这里踩坑,发现不管怎么改都不生效。3.综合1、2点,busia.yml这种以服务名命的配置适合放基础配置,即不管什么环境下都需要使用的,如数据库连接配置,其他个性化的,开发中的配置就放到环境节点即可。
业务服务(BUSI-A)使用CONFIG
创建项目

右键New一个名为busi-a的Spring Boot项目,选中,Eureka Client、Config Server、Cloud Bus、MySql 为了测试,我们添加了数据库相关配置,这里不做任何关于数据库的业务功能

配置
  • 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>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.2.RELEASE</version>
            <relativePath/> <!-- lookup parent from repository -->
        </parent>
        <groupId>com.lupf</groupId>
        <artifactId>busi-a</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>busi-a</name>
        <description>Demo project for Spring Boot</description>
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-client</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>
            <!--java的mysql连接客户端-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.41</version>
            </dependency>
            <!--使用阿里巴巴的druid的mysql连接池-->
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid-spring-boot-starter</artifactId>
                <version>1.1.10</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
                <version>5.1.5.RELEASE</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-bus-amqp</artifactId>
            </dependency>
            <!-- actuator -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.6</version>
                <scope>provided</scope>
            </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>
  • application.yml

    spring:
      application:
        #这里是服务名称
        name: busia
      cloud:
        config:
          discovery:
            enabled: true
            #这里是配置中心的服务名称
            service-id: CONFIG-SERVER
          #模块名称 他与服务名称一起组成了配置中心的配置文件指向,如 busia-dev.yml
          profile: dev

    #将自己注册到eureka-server
    #这里需要把eureka server的配置配到这里,防止eureka的端口不是默认的8761时 导致找不到注册中心的地址,从而获取不到配置
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8762/eureka
  • 项目入口

    @SpringBootApplication
    @EnableEurekaClient
    @RestController
    //自动刷新配置的注解,这里务必要加上 否则Spring Cloud Bus自动刷新不会生效
    @RefreshScope
    public class BusiAApplication {

        public static void main(String[] args) {
            SpringApplication.run(BusiAApplication.class, args);
        }
    }
  • 启动项目

    • 异常现象 这里会出现找不到数据库配置的问题查看配置均无问题

    • 原因分析:我们来想一下我们加入配置中心之后,项目启动的流程,我们先是通过config-server获取到相关的配置,然后业务项目在启动的时候,匹配相应的配置,启动,由于上面我们加入了数据库,如果使用application.yml的方式,那么SpringBoot就不知道优先加载那个,然后就直接去加载数据库相关的配置了,因此就没有找到,导致以上的报错。因此,并不是指这里的配置有问题,而是说,项目启动的先后顺序问题

    • 解决方案 为了解决这个问题的方式就是将application.yml重命名为bootstrap.yml;优先载入相关配置,这样,项目启动的时候,就会优先从CONFIG-SERVER中去获取最新的配置文件(其中就包含了数据库相关的配置),然后再启动项目,这样就可以正常加载数据库相关的配置了。

  • 自动刷新配置文件类编写上图所示,假定红框部分的内容为需要自动刷新的部分,为此,我们编写以下配置文件加载类:

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

    @Component//改对象交由spring管理
    @Data//limbok自动添加get set方法
    @ConfigurationProperties(prefix = "ser.admin") //自动扫描配置文件中的配置前缀(即:前缀扫描)
    @RefreshScope //允许spring cloud bus自动刷新该配置 这个注解很重要,不加自动刷新无法实现
    public class SerAdminUserConfig {
        private String name;

        private String pwd;

        private String status;
    }

    注:代码里面务必要加@RefreshScope 注解,否则自动刷新将无效;

  • 添加测试接口 在启动类中添加一个接口,用于返回以上配置对象中加载的值;

    @SpringBootApplication
    @EnableEurekaClient
    @RestController
    //自动刷新配置的注解,这里务必要加上 否则Spring Cloud Bus自动刷新不会生效
    @RefreshScope
    public class BusiAApplication {

        public static void main(String[] args) {
            SpringApplication.run(BusiAApplication.class, args);
        }
        @Autowired
        SerAdminUserConfig serAdminUserConfig;

        @GetMapping("/adminuser")
        public String getAdminUser() {
            return serAdminUserConfig.toString();
        }
    }

    访问: http://127.0.0.1:8090/adminuser说明BUSI-A的配置文件已经从配置中心获取成功,且配置对象也成功的加载了配置文件中的数据

业务服务(BUSI-B)

该项目只是为了测试多业务项目的情况,没有别的什么作用,这里不做说明

RabbitMQ队列查看

由于我们将config-server和busi-a都添加了rabbitMQ,因此,项目启动之后,在MQ中自动创建了两个队列;这两个队列也是后续做自动刷新的重要部分;项目启动之后,记得来看一下队列是否自动创建成功了;如果有更多的项目使用了配置中心,那么就是启动了多少个服务,这里就会存在多少个队列;

自动刷新配置

以上是一个基础的基于配置中心的项目环境,还并不具备自动刷新的功能,这部分就是用来讲解,如何使用码云的WebHooks来自动刷新配置;

  • WebHooks刷新的基本流程 第一步:config-server对外暴露了一个bus-refresh的接口,用于刷新配置的接口(可以理解为回调接口) 第二步:在远端GIT或者SVN服务器的WebHooks下配置config-server暴露的接口 第三步:当远端的配置发生变化时,WebHooks会通过post调用config-server的接口 第四步:config-server收到回调之后,拉取最新的配置,然后刷新含有@RefreshScope注解的配置
准备工作
  • natappNatapp 免费的内网穿透(官网)由于我们在本地做的测试,所有的代码没有映射到公网,但是我们的配置文件是放在码云上面,码云的服务器是没有办法调用我们本地内网服务的,因此,这里使用natapp作为内网穿透,将我们的内网接口通过一个域名对外暴露出去,具体的使用,可以去Natapp的官网查看,这里就不花篇幅去说这个了,官网说的也很清楚;实际的生产环境也不需要这样,我们的服务也都是可以直接映射到公网ip下,所以,也不用做什么内网穿透了,以下是我配置好的截图:可以看到,域名 http://niy59p.natappfree.cc 映射到我本地  http://127.0.0.1:9001  (9001的端口为我的config-server端口),具体映射的端口是在natapp官网上面配置的
码云WebHooks配置

在WebHooks下添加  http://niy59p.natappfree.cc/monitor 即可,前面的域名为natapp的域名

测试修改配置

测试前,我们可以将config-server和busi-a项目控制台的日志全部清理掉,然后修改码云上busia-dev.yml中的配置并提交

  • config-server控制台日志可以看到config-server成功收到了回调并获取了最新的配置文件

  • busi-a控制台日志可以看出busi-a也已经拿到了最新的日志并且已经重新载入了

  • RabbitMQ控制台可以看出消息已经成功到达了RabbitMQ且也成功的消费了

  • 测试配置接口配置文件已经成功更新且已经成功载入了

  • 总结 以上测试,我们发现,项目并没有重新启动,但是配置即自动刷新了,看到这一瞬间,不知道在看的各位有没有肾上腺蹭的一下上去呢,反正我是忍不住加快了右手的节奏(点鼠标)。

总结

微服务架构,是由一个个微小的服务集合而成的一个一套系统,服务多了,维护的成本自然就高了,配置中心的存在不仅方便了开发过程中多个同事,多个项目组之间的协同开发,同时也方便了线上配置的维护与管理,所有的配置都统一在一个地方去处理就好,从而避免了节点、集群、开发环境配置不一致的问题;再加上通过SpringCloud Bus,让配置文件能够自动刷新(这也应该是微服务应该必须有的一个效果),舒坦!!!

- END -
推荐阅读
TCP/IP十大问题详解,摩擦面试官必备技能
一文轻松搞定ELK日志实时采集分析平台
手摸手一小时从0搭建专属个人博客(视频教程)
BeanUtils性能不高!要不来试试这款PO、VO、DTO对象转换工具


点击在看,分享给小伙伴吧!
感谢支持!

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存