Spring Cloud config之一：分布式配置中心入门介绍

news/2024/7/5 6:40:27

Spring Cloud Config为服务端和客户端提供了分布式系统的外部化配置支持。配置服务器为各应用的所有环境提供了一个中心化的外部配置。它实现了对服务端和客户端对Spring Environment和PropertySource抽象的映射，所以它除了适用于Spring构建的应用程序，也可以在任何其他语言运行的应用程序中使用。作为一个应用可以通过部署管道来进行测试或者投入生产，我们可以分别为这些环境创建配置，并且在需要迁移环境的时候获取对应环境的配置来运行。

配置服务器默认采用git来存储配置信息，这样就有助于对环境配置进行版本管理，并且可以通过git客户端工具来方便的管理和访问配置内容。当然他也提供本地化文件系统的存储方式，下面从这两方面介绍如何使用分布式配置来存储微服务应用多环境的配置内容。

构建Config Server

通过Spring Cloud构建一个Config Server，新建一个maven工程SCconfigcenter，非常简单，只需要三步：

  • pom.xml中引入spring-cloud-config-server依赖，完整依赖配置如下：
<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.dxz</groupId>
    <artifactId>SCconfigcenter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.5.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <dependencies>

        <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-config-server</artifactId>
        </dependency>

    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Brixton.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>
  • 创建Spring Boot的程序主类，并添加@EnableConfigServer注解，开启Config Server
package com.dxz;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.config.server.EnableConfigServer;

@EnableConfigServer
@SpringBootApplication
public class SCconfigCenterApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(SCconfigCenterApplication.class).web(true).run(args);
    }
}
  • application.properties中配置服务信息以及git信息，例如： 
    spring.application.name=config-server
server.port=7001

spring.cloud.config.server.git.uri=http://git.oschina.net/duanxz/springcloud-config-server/
spring.cloud.config.server.git.searchPaths=config-server
spring.cloud.config.server.git.username=18*****6@qq.com
spring.cloud.config.server.git.password=******
  • 到这里，使用一个通过Spring Cloud Config实现，并使用git管理内容的配置中心已经完成了，启动该应用，成功后开始下面的内容。spring.cloud.config.server.git.uri：配置git仓库位置
  • spring.cloud.config.server.git.searchPaths：配置仓库路径下的相对搜索位置，可以配置多个
  • spring.cloud.config.server.git.username：访问git仓库的用户名
  • spring.cloud.config.server.git.password：访问git仓库的用户密码

Spring Cloud Config也提供本地存储配置的方式。我们只需要设置属性spring.profiles.active=native，Config Server会默认从应用的src/main/resource目录下检索配置文件。也可以通过spring.cloud.config.server.native.searchLocations=file:F:/properties/属性来指定配置文件的位置。虽然Spring Cloud Config提供了这样的功能，但是为了支持更好的管理内容和版本控制的功能，还是推荐使用git的方式。

服务端验证

为了验证上面完成的配置服务器，在http://git.oschina.net/duanxz/springcloud-config-server下创建了一个config-repo目录作为配置仓库，并根据不同环境新建了下面四个配置文件：

  • center.properties
  • center-dev.properties
  • center-test.properties
  • center-prod.properties

其中设置了一个from属性，为每个配置文件分别设置了不同的值，如：

  • from=git-default-1.0
  • from=git-dev-1.0
  • from=git-test-1.0
  • from=git-prod-1.0

git客户端操作方法如下：

在sourcetree里创建分支，在分支上创建4个文件，

推送到服务器上。

再服务器端创建request，合并到master上。

为了测试版本控制，在master中，我们都加入1.0的后缀，同时创建一个config-server1.0分支。完成了这些准备工作之后，我们就可以通过浏览器或POSTMAN等工具直接来访问到我们的配置内容了。

URL与配置文件的映射关系如下：

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

上面的url会映射{application}-{profile}.properties对应的配置文件，{label}对应git上不同的分支，默认为master。

我们可以尝试构造不同的url来访问不同的配置内容，比如：要访问config-label-test分支，didispace应用的prod环境，可以通过这个url：http://127.0.0.1:7001/config-server/test/config-server1.0

{
    "name": "config-server",
    "profiles": [
        "test"
    ],
    "label": "config-server1.0",
    "version": "7e1fdc54c91574ed2f22ed1ef2d7c59714b555ce",
    "propertySources": []
}

在完成并验证了配置服务中心之后，下面看看我们如何在微服务应用中获取配置信息。

default是master分支：

 

微服务端映射配置

  • 创建一个Spring Boot应用SCconfigcenterClient的maven工程，在pom.xml中引入spring-cloud-starter-config依赖，完整依赖关系如下：
<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.dxz</groupId>
    <artifactId>SCconfigcenterClient</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.5.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>
    <dependencies>
        <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-config</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Brixton.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>
  • 创建最基本的Spring Boot启动主类
package com.dxz;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;

@SpringBootApplication
public class SCconfigcenterClientApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(SCconfigcenterClientApplication.class).web(true).run(args);
    }
}
  • 创建/SCconfigcenterClient/src/main/resources/bootstrap.properties配置，来指定config server，例如：
spring.application.name=didispace
spring.cloud.config.profile=dev
spring.cloud.config.label=master
spring.cloud.config.uri=http://localhost:7001/
server.port=7002
  • spring.application.name：对应前配置文件中的{application}部分
  • spring.cloud.config.profile：对应前配置文件中的{profile}部分
  • spring.cloud.config.label：对应前配置文件的git分支
  • spring.cloud.config.uri：配置中心的地址

这里需要格外注意：上面这些属性必须配置在bootstrap.properties中，config部分内容才能被正确加载。因为config的相关配置会先于application.properties，而bootstrap.properties的加载也是先于application.properties。

  • 创建一个Rest Api来返回配置中心的from属性，具体如下：
package com.dxz.controler;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RefreshScope
@RestController
class TestController {
    @Value("${from}")
    private String from;

    @RequestMapping("/from")
    public String from() {
        return this.from;
    }
}

启动该应用，并访问：http://localhost:7002/from ，我们就可以根据配置内容输出对应环境的from内容了。通过@Value("${from}")绑定配置服务中配置的from属性。

 

完整示例：Chapter9-1-4

 

配置动态刷新

1、单独引入 spring-boot-starter-actuator或者spring-cloud-starter-config（spring cloud config的客户端）  是不会暴露/refresh端点的，两者同时引入之后才能暴露/refresh端点。

2、一般使用spring-cloud-starter-config的文章都会让你在bootstrap里加上配置中心服务端的地址，这里我们要脱离配置中心服务端使用，所以这些配置完全不需要。

3、对需要刷新的属性使用@Value注解，同时将类使用@RefreshScope注解进行标记，示例如下：

@RefreshScope标记在类或者方法上，@value标记在setXXX()或者成员变量上。

4、然后把yml文件改下，然后push到git上，再curl -X POST http://localhost:7031/refresh（读取应用的）刷一把配置。

高可用问题

传统作法

通常在生产环境，Config Server与服务注册中心一样，我们也需要将其扩展为高可用的集群。在之前实现的config-server基础上来实现高可用非常简单，不需要我们为这些服务端做任何额外的配置，只需要遵守一个配置规则：将所有的Config Server都指向同一个Git仓库，这样所有的配置内容就通过统一的共享文件系统来维护，而客户端在指定Config Server位置时，只要配置Config Server外的均衡负载即可，就像如下图所示的结构：

注册为服务

虽然通过服务端负载均衡已经能够实现，但是作为架构内的配置管理，本身其实也是可以看作架构中的一个微服务。所以，另外一种方式更为简单的方法就是把config-server也注册为服务，这样所有客户端就能以服务的方式进行访问。通过这种方法，只需要启动多个指向同一Git仓库位置的config-server就能实现高可用了。

配置过程也非常简单，具体如下：

config-server配置

  • 在pom.xml的dependencies节点中引入如下依赖，相比之前的config-server就，加入了spring-cloud-starter-eureka，用来注册服务
<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.dxz</groupId>
    <artifactId>SCconfigcenter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.5.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <dependencies>

        <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-config-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>

    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Brixton.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>
  • 在application.properties中配置参数eureka.client.serviceUrl.defaultZone以指定服务注册中心的位置，详细内容如下：
spring.application.name=config-server
server.port=7001
# \u914D\u7F6E\u670D\u52A1\u6CE8\u518C\u4E2D\u5FC3
eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/
# git\u4ED3\u5E93\u914D\u7F6E
spring.cloud.config.server.git.uri=http://git.oschina.net/didispace/SpringCloud-Learning/
spring.cloud.config.server.git.searchPaths=Chapter1-1-8/config-repo
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password
  • 在应用主类中，新增@EnableDiscoveryClient注解，用来将config-server注册到上面配置的服务注册中心上去。
package com.dxz;

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

@EnableDiscoveryClient
@EnableConfigServer
@SpringBootApplication
public class SCconfigCenterApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(SCconfigCenterApplication.class).web(true).run(args);
    }
}
  • 启动该应用，并访问http://localhost:1111/，可以在Eureka Server的信息面板中看到config-server已经被注册了。

 

config-client配置

  • 同config-server一样，在pom.xml的dependencies节点中新增spring-cloud-starter-eureka依赖，用来注册服务：
<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.dxz</groupId>
    <artifactId>SCconfigcenterClient</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.5.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>
    <dependencies>
        <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-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Brixton.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>
  • 在bootstrap.properties中，按如下配置：
spring.application.name=didispace
server.port=7002
eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/
spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.serviceId=config-server
spring.cloud.config.profile=dev

其中，通过eureka.client.serviceUrl.defaultZone参数指定服务注册中心，用于服务的注册与发现，再将spring.cloud.config.discovery.enabled参数设置为true，开启通过服务来访问Config Server的功能，最后利用spring.cloud.config.discovery.serviceId参数来指定Config Server注册的服务名。这里的spring.application.name和spring.cloud.config.profile如之前通过URI的方式访问时候一样，用来定位Git中的资源。

  • 在应用主类中，增加@EnableDiscoveryClient注解，用来发现config-server服务，利用其来加载应用配置
package com.dxz;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@EnableDiscoveryClient
@SpringBootApplication
public class SCconfigcenterClientApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(SCconfigcenterClientApplication.class).web(true).run(args);
    }
}
  • 沿用之前我们创建的Controller来加载Git中的配置信息
package com.dxz.controler;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RefreshScope
@RestController
class TestController {
    @Value("${from}")
    private String from;

    @RequestMapping("/from")
    public String from() {
        return this.from;
    }
}
  • 完成了上述配置之后，我们启动该客户端应用。若启动成功，访问http://localhost:1111/，可以在Eureka Server的信息面板中看到该应用已经被注册成功了。

 

  • 访问客户端应用提供的服务：http://localhost:7002/from，此时，我们会返回在Git仓库中didispace-dev.properties文件配置的from属性内容：”git-dev-1.0”。

 

配置刷新

有时候，我们需要对配置内容做一些实时更新的场景，那么Spring Cloud Config是否可以实现呢？答案显然是可以的。下面，我们看看如何进行改造来实现配置内容的实时更新。

在改造程序之前，我们先将config-server和config-client都启动起来，并访问客户端提供的REST API：http://localhost:7002/from来获取配置信息，可以获得返回内容为：git-dev-1.0。接着，我们可以尝试使用Git工具修改当前配置的内容，比如，将config-repo/didispace-dev.properties中的from的值从from=git-dev-1.0修改为from=git-dev-2.0，再访问http://localhost:7002/from，可以看到其返回内容还是git-dev-1.0。

下面，我们将在config-client端增加一些内容和操作以实现配置的刷新：

  • 在config-clinet的pom.xml中新增spring-boot-starter-actuator监控模块，其中包含了/refresh刷新API。
　　　　 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
  •  重新启动config-clinet，访问一次http://localhost:7002/from，可以看到当前的配置值
  • 修改Git仓库config-repo/didispace-dev.properties文件中from的值
  • 再次访问一次http://localhost:7002/from，可以看到配置值没有改变
  • 通过POST请求发送到http://localhost:7002/refresh，我们可以看到返回内容如下，代表from参数的配置内容被更新了
  • 通过上面的介绍，大家不难想到，该功能还可以同Git仓库的Web Hook功能进行关联，当有Git提交变化时，就给对应的配置主机发送/refresh请求来实现配置信息的实时更新。但是，当我们的系统发展壮大之后，维护这样的刷新清单也将成为一个非常大的负担，而且很容易犯错，那么有什么办法可以解决这个复杂度呢？后续我们将继续介绍如何通过Spring Cloud Bus来实现以消息总线的方式进行通知配置信息的变化，完成集群上的自动化更新。再次访问一次http://localhost:7002/from，可以看到配置值已经是更新后的值了

本文完整示例：

  • 开源中国：http://git.oschina.net/didispace/SpringCloud-Learning/tree/master/Chapter1-1-8
  • GitHub：https://github.com/dyc87112/SpringCloud-Learning/tree/master/Chapter1-1-8

转自：http://blog.didispace.com/springcloud4-2/


http://www.niftyadmin.cn/n/3746524.html

相关文章

angularjs中的页面访问权限设置

angularjs中的页面访问权限设置

11月在赶一个项目&#xff0c;这阵子比较忙&#xff0c;挤挤时间更一篇博客吧&#xff0c;如标题所述说说在ng中页面访问权限控制的问题&#xff0c;水平有限各位看官见谅&#xff1b;　　 在以往的项目中&#xff0c;前后端常见的配合方式是前端提供页面和ui加一点DuangDuangD…
阅读更多...
Angular 1与 Angular 2之间的一些差别

Angular 1与 Angular 2之间的一些差别

现在在用ng1.5.8做一个项目&#xff0c;ng的优点和特性我就不用多说了&#xff0c;ng1在陆续更新到1.5/1.6后就没再推出新版本了&#xff0c;ng2已经面世测试很久了&#xff0c;如同很多系统和框架一样&#xff0c;每个大的版本更新都会有新特性加入进来&#xff0c;虽然还没有…
阅读更多...
团队建设与团队文化

团队建设与团队文化

其实我也感到奇怪&#xff0c;为什么选择写这个话题而不写一些技术相关&#xff0c;说到团队建设和团队文化&#xff0c;好像是中高层往上的管理者才会涉及考虑的&#xff0c;作为下属的各个岗位做好当前的工作&#xff0c;圆满的完成任务并持续创新就行了&#xff1b;在从业这…
阅读更多...
有意思的Console

有意思的Console

在很久的以前&#xff0c;因为经常在浏览器控制台调试修改数据&#xff0c;想到用户如果使用控制台配合抓包工具修改上下行流量中的数据&#xff0c;会给站点带来不定的安全威胁&#xff0c;所以一直想找个方法&#xff0c;准确的说是js的方法“禁用”控制台&#xff0c;也就是…
阅读更多...
【招聘】广州国盈医药有限公司 招聘前端、运维

【招聘】广州国盈医药有限公司 招聘前端、运维

为什么80%的码农都做不了架构师&#xff1f;>>> 运维工程师 薪酬&#xff1a;&#xff08;6k-13k&#xff09; 岗位职责&#xff1a; 负责内部计算机系统的日常维护与更新&#xff0c;包括软件及硬件&#xff1b;负责确保各类服务器、交换机、路由器等正常运行&am…
阅读更多...
Progressive web app理念及发展前景

Progressive web app理念及发展前景

前一段时间微信推出微信小程序进行公测&#xff0c;着实火了一把&#xff0c;博得了大众的眼球&#xff0c;不明真相的吃瓜观众们纷纷围观&#xff0c;所谓的“微信小程序”&#xff0c;通俗的讲就是一种不需要下载安装即可使用的应用程序&#xff0c;脱离于app商店依托于浏览器…
阅读更多...
网站页面广告屏蔽监测

网站页面广告屏蔽监测

烦人的网页广告&#xff0c;讨厌的页面弹窗&#xff0c;想必大家都见过&#xff0c;对于这些乱七八糟的东西&#xff0c;我是最不能忍的&#xff0c;所以每次装浏览器后的第一件事就是安装浏览器插件去广告&#xff0c;基本能屏蔽所有网页广告和弹窗(对于大部分用户&#xff0c…
阅读更多...
前端知识树-构建你的知识体系

前端知识树-构建你的知识体系

经常有人问&#xff0c;我想学前端&#xff0c;要从哪里学起&#xff0c;或者有点基础&#xff0c;想学点其他的&#xff0c;要学什么&#xff1f; 两年前我同样带着这样的疑问&#xff0c;搜索了前端知识体系这个关键词&#xff0c;被大神们各种图解和list吓到了&#xff0c;心…
阅读更多...
最新文章

Copyright @ 2022~2023