自動注冊Gateway網關路由怎么配置

本文小編為大家詳細介紹“自動注冊Gateway網關路由怎么配置”，內容詳細，步驟清晰，細節處理妥當，希望這篇“自動注冊Gateway網關路由怎么配置”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來學習新知識吧。

動態路由配置

在啟動網關服務后，將無法修改路由配置。若有新服務上線的話則需要重新部署網關服務。為了避免網關重新部署，動態路由也隨之出現。

而常用的Gateway動態路由配置有兩種方式，在講解自動注冊動態路由配置之前，先了解一下動態路由配置。一種是yml熱加載配置，另一種是基于Bean加載路由。兩種方式都是目前較為常用的動態路由配置，各有各自的優勢，擇其一即可。

基于yml配置文件

基于yml熱加載配置需要通過nacos的config配置中心實現動態刷新，將yml配置文件放在nacos的配置列表中，通過連接nacos讀取config中心的yml配置文件，使用@RefreshScope來實現動態刷新。后續如果有新的微服務，將在config配置中心添加路由配置即可，從而實現動態加載路由。

基于Bean加載路由

代碼實現方式可以此鏈接中查看

在Gateway網關服務啟動時，配置的路由信息會加載到內存中。為了能夠實現隨時都可加載，需要實現ApplicationEventPublisherAware接口，該接口中主要方法是一個ApplicationEventPublisher，其作用讓配置立即生效，發布進程內的消息。

還有一個注入類RouteDefinitionWriter路由定義的寫入，路由模型信息是寫入到該類中。調用RouteDefinitionWriter類中的save()方法進行保存，delete()方法可刪除路由。對外提供save()和delete()的API接口，實現動態配置。

自動注冊路由

描述

既然可以通過Bean加載路由，那么是不是可以使用一種方式，實現啟動微服務之后，能夠不用再配置yml或者不調用API接口的方式實現啟動微服務之后自動對路由進行注冊功能呢。

原理

在所有的注冊中心中，都會有一個心跳機制，而這個心跳機制是檢測其他服務是否存活，每隔一段時間就會發起檢測機制。我們就可以利用這個心跳機制和Bean加載路由來實現一個，啟動微服務即可自動將路由加載到網關中的一個功能實現。

代碼實現

其他微服務的配置

重點是在spring.cloud.nacos.discovery.metadata的元數據中配置路由信息，metadata接收是使用Map集合接收的數據

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注冊中心，即可查看到剛剛所添加的元數據

Gateway網關配置

GatewayRouteConfig類的實現方式可以查看

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;
/**
 * 自動注冊網關路由配置
 * 通過注冊中心的心跳機制實時查詢是否注冊
 *
 * @author 苦瓜不苦
 * @date 2022/11/15 14:19
 **/
@Slf4j
@Configuration
public class RouteRegisterConfig {
    // nacos服務發現
    private final NacosServiceDiscovery nacosServiceDiscovery;
    // 自定義的ApplicationEventPublisherAware子類，里面實現了save()和delete()方法
    private final GatewayRouteConfig gatewayRouteConfig;
    public RouteRegisterConfig(NacosServiceDiscovery nacosServiceDiscovery, GatewayRouteConfig gatewayRouteConfig) {
        this.nacosServiceDiscovery = nacosServiceDiscovery;
        this.gatewayRouteConfig = gatewayRouteConfig;
    }
    // @EventListener事件監聽注解，監聽HeartbeatEvent心跳機制
    @EventListener(classes = HeartbeatEvent.class)
    public void eventListen(ApplicationEvent applicationEvent) {
        try {
            // 根據當前服務分組查詢注冊的所有服務名
            List<String> serviceList = nacosServiceDiscovery.getServices();
            if (Objects.isNull(serviceList) || serviceList.size() <= 0) {
                return;
            }
            // 循環所有服務獲取服務信息
            for (String service : serviceList) {
                // 判斷是否注冊路由，MAP對象記錄的是配置成功的路由，通過服務ID來判斷唯一性
                if (gatewayRouteConfig.MAP.containsKey(service)) {
                    continue;
                }
                // 獲取當前服務ID所有的節點
                List<ServiceInstance> instanceList = nacosServiceDiscovery.getInstances(service);
                if (Objects.isNull(instanceList) || instanceList.size() <= 0) {
                    continue;
                }
                // 獲取指定服務ID的第一個節點，是否需要遍歷所有，根據實際情況決定，因為會存在一個微服務多實例節點
                ServiceInstance instance = instanceList.get(0);
                // 獲取當前實例節點的元數據，主要是獲取到上面所配置的信息
                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}\"}}]}";
                    // 替換模板中的數據
                    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);
                    // 調用注冊路由方法
                    gatewayRouteConfig.save(definition);
                    log.info("服務節點 {} 注冊路由成功, 路由信息 \n {}", service, JSON.toJSONString(definition));
                }
            }
        } catch (NacosException e) {
            log.error("注冊中心心跳機制監聽失敗\n", e);
        }
    }
}

自此，就已經完成了自動注冊Gateway網關路由功能。只需要在新的微服務中配置好對應的元數據即可。不管是先啟動網關服務，還是其他微服務。都能夠自動的將路由進行注冊。

讀到這里，這篇“自動注冊Gateway網關路由怎么配置”文章已經介紹完畢，想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領會，如果想了解更多相關內容的文章，歡迎關注億速云行業資訊頻道。