【深入理解SpringCloud微服务】深入理解微服务配置中心原理，并手写一个微服务配置中心

2024-09-01 09:52
文章标签 java 配置 服务 spring 深入 理解 原理 springcloud 中心 手写

本文主要是介绍【深入理解SpringCloud微服务】深入理解微服务配置中心原理，并手写一个微服务配置中心，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

【深入理解SpringCloud微服务】深入理解微服务配置中心原理，并手写一个微服务配置中心

  • 为什么要使用配置中心
  • 配置中心原理
  • 如何手写一个配置中心
    • 使用PropertySourceLocator
    • 监听配置变更，刷新配置
  • 实现一个微服务配置中心
    • 服务端
      • 库表
      • ConfigCenterController
      • ConfigCenterService
      • LongPollingService
      • ConfigCenterServerConfig
    • 客户端
      • ConfigService
      • SimpleMicroserviceConfigPropertySourceLocator
      • ConfigCenterClientConfig
      • LongPollingClient
      • RefreshListener
      • LongPollingClientConfig
    • 总结

为什么要使用配置中心

在没有配置中心以前，我们应用程序的配置都是保存在本地，如果是单体架构的话，这种方式是没有问题的，优点是非常的简单。

在这里插入图片描述

但是如果在微服务架构下，每个微服务自己管理自己的配置文件的话，这种方式就太混乱，不利于运维人员对配置文件的维护。

因此，在微服务架构下，通常会引入配置中心，所有微服务的配置都统一维护在配置中心，应用程序从配置中心读取配置并加载，这样对不同服务配置的维护就显得更方便。

在这里插入图片描述

配置中心原理

配置中心通常分为配置中心服务端和配置中心客户端。配置中心服务端通过某种存储方式存储配置信息，比如数据库、文件、github。而配置中心客户端请求配置中心服务端拉取配置信息，常见的是通过http请求拉取配置。

在这里插入图片描述

配置中心还会提供接口或者一个界面去进行配置添加和修改。

在这里插入图片描述
然后配置中心客户端从配置中心服务端拉取到配置信息后，会加载配置信息到本地环境中，这样我们的应用程序就能读取到从配置中心拉取回来的配置。

在这里插入图片描述

最后，配置中心通常还会有配置变更通知的功能。当配置中心发生配置变更时，需要通知客户端，可以使用与客户端维持的长连接进行推送，或者由客户端主动轮询。当客户端收到配置变更通知时，会刷新本地环境。

在这里插入图片描述

如何手写一个配置中心

以上的一整套操作，如果从零搞起，是非常麻烦的，如果我们基于Spring，使用SpringBoot开发的话，有一些接口是可以复用的，我们下面了解一下。

使用PropertySourceLocator

SpringBoot在启动的时候，会使用PropertySourceLocator#locate()方法查找配置信息，PropertySourceLocator#locate()方法返回PropertySource，里面包含了查找到的配置信息，然后SpringBoot会把PropertySource添加到Environment对象中。

在这里插入图片描述

于是，我们可以自己实现一个PropertySourceLocator重写locate()方法，locate()方法请求配置中心获取配置。我们把自己实现的PropertySourceLocator注册到Spring容器中，SpringBoot启动时就会调用我们的PropertySourceLocator去配置中心拉取配置，加载到Environment中，这样就省掉了很多代码。

在这里插入图片描述

监听配置变更，刷新配置

当配置中心发生配置变更时，要通知客户端。配置中心可以利用长连接进行推送，也可以客户端自己进行长轮询。

当客户端接收到配置变更时的环境刷新操作。客户端需要重新请求配置中心拉取配置，刷新本地环境Environment，然后还要把变更的配置重新赋值到引用该配置的对象当中。

在SpringBoot中，有一个RefreshEventListener监听器，会监听RefreshEvent事件，当RefreshEventListener监听到RefreshEvent事件时，会创建一个新SpringContext去加载配置信息，并且销毁被@RefreshScope注解修饰的bean。在下一次请求使用到被销毁的bean时，Spring会重新实例化，那么这个bean就会读取到最新的配置。

在这里插入图片描述

这样，当客户端接收到配置中心的配置变更通知时，只要通过通过Spring的事件监听机制发布一个RefreshEvent事件即可，这样又能省掉很多代码。

在这里插入图片描述

实现一个微服务配置中心

下面是我手写实现的一个配置中心，由于篇幅关系，只会展示核心代码。如果要看详细代码的话，文末会附上git仓库的地址，从上面下载即可。

服务端

配置中心服务端是基于SpringBoot开发的，采用传统的MVC架构。

库表

我们的配置中心是基于数据库存储配置信息的。

CREATE TABLE `t_config_file` (`f_id` bigint(20) NOT NULL,`f_environment` varchar(1024) DEFAULT NULL COMMENT '环境（自定义，如：dev、test）',`f_service_name` varchar(1024) DEFAULT NULL COMMENT '配置所属服务名',`f_name` varchar(1024) DEFAULT NULL COMMENT '配置文件名',`f_priority` int(11) DEFAULT 0 COMMENT '优先级，值越大越优先',`f_create_time` bigint(20) DEFAULT NULL COMMENT '创建时间',`f_modify_date` timestamp NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp() COMMENT '修改时间',PRIMARY KEY (`f_id`),KEY `idx_config_file_modify_date` (`f_modify_date`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPACT COMMENT='配置文件表';CREATE TABLE `t_config_file_item` (`f_id` bigint(20) NOT NULL,`f_config_file_id` bigint(20) NOT NULL COMMENT '配置文件id',`f_name` varchar(1024) NOT NULL COMMENT '配置项名称',`f_value` varchar(1024) NOT NULL COMMENT '配置项内容',`f_create_time` bigint(20) DEFAULT NULL COMMENT '创建时间',`f_modify_date` timestamp NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp() COMMENT '修改时间',PRIMARY KEY (`f_id`),KEY `idx_config_file_item_modify_date` (`f_modify_date`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPACT COMMENT='配置文件配置项表';
  • t_config_file是配置文件表
  • t_config_file_item是配置文件配置项表
  • t_config_file_item通过f_config_file_id关联t_config_file表，t_config_file与t_config_file_item是一对多关系。

t_config_file里的一条记录表示一个配置文件，t_config_file_item里的一条记录表示配置文件里的一个配置项。

在这里插入图片描述

ConfigCenterController

@RestController
@RequestMapping("/config/center")
public class ConfigCenterController {@Autowiredprivate ConfigCenterService configCenterService;...}

ConfigCenterController暴露了配置文件的增删改查接口，调用ConfigCenterService进行处理。

在这里插入图片描述

ConfigCenterService

@Service
public class ConfigCenterService {...@Autowiredprivate ConfigFileDao configFileDao;...// modify()修改配置的方法，// 修改完后，会调用LongPollingService通知客户端发生配置变更...}

上面只展示了ConfigCenterService的修改配置文件和根据服务名查询所有配置文件的这两个方法。

ConfigCenterService调用ConfigFileDao操作数据库，对t_config_file表和t_config_file_item表进行增删改查操作。

其中modify方法做完修改操作后，判断如果修改操作执行成功，还会调用LongPollingService通过长连接通知客户端。

在这里插入图片描述

LongPollingService

我们采用了websocket保持客户端与服务端的长连接，当有配置变更时，通过websocket通知客户端刷新配置信息。

在这里插入图片描述

LongPollingService正是服务端暴露的websocket端点，被@ServerEndpoint注解修饰。LongPollingService里面封装了websocket连接建立和关闭时进行的操作，以及推送配置变更通知的操作。

// 对外暴露websocket端点
@ServerEndpoint("/ws/config/center")
@Component
public class LongPollingService {// 当建立websocket连接后，会保存websocket连接对应的Session到Map中// 格式为 [environmen: [serviceName: session]] 双层Map...// 通知客户端发生配置变更public static void notify(String environmen, String serviceName) throws IOException {// 根据指定环境environmen指定服务名environmen，取得对应的Session// 该Session代表与对应客户端建立的长连接Map<String, Session> serviceNameSessionMap = envServiceNameSessionMapping.get(environmen);if (serviceNameSessionMap != null) {Session session = serviceNameSessionMap.get(serviceName);if (session != null) {// 通过session向客户端推送配置变更通知session.getBasicRemote().sendText(Constant.CONFIG_CHANGE_MARK);}}}}

当建立websocket连接后，会保存websocket连接对应的Session到LongPollingService的Map中，格式为“[environmen: [serviceName: session]]”这样的双层Map。

LongPollingService.notify(environmen, serviceName)会通过environmen环境名（比如dev、uat）和serviceName服务名从Map中获取到对应的session，这个session表示与指定环境指定服务名的客户端建立的websocket长连接。然后通过这个session向对应客户端推送配置变更通知。

在这里插入图片描述

ConfigCenterServerConfig

ConfigCenterServerConfig是一个被@Configuration注解修饰的配置类，通过在spring.factories指定该配置类进行自动装配。

ConfigCenterServerConfig会通过@ComponentScan、@Bean等注解配置我们上面说到的类。

在这里插入图片描述

客户端

客户端也是使用SpringBoot进行开发的，以jar包的形式被其他微服务引用。

ConfigService

ConfigService是一个接口，定义了获取配置信息的方法。

public interface ConfigService {List<ConfigFileDto> getAll(String environment, String serviceName, String name);ConfigFileDto get(String fileId);}

ConfigService的实现类内部通过OkHttp请求配置中心服务端拉取配置信息。

在这里插入图片描述

SimpleMicroserviceConfigPropertySourceLocator

SimpleMicroserviceConfigPropertySourceLocator就是我们上面说的实现了Spring的PropertySourceLocator接口的实现类，重写了locate方法，在locate方法中调用ConfigService通过http请求配置中心拉取配置信息，再把配置中心返回的配置信息转换成CompositePropertySource返回。

SimpleMicroserviceConfigPropertySourceLocator.locate(Environment)

    @Overridepublic PropertySource<?> locate(Environment environment) {// 创建一个CompositePropertySource，用于保存请配置中心拉取回来的配置信息CompositePropertySource compositePropertySource = new CompositePropertySource(PROPERTY_SOURCE_NAME);// 调用configService从配置中心拉取配置信息List<ConfigFileDto> configFileDtos = configService.getAll(simpleMicroserviceConfigProperties.getEnvironment(), simpleMicroserviceConfigProperties.getServiceName(), null);// 拉取回来的配置信息，保存到CompositePropertySourceconfigFileDtos.stream().map(configFileDto -> new MapPropertySource(configFileDto.getName(), configFileDto.getConfigMap())).forEach(compositePropertySource::addFirstPropertySource);return compositePropertySource;}

SpringBoot在启动之后，会调用PropertySourceLocator的locate方法，然后把locate方法方法返回的PropertySource添加到Environment中。SpringBoot会调用这里的SimpleMicroserviceConfigPropertySourceLocator的locate方法，然后把返回的CompositePropertySource添加到Environment中。

在这里插入图片描述

ConfigCenterClientConfig

ConfigCenterClientConfig就是一个配置类，被spring.factories指定自动装配，通过@Bean注解往Springboot注册ConfigService和SimpleMicroserviceConfigPropertySourceLocator。

在这里插入图片描述

LongPollingClient

@Component
public class LongPollingClient implements ApplicationListener<ApplicationReadyEvent>, ApplicationContextAware {...public void connect() {...// 通过okhttp与配置中心服务端建立websocket连接// RefreshListener是一个监听器，收到配置中心的通知会回调mOkHttpClient.newWebSocket(request, new RefreshListener(...));...}// 监听ApplicationReadyEvent事件，触发websocket连接建立@Overridepublic void onApplicationEvent(ApplicationReadyEvent event) {...this.connect();}...
}

LongPollingClient实现了Spring的ApplicationListener接口，监听ApplicationReadyEvent事件，触发与配置中心服务端的websocket连接建立，建立websocket连接依然是使用okhttp。

然后在创建websocket连接，设置了一个监听器RefreshListener，在收到配置中心的通知时会回调该监听器。

在这里插入图片描述

RefreshListener

RefreshListener继承了WebSocketListener，WebSocketListener是OKHttp提供的抽象类，代表一个websocket监听器。

public class RefreshListener extends WebSocketListener {...// websocket连接建立后的回调，向配置中心服务端注册// 发送environmen（环境）和serviceName（服务名）到注册中心@Overridepublic void onOpen(WebSocket webSocket, Response response) {JSONObject message = new JSONObject();message.put("environmen", environmen);message.put("serviceName", serviceName);webSocket.send(message.toJSONString());}// 收到配置中心服务端通知时回调，通过Spring事件监听机制，发一个RefreshEvent事件@Overridepublic void onMessage(WebSocket webSocket, String text) {applicationContext.publishEvent(new RefreshEvent(this, null, "refresh config"));}...}

当websocket连接建立后，会回调RefreshListener的onOpen方法，会向配置中心服务端注册自己对应的environmen和serviceName，配置中心服务端会以environmen和serviceName为key，记录与该websocket连接对应的Session的映射关系，方便配置变更时通知客户端。

当客户端收到配置中心服务端的配置变更通知时，会回调RefreshListener的onMessage方法，会通过Spring事件监听机制，发一个RefreshEvent事件。发送的RefreshEvent事件会被RefreshEventListener接收，触发配置的重新加载和销毁旧的bean，上面已经说过。

在这里插入图片描述

LongPollingClientConfig

LongPollingClientConfig也是一个配置了，被spring.factories指定自动装配，通过@Bean往Spring注册一个LongPollingClient。

在这里插入图片描述

总结

这里我们可以再回顾一下服务端的LongPollingService和客户端的LongPollingClient的关系。

在这里插入图片描述

  1. 通过websocket建立了长连接
  2. 建立连接后，会回调监听器RefreshListener发送对应的environment和serviceName，LongPollingService接收到后会保存其与Session的对应关系
  3. 当服务端发生配置变更，会调用LongPollingService发送配置变更通知，LongPollingService会通过environment和serviceName取得对应的Session，通过Session推送配置变更通知
  4. 当客户端接收到配置变更通知后，会回调RefreshListener发送一个RefreshEvent事件
  5. 通过Spring的事件监听机制，RefreshEventListener接收到RefreshEvent事件，触发配置的重新加载和销毁旧的bean

由于篇幅关系，上面并没有展示详细的代码，如果想详细阅读代码的，可以git仓库下载：
https://gitee.com/huang_junyi/simple-microservice
在这里插入图片描述

这篇关于【深入理解SpringCloud微服务】深入理解微服务配置中心原理，并手写一个微服务配置中心的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1126611。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Zookeeper安装和配置说明

Zookeeper安装和配置说明

一、Zookeeper的搭建方式 Zookeeper安装方式有三种，单机模式和集群模式以及伪集群模式。 ■ 单机模式：Zookeeper只运行在一台服务器上，适合测试环境； ■ 伪集群模式：就是在一台物理机上运行多个Zookeeper 实例； ■ 集群模式：Zookeeper运行于一个集群上，适合生产环境，这个计算机集群被称为一个“集合体”（ensemble） Zookeeper通过复制来实现
阅读更多...
CentOS7安装配置mysql5.7 tar免安装版

CentOS7安装配置mysql5.7 tar免安装版

一、CentOS7.4系统自带mariadb # 查看系统自带的Mariadb[root@localhost~]# rpm -qa|grep mariadbmariadb-libs-5.5.44-2.el7.centos.x86_64# 卸载系统自带的Mariadb[root@localhost ~]# rpm -e --nodeps mariadb-libs-5.5.44-2.el7
阅读更多...
hadoop开启回收站配置

hadoop开启回收站配置

开启回收站功能，可以将删除的文件在不超时的情况下，恢复原数据，起到防止误删除、备份等作用。 开启回收站功能参数说明 （1）默认值fs.trash.interval = 0，0表示禁用回收站；其他值表示设置文件的存活时间。 （2）默认值fs.trash.checkpoint.interval = 0，检查回收站的间隔时间。如果该值为0，则该值设置和fs.trash.interval的参数值相等。
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2