欢迎访问Spring Cloud中国社区

《重新定义Spring Cloud实战》由Spring Cloud中国社区倾力打造,基于Spring Cloud的Finchley.RELEASE版本,本书内容宽度足够广、深度足够深,而且立足于生产实践,直接从生产实践出发,包含大量生产实践的配置。欢迎加微信Software_King进群答疑,国内谁在使用Spring Cloud?欢迎登记

使用Nacos实现Spring Cloud Gateway的动态路由

xujin · 1月前 · 984 ·

摘要:本文主要介绍通过Nacos下发路由配置实现Spring Cloud Gateway的动态路由。

1.前言

网关中有两个重要的概念,那就是路由配置和路由规则,路由配置是指配置某请求路径路由到指定的目的地址。而路由规则是指匹配到路由配置之后,再根据路由规则进行转发处理。
Spring Cloud Gateway作为所有请求流量的入口,在实际生产环境中为了保证高可靠和高可用,尽量避免重启,需要实现Spring Cloud Gateway动态路由配置。前面章节介绍了Spring Cloud Gateway提供的两种方法去配置路由规则,但都是在Spring Cloud Gateway启动时候,就将路由配置和规则加载到内存里,无法做到不重启网关就可以动态的对应路由的配置和规则进行增加,修改和删除。本文是基于Spring Cloud Gateway的动态路由实现
基础之上编写,通过Nacos配置服务下发路由配置实现动态路由。

<!-- more -->

2. Spring Cloud Gateway简单的动态路由实现

Spring Cloud Gateway的官方文档并没有讲如何动态配置,查看 Spring Cloud Gateway的源码,发现在org.springframework.cloud.gateway.actuate.GatewayControllerEndpoint类中提供了动态配置的Rest接口,但是需要开启Gateway的端点,而且提供的功能不是很强大。通过参考和GatewayControllerEndpoint相关的代码,可以自己编码实际动态路由配置。
下面通过案例的方式去讲解怎么通Nacos实现Spring Cloud Gateway的动态路由。案例工程如spring-cloud-gateway-nacos所示。

代码地址:https://github.com/SpringCloud/spring-cloud-gateway-nacos

3. 简单动态路由的实现

3.1 新建Maven工程sc-gateway-server

配置主要的核心依赖如代码清单所示:
代码清单: spring-cloud-gateway-nacos/sc-gateway-server/pom.xml

  1. <dependency>
  2. <groupId>org.springframework.cloud</groupId>
  3. <artifactId>spring-cloud-starter-gateway</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>com.alibaba.nacos</groupId>
  7. <artifactId>nacos-client</artifactId>
  8. <version>0.4.0</version>
  9. </dependency>
  10. <dependency>
  11. <groupId>org.springframework.boot</groupId>
  12. <artifactId>spring-boot-starter-webflux</artifactId>
  13. </dependency>
  14. <dependency>
  15. <groupId>org.springframework.boot</groupId>
  16. <artifactId>spring-boot-starter-actuator</artifactId>
  17. </dependency>
  18. <dependency>
  19. <groupId>com.alibaba</groupId>
  20. <artifactId>fastjson</artifactId>
  21. <version>1.2.47</version>
  22. </dependency>

3.2 根据Spring Cloud Gateway的路由模型定义数据传输模型

分别创建GatewayRouteDefinition.java, GatewayPredicateDefinition.java, GatewayFilterDefinition.java这三个类。
(1) 创建路由定义模型

  1. public class GatewayRouteDefinition {
  2. //路由的Id
  3. private String id;
  4. //路由断言集合配置
  5. private List<GatewayPredicateDefinition> predicates = new ArrayList<>();
  6. //路由过滤器集合配置
  7. private List<GatewayFilterDefinition> filters = new ArrayList<>();
  8. //路由规则转发的目标uri
  9. private String uri;
  10. //路由执行的顺序
  11. private int order = 0;
  12. //此处省略get和set方法
  13. }

(2)创建过滤器定义模型

  1. public class GatewayFilterDefinition {
  2. //Filter Name
  3. private String name;
  4. //对应的路由规则
  5. private Map<String, String> args = new LinkedHashMap<>();
  6. //此处省略Get和Set方法
  7. }

(3)创建路由断言定义模型

  1. public class GatewayPredicateDefinition {
  2. //断言对应的Name
  3. private String name;
  4. //配置的断言规则
  5. private Map<String, String> args = new LinkedHashMap<>();
  6. //此处省略Get和Set方法
  7. }

3.3 编写动态路由实现类

编写DynamicRouteServiceImpl并实现ApplicationEventPublisherAware接口,代码如下所示

  1. @Service
  2. public class DynamicRouteServiceImpl implements ApplicationEventPublisherAware {
  3. @Autowired
  4. private RouteDefinitionWriter routeDefinitionWriter;
  5. private ApplicationEventPublisher publisher;
  6. //增加路由
  7. public String add(RouteDefinition definition) {
  8. routeDefinitionWriter.save(Mono.just(definition)).subscribe();
  9. this.publisher.publishEvent(new RefreshRoutesEvent(this));
  10. return "success";
  11. }
  12. //更新路由
  13. public String update(RouteDefinition definition) {
  14. try {
  15. this.routeDefinitionWriter.delete(Mono.just(definition.getId()));
  16. } catch (Exception e) {
  17. return "update fail,not find route routeId: "+definition.getId();
  18. }
  19. try {
  20. routeDefinitionWriter.save(Mono.just(definition)).subscribe();
  21. this.publisher.publishEvent(new RefreshRoutesEvent(this));
  22. return "success";
  23. } catch (Exception e) {
  24. return "update route fail";
  25. }
  26. }
  27. //删除路由
  28. public Mono<ResponseEntity<Object>> delete(String id) {
  29. return this.routeDefinitionWriter.delete(Mono.just(id))
  30. .then(Mono.defer(() -> Mono.just(ResponseEntity.ok().build())))
  31. .onErrorResume(t -> t instanceof NotFoundException, t -> Mono.just(ResponseEntity.notFound().build()));
  32. }
  33. @Override
  34. public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
  35. this.publisher = applicationEventPublisher;
  36. }
  37. }

3.4 编写Nacos监听接收下发的路由配置

3.4.1 使用Nacos监听下发的配置

监听Nacos Config Server下发配置的代码如下所示:

  1. @Component
  2. public class DynamicRouteServiceImplByNacos {
  3. @Autowired
  4. private DynamicRouteServiceImpl dynamicRouteService;
  5. public DynamicRouteServiceImplByNacos() {
  6. dynamicRouteByNacosListener("sc-gateway","xujin_test");
  7. }
  8. /**
  9. * 监听Nacos Server下发的动态路由配置
  10. * @param dataId
  11. * @param group
  12. */
  13. public void dynamicRouteByNacosListener (String dataId, String group){
  14. try {
  15. ConfigService configService=NacosFactory.createConfigService("127.0.0.1:8848");
  16. String content = configService.getConfig(dataId, group, 5000);
  17. System.out.println(content);
  18. configService.addListener(dataId, group, new Listener() {
  19. @Override
  20. public void receiveConfigInfo(String configInfo) {
  21. RouteDefinition definition= JSON.parseObject(configInfo,RouteDefinition.class);
  22. dynamicRouteService.update(definition);
  23. }
  24. @Override
  25. public Executor getExecutor() {
  26. return null;
  27. }
  28. });
  29. } catch (NacosException e) {
  30. //todo 提醒:异常自行处理此处省略
  31. }
  32. }
  33. }

3.4.2 两种方式创建ConfigService

使用两种方式创建com.alibaba.nacos.api.config.ConfigService

  • 1.构建Properties创建

使用createConfigService(Properties properties),代码如下所示:

  1. Properties properties = new Properties();
  2. properties.put("nacos.server-addr", "");
  3. properties.put(PropertyKeyConst.SERVER_ADDR, "127.0.0.1:8848");
  4. ConfigService configService=NacosFactory.createConfigService(properties);

注意:PropertyKeyConst是com.alibaba.nacos.api.PropertyKeyConst

  • 2.只传递Nacos Config Server的地址
  1. ConfigService configService=NacosFactory.createConfigService("127.0.0.1:8848");

4. 使用Nacos下发配置

4.1 Nacos概述

Naocs由阿里开源,Nacos 致力于帮助您发现、配置和管理微服务。Nacos 提供了一组简单易用的特性集,帮助您快速实现动态服务发现、服务配置、服务元数据及流量管理。
Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。 Nacos 是构建以“服务”为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。github地址:https://github.com/alibaba/nacos

更多Nacos的介绍,请访问官方网站:https://nacos.io/

4.2 在IDE中启动 Nacos

访问https://github.com/alibaba/nacos ,使用Git克隆Nacos代码,直接导入到IDEA中,如下所示设置启动参数,直接启动。

从IDE中启动Nacos是我比较推荐的方式,因为可以随时Debug Nacos任何代码,其它启动方式请参考官网。

5.测试

5.1 Nacos中下发Spring Cloud Gateway的路由配置

  • 2.在Nacos的配置列表点击+按钮,下发Spring Cloud Gateway的路由配置,如下所示:


用于测试的示例数据,如下所示:

  1. {
  2. "filters": [],
  3. "id": "jd_route",
  4. "order": 0,
  5. "predicates": [{
  6. "args": {
  7. "pattern": "/jd"
  8. },
  9. "name": "Path"
  10. }],
  11. "uri": "http://www.jd.com"
  12. }


5.2 启动sc-gateway-server

  • 1.Debug启动sc-gateway-server,调试截图如下所示:

  • 2.通过Spring Cloud gateway的端点,查看路由信息

5.3 更新路由配置

  • 1.通过Nacos下发配置,修改Spring Cloud Gateway的动态路由规则

  • 2.查看访问Spring Cloud gateway的端点配置,可以看到动态路由修改如下: