简述

以代码 或 配置文件形式进行配置。
RewritePath:路径匹配切割
StripPrefix: 路径载取

参数说明

id: 路由ID
uri: 目标地址,可以是服务,如果服务Spring推荐用全大写,实际调用大小写不敏感,都可以调通。
predicates: 匹配路径,以浏览器请求的端口号后面的第一级路径为起始。
filters: 过滤器,包含Spring Gateway 内置过滤器,可以自定义过滤器。

1.请求转发,转发到目标地址

1
2
3
4
5
6
routes:
# 跳转URL
- id: 163_route
uri: http://www.163.com/
predicates:
- Path=/163

2.切路径

1
2
3
4
5
6
7
# oauth2 认证
- id: OAUTH2
uri: lb://OAUTH-SERVER
predicates:
- Path=/oauth-server/**
filters:
- StripPrefix=1

参数说明

  1. StripPrefix的意思是将路径切掉一级,这个例子中 oauth-server 被剪。
  2. 请求路径:localhost:9000/oauth-server/oauth-center/oauth/token?username=admin
  3. 最终结果:lb://OAUTH-SERVER/oauth-center/oauth/token?username=admin

3.请求重写

1
2
3
4
5
6
7
# oauth2 认证
- id: OAUTH2
uri: lb://OAUTH-SERVER/
predicates:
- Path=/oauth-server/**
filters:
- RewritePath=/oauth-server/(?<path>.*), /$\{path}
  1. 请求路径: localhost:9000/oauth-server/oauth-center/oauth/token?username=admin
  2. 最终结果: lb://OAUTH-SERVER/oauth-center/oauth/token?username=admin

验证了一下,RewritePath 的处理方式

  1. RewritePath 找到自己的 /oauth-server/ 这一段,从 - Path 中去匹配,如果能匹配的到就是会将路径进行切割,注意是切割
  2. 切割方式将 /oauth-server/(?<path>.*) ,中 <path> 中的路径切出来,也就是 oauth-server/后面的部份。
  3. 并将切的结果赋值到 {path} 中。
  4. 最后的拼接路径为: lb://SPRINGCLOUD-PROVIDER/path

-Path 设置多个无效

验证 predicates 的 -Path 设置多个无效,如果 -Path 中的路径匹配对了,但是 RewritePath 中的路径和-Path 匹配不上会报HTTP Status 404

4.路径重定--结果路径多一级

4.路径重写
这个测试,是在请求路径中不存在的url,添加到最终的请求路径中去

1
2
3
4
5
6
- id: OAUTH2
uri: lb://OAUTH-SERVER/
predicates:
- Path=/oauth-server/**
filters:
- RewritePath=/oauth-server/(?<path>.*), /oauth-center/$\{path}
  • 请求路径: localhost:9000/oauth-server/oauth/token?username=admin
  • 最终结果: lb://OAUTH-SERVER/oauth-center/oauth/token?username=admin
    oauth-center 在请求的路径中不存在,在 RewritePath 中进行重写,添加了一级路径。

总结

  1. RewritePath: predicates 中的 - path 路径如果和 RewritePath 匹配则会被 RewritePath 剪切。
  2. StripPrefix:剪取指定路径位数截取
1
2
3
4
5
6
7
举个示例
- id: rewritepath_route
uri: http://example.org
predicates:
- Path=/a/b/**
filters:
- RewritePath=/a/b/(?<segment>.*), /f/$\{segment}

结果

请求的时为: /a/b/c
最终结果为: /f/c