Spring Cloud实战系列(六) - 分布式配置中心Spring Cloud Config

原创

mb5ff97fc6948e0 2021-02-05 18:19:38 ©著作权

文章标签 java 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mb5ff97fc6948e0的原创作品，请联系作者获取转载授权，否则将追究法律责任

前言

在分布式系统中，由于服务数量巨多，为了方便服务配置文件的统一管理和实时更新，所以需要分布式配置中心组件。 SpringCloud 提供的分布式配置中心组件是 SpringCloudConfig，它支持将配置服务放在配置服务的内存中（即本地），也支持放在远程 Git 仓库中。 SpringCloudConfig 提供了两个角色，其一是 ConfigServer，其二是 ConfigClient。

正文

1. Config Server从本地读取配置文件

创建一个新的 SpringBoot 项目模块，取名为 config-server，它的 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>1.5.3.RELEASE</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <groupId>io.github.ostenant.springcloud</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>Dalston.RELEASE</spring-cloud.version>

    </properties>


    <dependencies>

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-config-server</artifactId>

        </dependency>


        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-test</artifactId>

            <scope>test</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>

在应用启动类上使用注解 @EnableConfigServer 开启配置服务器。

@EnableConfigServer

@SpringBootApplication

public class ConfigServerApplication {


    public static void main(String[] args) {

        SpringApplication.run(ConfigServerApplication.class, args);

    }

}

需要在程序的配置文件 application.properties 里面进行如下配置。通过 spring.profile.active=native 来配置 ConfigServer 从本地读取配置，读取的路径为 Classpath 下的 shared 目录。

server:

  port: 8769

spring:

  application:

    name: config-server

  profiles:

    active: native

  cloud:

    config:

      server:

        native:

          search-locations: classpath:/shared

在 src/main/resources 目录下新建 shared 文件夹，在 shared 文件夹下新建一个 config-client-dev.yml 文件。

server:

  port: 8762

foo: foo version 1

运行 ConfigServerApplication 的 main() 方法，在 8769 端口启动 ConfigServer 应用程序。

2. 构建Config Client

创建一个 SpringBoot 项目模块，取名为 config-client，它的 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>1.5.3.RELEASE</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <groupId>io.github.ostenant.springcloud</groupId>

    <artifactId>config-client</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <name>config-client</name>

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


    <properties>

        <java.version>1.8</java.version>

        <spring-cloud.version>Dalston.RELEASE</spring-cloud.version>

    </properties>


    <dependencies>

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-starter-config</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>

            <scope>test</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>

在 resources 目录下新建 bootstrap.yml 文件，因为 bootstrap 相对于 application 具有优先的执行顺序。

变量 {spring.application.name} 和 {spring.profiles.active}，两者使用 “-” 相连，作为 ConfigClient 向 ConfigServer 读取的配置文件名。

bootstrap.yml

    spring:

      application:

        name: config-client

      cloud:

        config:

          uri: http://localhost:8769

          fail-fast: true # 读取没有成功，执行快速失败

      profiles:

        active: dev

配置一个接口，用于测试读取配置文件的 foo 变量，并通过 API 接口返回客户端。

@RestController

@SpringBootApplication

public class ConfigClientApplication {


    public static void main(String[] args) {

        SpringApplication.run(ConfigClientApplication.class, args);

    }


    @Value("${foo}")

    private String foo;


    @RequestMapping(value = "/foo")

    public String foo(){

        return foo;

    }

}

启动 config-client 应用程序，访问 http://localhost:8762/foo，服务端的响应数据如下：

foo version 1

可见 config-client 成功地从 config-server 项目的 shared 本地文件目录读取到配置文件 config-client-dev.yml 中的 foo 变量。

3. Config Server从远程Git仓库读取配置文件

修改 config-server 的配置文件 application.yml，代码如下.

server:

  port: 8769

spring:

  application:

    name: config-server

  cloud:

    config:

      server:

        git:

          uri: https://coding.net/ostenant/config-repo

          search-paths: test

          username: ostenant@163.com

          password: xxxx

      label: master

如果 Git 仓库为公开仓库，可以不填写用户名和密码；如果是私有仓库则需要填写，本例子配置了一个私有仓库。远程仓库 https://coding.net/ostenant/config-repo 中有个名为 config-client-dev.properties 的配置文件，里面配置有一个属性：

foo = foo version 2

重新启动应用程序 config-server 和 config-client，再次访问 http://localhost:8762/foo，服务端的响应数据如下：

foo version 2

可见， config-server 从远程 Git 仓库读取了配置文件，进一步 config-client 从 config-server 读取了相关的配置属性。

4. 构建高可用的Config Server

将配置中心 config-server 做成一个微服务，并且将其集群化，从而实现高可用。

4.1. 改造Config Server

在 ConfigServer 中引入 Eureka 客户端的起步依赖 spring-cloud-starter-eureka。

<dependency>

     <groupId>org.springframework.cloud</groupId>

     <artifactId>spring-cloud-starter-eureka</artifactId>

</dependency>

在应用的启动类上加上注解 @EnableEurekaClient，将 ConfigServer 注册到 EurekaServer 上面。

在配置文件 application.yml 加入服务注册地址：

eureka:

  client:

    service-url:

      defaultZone: http://locahost:8761/eureka/

4.2. 改造Config Client

同样的在 ConfigClient 中引入 Eureka 客户端的起步依赖 spring-cloud-starter-eureka。

<dependency>

     <groupId>org.springframework.cloud</groupId>

     <artifactId>spring-cloud-starter-eureka</artifactId>

</dependency>

在应用的启动类上加上注解 @EnableEurekaClient，将 ConfigClient 注册到 EurekaServer 上面。

在配置文件 application.yml 加入服务注册地址：

eureka:

  client:

    service-url:

      defaultZone: http://locahost:8761/eureka/

在配置文件 application.yml 加入相关配置，从 service-id 为 config-server 的配置服务读取相关配置文件。

spring:

  application:

    name: config-client

  cloud:

    config:

      fail-fast: true

      discovery:

        enabled: true

        service-id: config-server

  profiles:

    active: dev

server:

  port: 8762

eureka:

  client:

    service-url:

      defaultZone: http://localhost:8761/eureka/

重新启动应用程序 config-server 和 config-client，再次访问 http://localhost:8762/foo，服务端的响应数据如下：

foo version 2

只需要启动多个 config-server 实例，即可搭建一个高可用的 config-server 集群。

5. 使用Spring Cloud Bus刷新配置

SpringCloudBus 将分布式节点通过轻量级的消息代理连接起来。它可以用于广播配置文件的更改或者服务之间的通讯，也可以用于监控。在分布式配置文件被更改后，可以通过 SpringCloudBus 通知各个微服务中的即时刷新本地配置。

5.1. 改造config-client

在 config-client 的 pom.xml 里面加入起步依赖 spring-cloud-starter-bus-amqp。

<dependency>

    <groupId>org.springframework.cloud</groupId>

    <artifactId>spring-cloud-starter-bus-amqp</artifactId>

</dependency>

在项目的配置文件 application.yml 文件中添加 RabbitMQ 的相关配置，包括 RabbitMQ 的地址、端口、用户名和密码。为了方便验证，将 management.security.enabled 改为 false。

spring.rabbitmq.host=localhost

spring.rabbitmq.port=5672

spring.rabbitmq.username=guest

spring.rabbitmq.password=guest

management.security.enabled=false

最后，在需要更新属性的配置类上加 @RefreshScope 注解。

@RefreshScope

@RestController

@SpringBootApplication

public class ConfigClientApplication {


    public static void main(String[] args) {

        SpringApplication.run(ConfigClientApplication.class, args);

    }


    @Value("${foo}")

    private String foo;


    @RequestMapping(value = "/foo")

    public String foo(){

        return foo;

    }

}

依次启动应用，启动两个 config-client 实例，端口分别为 8762 和 8763。启动完成后，访问 http://localhost:8762/foo 或者 http://localhost:8763/foo，服务端响应数据如下：

foo version 2

更改远程 Git 仓库配置文件的 config-client-dev.properties，将 foo 的值改为 “foo version3”。

访问 http://localhost:8762/bus/refresh 请求刷新配置，设置 “destination” 参数为待刷新属性的服务名称。例如 “http://localhost:8762/bus/refresh?destination=config-client:**”，即刷新服务名为 config-client 的所有服务实例。

再次访问 http://localhost:8762/foo 和 http://localhost:8763/foo，服务端响应数据如下：

foo version 3

测试结果表明， /bus/refresh 通知服务名为 config-client 的所有实例刷新了本地的 foo属性配置。

参考

方志朋《深入理解Spring Cloud与微服务构建》

欢迎关注技术公众号：零壹技术栈

本帐号将持续分享后端技术干货，包括虚拟机基础，多线程编程，高性能框架，异步、缓存和消息中间件，分布式和微服务，架构学习和进阶等学习资料和文章。

上一篇：Spring Cloud实战系列(七) - 服务链路追踪Spring Cloud Sleuth

下一篇：Spring Cloud实战系列(五) - 服务网关Zuul

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯