詳解自動注冊Gateway網(wǎng)關路由配置
動態(tài)路由配置
在啟動網(wǎng)關服務后,將無法修改路由配置。若有新服務上線的話則需要重新部署網(wǎng)關服務。為了避免網(wǎng)關重新部署,動態(tài)路由也隨之出現(xiàn)。
而常用的Gateway動態(tài)路由配置有兩種方式,在講解自動注冊動態(tài)路由配置之前,先了解一下動態(tài)路由配置。一種是yml熱加載配置,另一種是基于Bean加載路由。兩種方式都是目前較為常用的動態(tài)路由配置,各有各自的優(yōu)勢,擇其一即可。
基于yml配置文件
基于yml熱加載配置需要通過nacos的config配置中心實現(xiàn)動態(tài)刷新,將yml配置文件放在nacos的配置列表中,通過連接nacos讀取config中心的yml配置文件,使用@RefreshScope來實現(xiàn)動態(tài)刷新。后續(xù)如果有新的微服務,將在config配置中心添加路由配置即可,從而實現(xiàn)動態(tài)加載路由。
基于Bean加載路由
在Gateway網(wǎng)關服務啟動時,配置的路由信息會加載到內(nèi)存中。為了能夠?qū)崿F(xiàn)隨時都可加載,需要實現(xiàn)ApplicationEventPublisherAware接口,該接口中主要方法是一個ApplicationEventPublisher,其作用讓配置立即生效,發(fā)布進程內(nèi)的消息。
還有一個注入類RouteDefinitionWriter路由定義的寫入,路由模型信息是寫入到該類中。調(diào)用RouteDefinitionWriter類中的save()方法進行保存,delete()方法可刪除路由。對外提供save()和delete()的API接口,實現(xiàn)動態(tài)配置。
自動注冊路由
描述
既然可以通過Bean加載路由,那么是不是可以使用一種方式,實現(xiàn)啟動微服務之后,能夠不用再配置yml或者不調(diào)用API接口的方式實現(xiàn)啟動微服務之后自動對路由進行注冊功能呢。
原理
在所有的注冊中心中,都會有一個心跳機制,而這個心跳機制是檢測其他服務是否存活,每隔一段時間就會發(fā)起檢測機制。我們就可以利用這個心跳機制和Bean加載路由來實現(xiàn)一個,啟動微服務即可自動將路由加載到網(wǎng)關中的一個功能實現(xiàn)。
代碼實現(xià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/**
啟動微服務后打開nacos注冊中心,即可查看到剛剛所添加的元數(shù)據(jù)
Gateway網(wǎng)關配置
GatewayRouteConfig類的實現(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; /** * 自動注冊網(wǎng)關路由配置 * 通過注冊中心的心跳機制實時查詢是否注冊 * * @author 苦瓜不苦 * @date 2022/11/15 14:19 **/ @Slf4j @Configuration public class RouteRegisterConfig { // nacos服務發(fā)現(xiàn) private final NacosServiceDiscovery nacosServiceDiscovery; // 自定義的ApplicationEventPublisherAware子類,里面實現(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心跳機制 @EventListener(classes = HeartbeatEvent.class) public void eventListen(ApplicationEvent applicationEvent) { try { // 根據(jù)當前服務分組查詢注冊的所有服務名 List<String> serviceList = nacosServiceDiscovery.getServices(); if (Objects.isNull(serviceList) || serviceList.size() <= 0) { return; } // 循環(huán)所有服務獲取服務信息 for (String service : serviceList) { // 判斷是否注冊路由,MAP對象記錄的是配置成功的路由,通過服務ID來判斷唯一性 if (gatewayRouteConfig.MAP.containsKey(service)) { continue; } // 獲取當前服務ID所有的節(jié)點 List<ServiceInstance> instanceList = nacosServiceDiscovery.getInstances(service); if (Objects.isNull(instanceList) || instanceList.size() <= 0) { continue; } // 獲取指定服務ID的第一個節(jié)點,是否需要遍歷所有,根據(jù)實際情況決定,因為會存在一個微服務多實例節(jié)點 ServiceInstance instance = instanceList.get(0); // 獲取當前實例節(jié)點的元數(shù)據(jù),主要是獲取到上面所配置的信息 Map<String, String> metadata = instance.getMetadata(); // 判斷是否開啟注冊路由 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)用注冊路由方法 gatewayRouteConfig.save(definition); log.info("服務節(jié)點 {} 注冊路由成功, 路由信息 \n {}", service, JSON.toJSONString(definition)); } } } catch (NacosException e) { log.error("注冊中心心跳機制監(jiān)聽失敗\n", e); } } }
自此,就已經(jīng)完成了自動注冊Gateway網(wǎng)關路由功能。只需要在新的微服務中配置好對應的元數(shù)據(jù)即可。不管是先啟動網(wǎng)關服務,還是其他微服務。都能夠自動的將路由進行注冊。
以上就是詳解自動注冊Gateway網(wǎng)關路由配置的詳細內(nèi)容,更多關于Gateway網(wǎng)關路由配置的資料請關注腳本之家其它相關文章!
相關文章
SpringBoot接口防抖(防重復提交)的實現(xiàn)方案
所謂防抖,一是防用戶手抖,二是防網(wǎng)絡抖動,在Web系統(tǒng)中,表單提交是一個非常常見的功能,如果不加控制,容易因為用戶的誤操作或網(wǎng)絡延遲導致同一請求被發(fā)送多次,所以本文給大家介紹了SpringBoot接口防抖(防重復提交)的實現(xiàn)方案,需要的朋友可以參考下2024-04-04教你開發(fā)腳手架集成Spring?Boot?Actuator監(jiān)控的詳細過程
這篇文章主要介紹了開發(fā)腳手架集成Spring?Boot?Actuator監(jiān)控的詳細過程,集成包括引入依賴配置文件及訪問驗證的相關知識,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-05-05