詳解自動(dòng)注冊(cè)Gateway網(wǎng)關(guān)路由配置
動(dòng)態(tài)路由配置
在啟動(dòng)網(wǎng)關(guān)服務(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熱加載配置需要通過nacos的config配置中心實(shí)現(xiàn)動(dòng)態(tài)刷新,將yml配置文件放在nacos的配置列表中,通過連接nacos讀取config中心的yml配置文件,使用@RefreshScope來實(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è)路由
描述
既然可以通過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加載路由來實(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ù)后打開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)路由配置 * 通過注冊(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)聽注解,監(jiān)聽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ì)象記錄的是配置成功的路由,通過服務(wù)ID來判斷唯一性 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(); // 判斷是否開啟注冊(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)聽失敗\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)文章
java隨機(jī)數(shù)生成具體實(shí)現(xiàn)代碼
這篇文章主要為大家分享了java隨機(jī)數(shù)生成具體實(shí)現(xiàn)代碼,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-04-04Java編程Webservice指定超時(shí)時(shí)間代碼詳解
這篇文章主要介紹了Java編程Webservice指定超時(shí)時(shí)間代碼詳解,簡(jiǎn)單介紹了webservice,然后分享了通過使用JDK對(duì)Webservice的支持進(jìn)行Webservice調(diào)用實(shí)現(xiàn)指定超時(shí)時(shí)間完整示例,具有一定借鑒價(jià)值,需要的朋友可以參考下。2017-11-11Java參數(shù)傳遞實(shí)現(xiàn)代碼及過程圖解
這篇文章主要介紹了Java參數(shù)傳遞實(shí)現(xiàn)代碼及過程圖解,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-11-11Java獲取文件的類型和擴(kuò)展名的實(shí)現(xiàn)方法
這篇文章主要介紹了Java獲取文件的類型和擴(kuò)展名的實(shí)現(xiàn)方法的相關(guān)資料,需要的朋友可以參考下2017-02-02javaweb實(shí)戰(zhàn)之商城項(xiàng)目開發(fā)(二)
這篇文章主要針對(duì)javaweb商城項(xiàng)目開發(fā)進(jìn)行實(shí)戰(zhàn)演習(xí),利用mybatis創(chuàng)建DAO層,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-02-02Java后端Cookie實(shí)現(xiàn)(時(shí)間戳)代碼實(shí)例
這篇文章主要介紹了Java后端Cookie實(shí)現(xiàn)(時(shí)間戳)代碼實(shí)例,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-12-12SpringBoot接口防抖(防重復(fù)提交)的實(shí)現(xiàn)方案
所謂防抖,一是防用戶手抖,二是防網(wǎng)絡(luò)抖動(dòng),在Web系統(tǒng)中,表單提交是一個(gè)非常常見的功能,如果不加控制,容易因?yàn)橛脩舻恼`操作或網(wǎng)絡(luò)延遲導(dǎo)致同一請(qǐng)求被發(fā)送多次,所以本文給大家介紹了SpringBoot接口防抖(防重復(fù)提交)的實(shí)現(xiàn)方案,需要的朋友可以參考下2024-04-04教你開發(fā)腳手架集成Spring?Boot?Actuator監(jiān)控的詳細(xì)過程
這篇文章主要介紹了開發(fā)腳手架集成Spring?Boot?Actuator監(jiān)控的詳細(xì)過程,集成包括引入依賴配置文件及訪問驗(yàn)證的相關(guān)知識(shí),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-05-05