客户端接入原理
将应用客户端接入到Apache ShenYu
网关是通过注册中心来实现的,涉及到客户端注册和服务端同步数据。注册中心支持Http
、Zookeeper
、Etcd
、Consul
和Nacos
。
客户端接入的相关配置请参考用户文档中的 客户端接入配置 。
在你的微服务配置中声明注册中心客户端类型,如Http
或Zookeeper
。 应用程序启动时使用SPI
方式加载并初始化对应注册中心客户端,通过实现Spring Bean
相关的后置处理器接口,在其中获取需要进行注册的服务接口信息,将获取的信息放入Disruptor
中。
注册中心客户端从Disruptor
中读取数据,并将接口信息注册到shenyu-admin
,Disruptor
在其中起数据与操作解耦的作用,利于扩展。
在shenyu-admin
配置中声明注册中心服务端类型,如Http
或Zookeeper
。当shenyu-admin
启动时,读取配置类型,加载并初始化对应的注册中心服务端,注册中心服务端收到shenyu-client
注册的接口信息后,将其放入Disruptor
中,然后会触发注册处理逻辑,将服务接口信息更新并发布同步事件。
Http
服务注册原理较为简单,在shenyu-client
启动后,会调用shenyu-admin
的相关服务注册接口,上传数据进行注册。
shenyu-admin
收到请求后进行数据更新和数据同步事件发布,将接口信息同步到Apache ShenYu
网关。
Zookeeper
存储结构如下:
shenyu-client
启动时,将服务接口信息()写到如上的zookeeper
节点中。
shenyu-admin
使用Zookeeper
的Watch
机制,对数据的更新和删除等事件进行监听,数据变更后触发对应的注册处理逻辑。在收到MetaDataRegisterDTO
节点变更后,触发selector
和rule
的数据变更和数据同步事件发布。收到URIRegisterDTO
节点变更后,触发selector
的upstream
的更新和数据同步事件发布。
Etcd
的键值存储结构如下:
shenyu-client
启动时,将服务接口信息(MetaDataRegisterDTO/URIRegisterDTO
)以Ephemeral
方式写到如上的Etcd
节点中。
shenyu-admin
使用Etcd
的Watch
机制,对数据的更新和删除等事件进行监听,数据变更后触发对应的注册处理逻辑。在收到MetaDataRegisterDTO
节点变更后,触发selector
和rule
的数据变更和数据同步事件发布。收到URIRegisterDTO
节点变更后,触发selector
的upstream
的更新和数据同步事件发布。
Consul
的MetaDataRegisterDTO
存在Key/Value
里,键值存储结构如下:
shenyu-client
启动时,将服务接口信息(MetaDataRegisterDTO/URIRegisterDTO
)分别放在ServiceInstance
的(URIRegisterDTO
)和KeyValue
(MetaDataRegisterDTO
),按照上述方式进行存储。
shenyu-admin
通过监听Catalog
和KeyValue
的index
的变化,来感知数据的更新和删除,数据变更后触发对应的注册处理逻辑。在收到MetaDataRegisterDTO
节点变更后,触发selector
和rule
的数据变更和数据同步事件发布。收到URIRegisterDTO
节点变更后,触发selector
的upstream
的更新和数据同步事件发布。
Nacos
注册分为两部分:URI
和 Metadata
。URI
使用实例注册方式,在服务异常的情况下,相关URI
数据节点会自动进行删除,并发送事件到订阅端,订阅端进行相关的下线处理。Metadata
使用配置注册方式,没有相关上下线操作,当有URI
实例注册时,会相应的发布Metadata
配置,订阅端监听数据变化,进行更新处理。
URI
实例注册命令规则如下:
初始监听所有的RpcType
节点,其下的${contextPath}
实例会对应注册到其下,根据IP
和Port
进行区分,并携带其对应的contextPath
信息。URI
实例上下线之后,触发selector
的upstream
的更新和数据同步事件发布。
URI
实例上线时,会发布对应的 Metadata
数据,其节点名称命令规则如下:
订阅端会对所有的Metadata
配置继续监听,当初次订阅和配置更新后,触发selector
和rule
的数据变更和数据同步事件发布。