详解自动注册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网关配置

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网关路由功能。只需要在新的微服务中配置好对应的元数据即可。不管是先启动网关服务,还是其他微服务。都能够自动的将路由进行注册。

作者:苦瓜不苦077

%s 个评论

要回复文章请先登录注册