关于Spring cloud Gateway集成nacos 实现路由到指定微服务的方式总结

项目地址

Nacos

两种方式实现nacos服务注册与发现

Nacos服务注册与发现的2种实现方法

1.OpenAPI模式

2.SDK模式

Spring Cloud GateWay

gateway网关路由配置详解

gateway动态配置网关路由规则

微服务路由

方式1，nacos自动下发

应用

请求路径中包含微服务名

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/demo-system/sys/gatewayRoute/list

应用场景

gateway 微服务路由

配置方式

application.yml

spring:  
  cloud:
    gateway:
      # 此处配置表示开启自动映射naocs下发的路由
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
      default-filters:
  main:
    allow-bean-definition-overriding: true #当遇到同样名字的时候，是否允许覆盖注册

优点

nacos自动下发，和gateway本身无关，路由转发的功能由nacos分担。因此对开发友好，易上手。

缺点

只要是 微服务 demo-system的接口都可以进行请求。请求范围大。

方式2，yml 配置路由规则

应用

gateway 根据路径参数查找 对应的服务进行路由。

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/sys/gatewayRoute/list

应用场景

jeecg-boot gateway服务路由

配置方式

application.yml

spring:
  cloud:
    gateway:
      # 配置路由规则
      routes:
        # 采用自定义路由 ID（有固定用法，不同的 id 有不同的功能
        - id: demo-business
          # 采用 LoadBalanceClient 方式请求，以 lb:// 开头，后面的是注册在 Nacos 上的服务名
          uri: lb://demo-business
#          uri: http://192.168.0.105:18000
          # Predicate 翻译过来是“谓词”的意思，必须，主要作用是匹配用户的请求，有很多种用法
          predicates:
            - Path=/business/**,/biz/**
            # Method 方法谓词，这里是匹配 GET 和 POST 请求
            - Method=GET,POST

        - id: demo-system
          uri: lb://demo-system
          predicates:
            - Path=/system/**,/sys/**

优点

因为是否能路由到对应的微服务，是根据路由条件进行匹配的，所以这种路由方式更加严格，自定义路由条件配置。路由范围自定义。

缺点

如果出现对路由规则条件配置的变更，活增加新的微服务，都需要停掉网关服务，然后进行配置，再进行部署。比较繁琐。

方式3， 数据库读取路由配置规则

应用

为了解决方式2的缺点，即不停网关服务，依然能进行配置路由规则，并且路由功能生效，这就诞生了数据库动态路由。

动态路由的机制：

1）实现一个Spring提供的事件推送接口ApplicationEventPublisherAware，

2）提供动态路由的基础方法，可通过获取bean操作该类的方法。该类提供新增路由、更新路由、删除路由，然后实现发布的功能。

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/sys/gatewayRoute/list

应用场景

jeecg-boot 默认 gateway服务路由方式

配置方式

优点

方便集中管理，自定义程度较高。

缺点

需要由webflux基础，上手较难。需要有网关路由条件配置界面。

如果是微服务名不同，匹配路径相同，比如 jeecg-system 和demo-system 微服务 都有查询路由这个路径规则 /sys/**，启动jeecg-system, 停止demo-system，可能会出现找服务找到demo-system，而不是 jeecg-system微服务。从而出现微服务不可用异常。

jeecg-boot 使用自定义 status 来控制 微服务是否可用，而不是根据实际nacos注册中心中注册的微服务实例 来进行判断是否进行路由。

Spring Cloud LoadBalancer

https://blog.csdn.net/feiying0canglang/article/details/126815588

SpringCloud从2020版本开始移除了对Ribbon的依赖，官方使用Spring Cloud Loadbalancer正式替换Ribbon，而且Spring Cloud Loadbalancer成为了Spring Cloud负载均衡器的唯一实现。

方式4， nacos配置路由规则json文件

应用

路由规则配置在 demo-gateway-router.json，然后在demo-gateway-dev.yaml中指定路由规则时nacos。

例如：查询 微服务 demo-system 下的路由接口列表信息，其中网关微服务的端口是 9999。

http://localhost:9999/sys/gatewayRoute/list

应用场景

jeecg-boot 可以选择使用 nacos 路由配置规则，动态刷新路由。

配置方式

demo-gateway-router.json

[{
  "id": "jeecg-system",
  "order": 6,
  "predicates": [{
    "name": "Path",
    "args": {
      "_genkey_0": "/sys/**",
      "_genkey_1": "/jmreport/**",
      "_genkey_3": "/online/**",
      "_genkey_4": "/generic/**"
    }
  }],
  "filters": [],
  "uri": "lb://jeecg-system"
}, {
  "id": "jeecg-demo",
  "order": 1,
  "predicates": [{
    "name": "Path",
    "args": {
      "_genkey_0": "/mock/**",
      "_genkey_1": "/test/**",
      "_genkey_2": "/bigscreen/template1/**",
      "_genkey_3": "/bigscreen/template2/**"
    }
  }],
  "filters": [],
  "uri": "lb://jeecg-demo"
}, {
  "id": "jeecg-system-websocket",
  "order": 2,
  "predicates": [{
    "name": "Path",
    "args": {
      "_genkey_0": "/websocket/**",
      "_genkey_1": "/newsWebsocket/**"
    }
  }],
  "filters": [],
  "uri": "lb:ws://jeecg-system"
}, {
  "id": "jeecg-demo-websocket",
  "order": 3,
  "predicates": [{
    "name": "Path",
    "args": {
      "_genkey_0": "/vxeSocket/**"
    }
  }],
  "filters": [],
  "uri": "lb:ws://jeecg-demo"
},{
  "id": "demo-system",
  "order": 4,
  "predicates": [{
    "name": "Path",
    "args": {
      "_genkey_0": "/sys/**",
      "_genkey_1": "/system/**"
    }
  }],
  "filters": [],
  "uri": "lb://demo-system"
}, {
  "id": "demo-business",
  "order": 5,
  "predicates": [{
    "name": "Path",
    "args": {
      "_genkey_0": "/mock/**",
      "_genkey_1": "/business/**"
    }
  }],
  "filters": [],
  "uri": "lb://demo-business"
}]

优点

易上手。实现动态路由，在nacos修改路由规则后可以不用重启网关，路由生效。

缺点

如果微服务一多，维护可能复杂。

如果是微服务名不同，匹配路径相同，比如 jeecg-system 和demo-system 微服务 都有查询路由这个路径规则 /sys/**，启动jeecg-system, 停止demo-system，可能会出现找服务找到demo-system，而不是 jeecg-system微服务。从而出现微服务不可用异常。

总结

综上所述，作者认为实现spring cloud 动态路由最好的方式是 使用nacos自动下发。