spring gateway中路由匹配规则的断言知道这几个就够了

最新推荐文章于 2024-07-18 22:44:05 发布

原创最新推荐文章于 2024-07-18 22:44:05 发布 · 2.9k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#spring #gateway #java

本文详细介绍了SpringCloud Gateway中的路由匹配机制，包括通过请求参数、Header、Cookie、Host等多种方式实现精确路由，并展示了如何结合多种匹配条件进行复杂的路由设置。

Spring Cloud Gateway的主要功能之一是转发请求，转发规则的定义主要包含三个部分：

1、Route（路由）

2、Predicate（谓语、断言）

3、Filter（过滤器）

在 Spring Cloud Gateway 中 Spring 利用 Predicate 的特性实现了各种路由匹配规则，有通过 Header、请求参数等不同的条件来进行作为条件匹配到对应的路由

常见Predicate，如图所示

通过请求参数匹配

Query Route Predicate 支持传入两个参数，一个是属性名一个为属性值，属性值可以是正则表达式。

spring:
  cloud:
    gateway:
      routes:
        - id: service1
          uri: https://www.baidu.com
          order: 0
          predicates:
            - Query=smile

这样配置，只要请求中包含 smile 属性的参数即可匹配路由。使用 curl 测试，命令行输入：curl localhost:9005?smile=x&id=2，经过测试发现只要请求汇总带有 smile 参数即会匹配路由，不带 smile 参数则不会匹配。

还可以将 Query 的值以键值对的方式进行配置，这样在请求过来时会对属性值和正则进行匹配，匹配上才会走路由。

spring:
  cloud:
    gateway:
      routes:
        - id: service3
          uri: https://www.baidu.com
          order: 0
          predicates:
            - Query=keep, pu.

这样只要当请求中包含 keep 属性并且参数值是以 pu 开头的长度为三位的字符串才会进行匹配和路由。

使用 curl 测试，命令行输入：curl localhost:8080?keep=pub，测试可以返回页面代码，将 keep 的属性值改为 pubx 再次访问就会报 404，证明路由需要匹配正则表达式才会进行路由。

2. 通过Header匹配

Header Route Predicate 和 Query Route Predicate 一样，也是接收 2 个参数，一个 header 中属性名称和一个正则表达式，这个属性值和正则表达式匹配则执行。

spring:
  cloud:
    gateway:
      routes:        
        - id: service4
          uri: https://www.baidu.com
          order: 0
          predicates:
            - Header=X-Request-Id, \d+

使用 curl 测试，命令行输入：curl http://localhost:9005 -H "X-Request-Id:88"，则返回页面代码证明匹配成功。将参数-H "X-Request-Id:88"改为-H "X-Request-Id:spring"，再次执行时返回404证明没有匹配。

3. 通过Cookie匹配

Cookie Route Predicate 可以接收两个参数，一个是 Cookie name ,一个是正则表达式，路由规则会通过获取对应的 Cookie name 值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上则不执行。

spring:
  cloud:
    gateway:
      routes:        
        - id: service5
          uri: https://www.baidu.com
          predicates:
            - Cookie=sessionId, test

使用 curl 测试，命令行输入，curl http://localhost:9005 --cookie "sessionId=test"，则会返回页面代码，如果去掉--cookie "sessionId=test"，后台汇报 404 错误。

4. 通过Host匹配

Host Route Predicate 接收一组参数，一组匹配的域名列表，这个模板是一个 ant 分隔的模板，用.号作为分隔符。它通过参数中的主机地址作为匹配规则。

spring:
  cloud:
    gateway:
      routes:    
        - id: service6
          uri: https://www.baidu.com
          predicates:
            - Host=**.baidu.com

使用 curl 测试，命令行输入，curl http://localhost:9005 -H "Host: www.baidu.com"或者curl http://localhost:8080 -H "Host: md.baidu.com"，经测试以上两种 host 均可匹配到 host_route 路由，去掉 host 参数则会报 404 错误。

5. 通过请求方式匹配

可以通过是 POST、GET、PUT、DELETE 等不同的请求方式来进行路由。

spring:
  cloud:
    gateway:
      routes:    
        - id: service7
          uri: https://www.baidu.com
          predicates:
            - Method=PUT

使用 curl 测试，命令行输入，curl -X PUT http://localhost:9005，测试返回页面代码，证明匹配到路由，以其他方式，返回 404 没有找到，证明没有匹配上路由

6. 通过请求路径匹配

Path RoutePredicate 接收一个匹配路径的参数来判断是否路由。

spring:
  cloud:
    gateway:
      routes:    
        - id: service8
          uri: http://127.0.0.1:9001
          predicates:
            - Path=/payment/{segment}

如果请求路径符合要求，则此路由将匹配， curl 测试，命令行输入，curl http://localhost:9005/payment/1，

可以正常获取到页面返回值，curl http://localhost:9005/payment2/1，报404，证明路由是通过指定路由来匹配。

7. 组合匹配

spring:
  cloud:
    gateway:
      routes:    
        - id: service9
          uri: https://www.baidu.com
          order: 0
          predicates:
            - Host=**.foo.org
            - Path=/headers
            - Method=GET
            - Header=X-Request-Id, \d+
            - Query=foo, ba.
            - Query=baz
            - Cookie=chocolate, ch.p

各种 Predicates 同时存在于同一个路由时，请求必须同时满足所有的条件才被这个路由匹配。

一个请求满足多个路由的断言条件时，请求只会被首个成功匹配的路由转发