spring-gateway+nacos+schedule实现动态路由

1. 首先声明： 

     本文不会去讲gateway的基础知识。

2.  开发背景：

     spring-gateway路由配置通常有两种，一种通过yml文件中、另外一种是通过代码组件RouteDefinition的方式。这两种方式都是将路由写死，而我们的真实场景，网管是不允许重启的，网关部署后，需要动态感知业务服务的增删。因此在这一场景下，需要开发一种gateway动态感知服务的变化完成内存中路由的刷新。

3.  方式1： 将配置写在nacos上，gateway监控nacos上的配置完成。源码见下：

@Component
public class NacosDynamicRouteService implements ApplicationEventPublisherAware {
 
    private String dataId = "gateway-router";
 
    private String group = "DEFAULT_GROUP";
 
    @Value("${spring.cloud.nacos.config.server-addr}")
    private String serverAddr;
 
    @Autowired
    private RouteDefinitionWriter routeDefinitionWriter;
 
    private ApplicationEventPublisher applicationEventPublisher;
 
    private static final List<String> ROUTE_LIST = new ArrayList<>();
 
    @PostConstruct
    public void dynamicRouteByNacosListener() {
        try {
            ConfigService configService = NacosFactory.createConfigService(serverAddr);
            configService.getConfig(dataId, group, 5000);
            configService.addListener(dataId, group, new Listener() {
                @Override
                public void receiveConfigInfo(String configInfo) {
                    clearRoute();
                    try {
                        List<RouteDefinition> gatewayRouteDefinitions = JSONObject.parseArray(configInfo, RouteDefinition.class);
                        for (RouteDefinition routeDefinition : gatewayRouteDefinitions) {
                            addRoute(routeDefinition);
                        }
                        publish();
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
 
                @Override
                public Executor getExecutor() {
                    return null;
                }
            });
        } catch (NacosException e) {
            e.printStackTrace();
        }
    }
 
    private void clearRoute() {
        for(String id : ROUTE_LIST) {
            this.routeDefinitionWriter.delete(Mono.just(id)).subscribe();
        }
        ROUTE_LIST.clear();
    }
 
    private void addRoute(RouteDefinition definition) {
        try {
            routeDefinitionWriter.save(Mono.just(definition)).subscribe();
            ROUTE_LIST.add(definition.getId());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
 
    private void publish() {
        this.applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this.routeDefinitionWriter));
    }
 
    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.applicationEventPublisher = applicationEventPublisher;
    }
}

 

因此，此方式需要我们每次上线新的业务服务后，需要专业人员去操作gateway-router这一配置文件，按照一定的格式，去填写业务服务的路由及对应的predicate，filter等。格式例子如下：

[{
    "id": "account-router",
    "order": 0,
    "predicates": [{
        "args": {
            "pattern": "/acc/**"
        },
        "name": "Path"
    }],
    "uri": "lb://account-service"
},{
    "id": "payment-router",
    "order": 2,
    "predicates": [{
        "args": {
            "pattern": "/pay/**"
        },
        "name": "Path"
    }],
    "uri": "lb://payment-service"
}]

 

4. 方式 2：通过定时任务，全自动化的去读取注册到nacos上的服务列表进行注册。(代码待更新)

 

    我们需要编写带有Schedule的方法，此方法通过nacos暴露的api接口完成所有业务服务名称列表的获取，完成动态的完成路由的刷新。

 

 

总结： 以上两种方式各有利弊，然而都不是实时的方式，第一种方式需要在config修改后才能生效，第二种方式需要在cron表达式设定的时间后才能刷新，如果设置短cpu压力过大，如果设置长，业务服务的路由又感知很慢，因此cron表达式也需要衡量。

新的方式待研究。