动态路由装备

前言

在发动网关服务后，将无法修改路由装备。若有新服务上线的话则需求重新部署网关服务。为了防止网关重新部署，动态路由也随之出现。

而常用的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网关路由配置

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网关路由配置