詳解自動(dòng)注冊(cè)Gateway網(wǎng)關(guān)路由配置
動(dòng)態(tài)路由配置
在啟動(dòng)網(wǎng)關(guān)服務(wù)后,將無(wú)法修改路由配置。若有新服務(wù)上線的話則需要重新部署網(wǎng)關(guān)服務(wù)。為了避免網(wǎng)關(guān)重新部署,動(dòng)態(tài)路由也隨之出現(xiàn)。
而常用的Gateway動(dòng)態(tài)路由配置有兩種方式,在講解自動(dòng)注冊(cè)動(dòng)態(tài)路由配置之前,先了解一下動(dòng)態(tài)路由配置。一種是yml熱加載配置,另一種是基于Bean加載路由。兩種方式都是目前較為常用的動(dòng)態(tài)路由配置,各有各自的優(yōu)勢(shì),擇其一即可。
基于yml配置文件
基于yml熱加載配置需要通過(guò)nacos的config配置中心實(shí)現(xiàn)動(dòng)態(tài)刷新,將yml配置文件放在nacos的配置列表中,通過(guò)連接nacos讀取config中心的yml配置文件,使用@RefreshScope來(lái)實(shí)現(xiàn)動(dòng)態(tài)刷新。后續(xù)如果有新的微服務(wù),將在config配置中心添加路由配置即可,從而實(shí)現(xiàn)動(dòng)態(tài)加載路由。
基于Bean加載路由
在Gateway網(wǎng)關(guān)服務(wù)啟動(dòng)時(shí),配置的路由信息會(huì)加載到內(nèi)存中。為了能夠?qū)崿F(xiàn)隨時(shí)都可加載,需要實(shí)現(xiàn)ApplicationEventPublisherAware接口,該接口中主要方法是一個(gè)ApplicationEventPublisher,其作用讓配置立即生效,發(fā)布進(jìn)程內(nèi)的消息。
還有一個(gè)注入類RouteDefinitionWriter路由定義的寫入,路由模型信息是寫入到該類中。調(diào)用RouteDefinitionWriter類中的save()方法進(jìn)行保存,delete()方法可刪除路由。對(duì)外提供save()和delete()的API接口,實(shí)現(xiàn)動(dòng)態(tài)配置。
自動(dòng)注冊(cè)路由
描述
既然可以通過(guò)Bean加載路由,那么是不是可以使用一種方式,實(shí)現(xiàn)啟動(dòng)微服務(wù)之后,能夠不用再配置yml或者不調(diào)用API接口的方式實(shí)現(xiàn)啟動(dòng)微服務(wù)之后自動(dòng)對(duì)路由進(jìn)行注冊(cè)功能呢。
原理
在所有的注冊(cè)中心中,都會(huì)有一個(gè)心跳機(jī)制,而這個(gè)心跳機(jī)制是檢測(cè)其他服務(wù)是否存活,每隔一段時(shí)間就會(huì)發(fā)起檢測(cè)機(jī)制。我們就可以利用這個(gè)心跳機(jī)制和Bean加載路由來(lái)實(shí)現(xiàn)一個(gè),啟動(dòng)微服務(wù)即可自動(dòng)將路由加載到網(wǎng)關(guān)中的一個(gè)功能實(shí)現(xiàn)。
代碼實(shí)現(xiàn)
其他微服務(wù)的配置
重點(diǎn)是在spring.cloud.nacos.discovery.metadata的元數(shù)據(jù)中配置路由信息,metadata接收是使用Map集合接收的數(shù)據(jù)
spring:
application:
name: item-order
cloud:
nacos:
server-addr: 127.0.0.1:8848
username: nacos
password: nacos
discovery:
metadata:
route.enable: true
route.prefix: 1
route.path: /order/**
啟動(dòng)微服務(wù)后打開(kāi)nacos注冊(cè)中心,即可查看到剛剛所添加的元數(shù)據(jù)

Gateway網(wǎng)關(guān)配置
GatewayRouteConfig類的實(shí)現(xiàn)方式可以查看
import com.alibaba.cloud.nacos.discovery.NacosServiceDiscovery;
import com.alibaba.fastjson.JSON;
import com.alibaba.nacos.api.exception.NacosException;
import lombok.extern.slf4j.Slf4j;
import org.example.gateway.base.GatewayRouteDefinition;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.event.HeartbeatEvent;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.EventListener;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* 自動(dòng)注冊(cè)網(wǎng)關(guān)路由配置
* 通過(guò)注冊(cè)中心的心跳機(jī)制實(shí)時(shí)查詢是否注冊(cè)
*
* @author 苦瓜不苦
* @date 2022/11/15 14:19
**/
@Slf4j
@Configuration
public class RouteRegisterConfig {
// nacos服務(wù)發(fā)現(xiàn)
private final NacosServiceDiscovery nacosServiceDiscovery;
// 自定義的ApplicationEventPublisherAware子類,里面實(shí)現(xiàn)了save()和delete()方法
private final GatewayRouteConfig gatewayRouteConfig;
public RouteRegisterConfig(NacosServiceDiscovery nacosServiceDiscovery, GatewayRouteConfig gatewayRouteConfig) {
this.nacosServiceDiscovery = nacosServiceDiscovery;
this.gatewayRouteConfig = gatewayRouteConfig;
}
// @EventListener事件監(jiān)聽(tīng)注解,監(jiān)聽(tīng)HeartbeatEvent心跳機(jī)制
@EventListener(classes = HeartbeatEvent.class)
public void eventListen(ApplicationEvent applicationEvent) {
try {
// 根據(jù)當(dāng)前服務(wù)分組查詢注冊(cè)的所有服務(wù)名
List<String> serviceList = nacosServiceDiscovery.getServices();
if (Objects.isNull(serviceList) || serviceList.size() <= 0) {
return;
}
// 循環(huán)所有服務(wù)獲取服務(wù)信息
for (String service : serviceList) {
// 判斷是否注冊(cè)路由,MAP對(duì)象記錄的是配置成功的路由,通過(guò)服務(wù)ID來(lái)判斷唯一性
if (gatewayRouteConfig.MAP.containsKey(service)) {
continue;
}
// 獲取當(dāng)前服務(wù)ID所有的節(jié)點(diǎn)
List<ServiceInstance> instanceList = nacosServiceDiscovery.getInstances(service);
if (Objects.isNull(instanceList) || instanceList.size() <= 0) {
continue;
}
// 獲取指定服務(wù)ID的第一個(gè)節(jié)點(diǎn),是否需要遍歷所有,根據(jù)實(shí)際情況決定,因?yàn)闀?huì)存在一個(gè)微服務(wù)多實(shí)例節(jié)點(diǎn)
ServiceInstance instance = instanceList.get(0);
// 獲取當(dāng)前實(shí)例節(jié)點(diǎn)的元數(shù)據(jù),主要是獲取到上面所配置的信息
Map<String, String> metadata = instance.getMetadata();
// 判斷是否開(kāi)啟注冊(cè)路由
if ("true".equals(metadata.get("route.enable"))) {
// 定制路由JSON模板
String template = "{\"filters\":[{\"name\":\"StripPrefix\",\"args\":{\"_genkey_0\":\"{StripPrefix}\"}}],\"id\":\"{id}\",\"uri\":\"lb://{id}\",\"order\":0,\"predicates\":[{\"name\":\"Path\",\"args\":{\"_genkey_0\":\"{Path}\"}}]}";
// 替換模板中的數(shù)據(jù)
template = template.replace("{id}", service)
.replace("{Path}", metadata.getOrDefault("route.path", "/**"))
.replace("{StripPrefix}", metadata.getOrDefault("route.prefix", "0"));
GatewayRouteDefinition definition = JSON.parseObject(template, GatewayRouteDefinition.class);
// 調(diào)用注冊(cè)路由方法
gatewayRouteConfig.save(definition);
log.info("服務(wù)節(jié)點(diǎn) {} 注冊(cè)路由成功, 路由信息 \n {}", service, JSON.toJSONString(definition));
}
}
} catch (NacosException e) {
log.error("注冊(cè)中心心跳機(jī)制監(jiān)聽(tīng)失敗\n", e);
}
}
}
自此,就已經(jīng)完成了自動(dòng)注冊(cè)Gateway網(wǎng)關(guān)路由功能。只需要在新的微服務(wù)中配置好對(duì)應(yīng)的元數(shù)據(jù)即可。不管是先啟動(dòng)網(wǎng)關(guān)服務(wù),還是其他微服務(wù)。都能夠自動(dòng)的將路由進(jìn)行注冊(cè)。

以上就是詳解自動(dòng)注冊(cè)Gateway網(wǎng)關(guān)路由配置的詳細(xì)內(nèi)容,更多關(guān)于Gateway網(wǎng)關(guān)路由配置的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Springmvc異常映射2種實(shí)現(xiàn)方法
這篇文章主要介紹了Springmvc異常映射2種實(shí)現(xiàn)方法以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。,需要的朋友可以參考下2020-05-05
使用MyBatis-Generator如何自動(dòng)生成映射文件
這篇文章主要介紹了使用MyBatis-Generator如何自動(dòng)生成映射文件,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02
java并發(fā)編程專題(八)----(JUC)實(shí)例講解CountDownLatch
這篇文章主要介紹了java CountDownLatch的相關(guān)資料,文中示例代碼非常詳細(xì),幫助大家理解和學(xué)習(xí),感興趣的朋友可以了解下2020-07-07
mybatis分頁(yè)絕對(duì)路徑寫法過(guò)程詳解
這篇文章主要介紹了mybatis分頁(yè)絕對(duì)路徑寫法過(guò)程詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-12-12
說(shuō)說(shuō)@ModelAttribute在父類和子類中的執(zhí)行順序
這篇文章主要介紹了@ModelAttribute在父類和子類中的執(zhí)行順序,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
解析MyBatisPlus解決邏輯刪除與唯一索引的兼容問(wèn)題
這篇文章主要介紹了MyBatisPlus解決邏輯刪除與唯一索引的兼容問(wèn)題,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-04-04

