原 荐 白话SpringCloud | 第七章:分布式配置中心的使用

  发布时间:   文章分类:Java 浏览数: 24

文章来源: my.oschina.net/xiedeshou/blog/......, 本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。

前言

介绍完服务的容错保护处理,接下来我们来了解下关于分布式配置中心的相关知识和使用。众所周知,随着项目的越来越多,日益庞大,每个子项目都会伴随着不同的配置项,于此也就多了很多的配置文件。倘若某些配置信息修改,可能就会伴随着一系列配置文件的更新和相应服务的重启操作了。这对于实施而言,也是噩梦一般的存在,增加了一系列运维成本,也会无形中提高出错的机率。所以在微服务越来越多时,就会引入今天要讲解的分布式配置中心,它就是来解决此类问题的。话不多说,开始吧~

一点知识

为什么要统一管理微服务配置

在写这篇文章之前,在公众号里有推送了一篇《 为什么需要分布式配置中心 》的文章。里面也大致说明了,大家可以看一看。简单来说,就是随着业务的发展、微服务架构的升级,服务的数量、程序的配置日益增多(各种微服务、各种 服务器 地址、各种参数),传统的配置文件方式和 数据库 的方式已无法满足开发人员对配置管理的要求,即

  • 安全性:配置跟随源代码保存在代码库中,容易造成配置泄漏;

  • 时效性:修改配置,需要重启服务才能生效;

  • 局限性:无法支持动态调整:例如日志开关、功能开关;

其实说白了,就是当业务需求有变更时,可以通过修改配置文件或者参数的形式,能够自动更新配置。减少不必要的重启服务的操作。正常情况下,一般的业务系统都有个参数配置表的,里面记录着不同业务参数,以此来应对不同的需求场景,也就是需求口中常说的:要能灵活配置。

而在微服务中,由于每个微服务都是独立的数据库,传统的配置无法满足了。所以才出现了分布式配置中心服务,专门来解决此类问题的。

在微服务架构中,微服务的统一配置管理一般有以下需求:

  • 集中管理配置:一个使用微服务架构的应用系统可能会包括成千上万个微服务,因此集中管理配置是非常有必要的。
  • 不同环境不同配置:数据源配置在不同的环境(开发、测试、预发布、生产等)中是不同的。
  • 运行期间可动态调整:可根据各个微服务的负载情况,动态调整数据源连接池大小或熔断阈值,并且在调整配置时不重启微服务。
  • 配置修改后自动更新:如配置内容发生变化,微服务能够自动更新配置。

综上所述,对于微服务架构而言,一个通用的配置管理机制必不可少,常见做法是使用配置服务器管理配置。目前市面上开源的配置中心有很多,如

  • Apollo(阿波罗) :携程框架部门研发的分布式配置中心,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性,适用于微服务配置管理场景。
  • Qconf :一个分布式配置管理工具,360出品。
  • Disconf :专注于各种「分布式系统配置管理」的「通用组件」和「通用平台」, 提供统一的「配置管理服务」。

具体的可以看看之前说的文章《 为什么需要分布式配置中心 》,这里就不过多阐述了。

Spring-Cloud-config实践

何为SpringCloudConfig

Spring Cloud Config 为分布式系统外部化配置提供了服务端和客户端的支持,它包括 Config ServerConfig Client 两部分。目前支持 gitsvnvaultjdbc本地 几种存储方式。

最常用的存储方式就是 git 了。

简单来说,各客户端程序通过访问服务端获取相应的配置信息。接下来我们看看下面这张图

  • 远程Git仓库:存储配置文件。
  • ConfigServer:分布式配置管理中心,会于维护自己的git仓库信息。
  • 本地Git仓库:在ConfigServer中,每次客户端请求获取配置信息时,都会从git仓库获取最新的配置到本地,然后本地读取并返回,远程无法获取时,使用本地仓库信息。

从上图可以看出, Config Server 巧妙地通过 git clone 将配置信息存于本地,起到了缓存的作用,即使当 Git 服务端无法访问的时候,依然可以取 Config Server 中的缓存内容进行使用。

这里以git为例,做个简单示例。首先,在github中创建一个目录: spring-cloud-config-repo ,来存放配置文件信息。

my-config-client-dev.properties

config=this is dev!

my-config-client-dev.properties

config=this is test!

注意:因为存在多个项目都是用配置中心问题,而每个项目的应用名称是不尽相同的,所以配置文件的命名方式即为: 应用名 + 环境变量(profile) 的命名方式。因此,每个应用理应设置应用名称,是个好习惯。具体的映射规则,在 Server端 会进行说明的。

Server端

创建工程: spring-cloud-confg-server 0.引入pom依赖。

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

1.启动类加入@EnableConfigServer注解,声明是 ConfigServer

@SpringBootApplication
@EnableConfigServer
@Slf4j
public class SpringCloudConfigServerApplication {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(SpringCloudConfigServerApplication.class, args);
        log.info("spring-cloud-config-server启动!");
    }
}

2.配置文件,添加git仓库相关信息。

spring.application.name=spring-cloud-config-server
server.port=5678

#配置文件git配置
spring.cloud.config.server.git.uri=https://github.com/xie19900123/spring-cloud-learning.git
# 搜索路径,即配置文件的目录,可配置多个,逗号分隔。默认为根目录。
spring.cloud.config.server.git.searchPaths=spring-cloud-config-repo
# git用户名和密码 针对私有仓库而言需要填写
spring.cloud.config.server.git.username=
spring.cloud.config.server.git.password=

3.启动应用,访问 http://127.0.0.1:5678/my-config-client-dev.properties ,返回了配置文件的信息,说明已经读取到远程仓库信息了。

我们可以通过访问配置信息的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来访问不同的配置内容, 比如: 要访问 master 分支, my-config-client 应用的dev环境

http://127.0.0.1:5678/my-config-client/dev/master

返回的信息:

{
    "name": "my-config-client",
    "profiles": ["dev"],
    "label": "master",
    "version": "51d81a5aacce45b97af6db2482769fe02873c548",
    "state": null,
    "propertySources": [{
        "name": "https://github.com/xie19900123/spring-cloud-learning.git/spring-cloud-config-repo/my-config-client-dev.properties",
        "source": {
            "config": "this is dev!"
        }
    }]
}

此时,查看控制台,可以获悉本地也保存着一份配置信息。

2018-10-09 23:32:46.833  INFO 988 --- [nio-5678-exec-2] o.s.c.c.s.e.NativeEnvironmentRepository  : Adding property source: file:/C:/Users/xiede/AppData/Local/Temp/config-repo-7233984840222622045/spring-cloud-config-repo/my-config-client-dev.properties
2018-10-09 23:32:46.834  INFO 988 --- [nio-5678-exec-2] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@66e76432: startup date [Tue Oct 09 23:32:46 CST 2018]; root of context hierarchy

查看本地仓库目录:

此时,修改远程的配置文件,再次访问可以看见返回的参数是最新修改后的参数值了,大家可以自行试试。

Client端

创建一个客户端: spring-cloud-confg-client 。当然也可以改造原来的应用了,只需加入相应pom文件和配置文件即可。 0.加入pom依赖。

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

1.创建启动类,就是一个正常的web应用。

/**
 * Spring Cloud Config client 示例
 * @author oKong
 *
 */
@SpringBootApplication
@Slf4j
public class SpringCloudConfigClientApplication {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(SpringCloudConfigClientApplication.class, args);
        log.info("spring-cloud-config-client启动!");
    }

}

2.配置文件添加: bootstrap.properties 和常规的 application.properties

bootstrap.properties

# 设置分支
spring.cloud.config.label=master
# 环境变量
spring.cloud.config.profile=dev
# 是否使用注册中心方式进行获取 后续会进行讲解
#spring.cloud.config.discovery.enabled=false
# 服务端地址 
# 在不使用注册中心模式下 直接填写实际地址
spring.cloud.config.uri=http://127.0.0.1:5678
# 注册中心应用id 下一章节会进行讲解
#spring.cloud.config.discovery.service-id=

application.properties

# 设置应用名称,需要和配置文件匹配
spring.application.name=my-config-client
server.port=5666

这里需要注意:

spring-cloud-config 相关的属性 必须配置在 bootstrap.properties ,config部分内容才能被正确加载。因为config的相关配置会先于 application.properties ,而 bootstrap.properties 的加载也是先于 application.properties

3.编写一个控制层,利用 @Value 进行参数测试。

/**
 * config client 简单示例
 * @author oKong
 *
 */
@RestController
public class DemoController {

    @Value("${config}")
    String config;
    
    @GetMapping("/")
    public String demo() {
        return "返回的config参数值为:" + config;
    }
}

4.启动应用,访问: http://127.0.0.1:5666/ ,可以看见配置信息已经被正确返回了。

自此,一个简单的配置中心示例就结束了。 目前为止,我们还没有手动去修改远程的配置文件参数值,可以试试,在修改后,客户端去返回相应的参数值,会发现还是旧的,并没有进行更新操作。因为配置文件是是在应用启动的时候进行加载的,而且远程仓库修改了配置文件,客户端并不知道已经修改了,不会发起请求的。关于配置参数自动更新相关知识点,会在下一章节进行讲解的。

参考资料

  1. https://cloud.spring.io/spring-cloud-static/Finchley.SR1/single/spring-cloud.html#_spring_cloud_config

  2. 为什么需要分布式配置中心?

总结

本章节主要讲解了常规操作下,如何使用 SpringCloudConfig 进行统一参数配置管理。针对 配置动态刷新,实时生效 相关知识点,会在下一章节进行单独讲解的,本章节先让大家有个直观的认识,了解下 SpringCloudConfig 实现的一些机制。本文仅仅是讲解了 git 示例,有兴趣的同学可以试试其他的,比如 svn 或者 本地资源库 等形式。都是类似配置,就不加以说明了。

最后

目前互联网上大佬都有分享 SpringCloud 系列教程,内容可能会类似,望多多包涵了。 原创不易,码字不易 ,还希望大家多多支持。若文中有错误之处,还望提出,谢谢。

老生常谈

499452441
lqdevOps

个人博客: http://blog.lqdev.cn

源码示例: https://github.com/xie19900123/spring-cloud-learning

原文地址: http://blog.lqdev.cn/2018/10/10/SpringCloud/chapter-seven/

以上所述就是小编给大家介绍的《原 荐 白话SpringCloud | 第七章:分布式配置中心的使用》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 Coder·码农网 的支持!

码农可能感兴趣的文章:

本文永久链接:www.codercto.com/a/30644.html

相关码农书籍:
Programming Concurrency on the JVM

Programming Concurrency on the JVM

Venkat Subramaniam / The Pragmatic Bookshelf / 2011-6-1 / USD 35.00

Concurrency on the Java platform has evolved, from the synchronization model o...

相关码农工具:
html转js在线工具

html转js在线工具

html转js在线工具

JSON 在线解析

JSON 在线解析

在线 JSON 格式化工具

RGB转16进制工具

RGB转16进制工具

RGB HEX 互转工具