• Spring Cloud网关路由谓词

    博主介绍：✌全网粉丝5W，全栈开发工程师，从事多年软件开发，在大厂呆过。持有软件中级、六级等证书。可提供微服务项目搭建与毕业项目实战，博主也曾写过优秀论文，查重率极低，在这方面有丰富的经验✌

    博主作品：《Java项目案例》主要基于SpringBoot+MyBatis/MyBatis-plus+MySQL+Vue等前后端分离项目，可以在左边的分类专栏找到更多项目。《Uniapp项目案例》有几个有uniapp教程，企业实战开发。《微服务实战》专栏是本人的实战经验总结，《Spring家族及微服务系列》专注Spring、SpringMVC、SpringBoot、SpringCloud系列、Nacos等源码解读、热门面试题、架构设计等。除此之外还有不少文章等你来细细品味，更多惊喜等着你哦

    🍅uniapp微信小程序🍅面试题软考题免费使用，还可以使用ChatGPT，微信支付，扫码加群

    点击这里预览

    🍅开源项目免费哦(有vue2与vue3版本)：点击这里克隆或者下载      🍅

    🍅文末获取联系🍅精彩专栏推荐订阅👇🏻👇🏻 不然下次找不到哟

    Java项目案例《100套》

    https://blog.csdn.net/qq_57756904/category_12173599.html

    uniapp小程序《100套》
    https://blog.csdn.net/qq_57756904/category_12199600.html

    目录

    一、前言

    1、注意事项

    2、词汇表

    3、工作原理

    二、配置路由谓词工厂

    1、快捷方式

    1.1、快捷方式配置

    1.2、完全展开的参数

    2、路由谓词工厂

    2.1、路由谓词工厂之后

    2.2、路线谓词工厂之前

    2.3、路由谓词工厂之间

    3、Cookie路线谓词工厂

    4、标头路由谓词工厂

    5、主机路由谓词工厂

    6、方法路线谓词工厂

    7、路径路线谓词工厂

    8、查询路由谓词工厂

    9、RemoteAddr路由谓词工厂

    10、重量路线谓词工厂

    10.1、修改解析远程地址的方式

    一、前言

        Spring Cloud Gateway提供了一个基于Spring生态系统的API网关，其中包括：Spring 5，Spring Boot 2和项目Reactor。Spring Cloud网关的目的是提供一种简单而有效的方法来路由到API，并向它们提供跨领域的关注，例如：安全性，监视/度量和弹性。

    1、注意事项

    Spring Cloud网关需要Spring Boot和Spring Webflux提供的Netty运行环境。它不能在传统的Servlet容器中或作为WAR构建。如果不希望启用网关，则设置spring.cloud.gateway.enabled=false。

    2、词汇表

    • 路由：路由网关的基本构建块。它由ID，目标URI，谓词集合和过滤器集合定义。如果聚合谓词为true，则匹配路由。
    • 谓词：这是 Java 8 Function谓词。输入类型为 Spring Framework ServerWebExchange。这使开发人员可以匹配HTTP请求中的任何内容，例如标头或参数。
    • 过滤器：这些是使用特定工厂构造的实例 Spring Framework GatewayFilter。在此，可以在发送下游请求之前或之后修改请求和响应。

    3、工作原理

        客户端向Spring Cloud网关发出请求。如果网关处理程序映射确定请求与路由匹配，则将其发送到网关Web处理程序。该处理程序运行通过特定于请求的筛选器链发送请求。筛选器由虚线分隔的原因是，筛选器可以在发送代理请求之前或之后执行逻辑。执行所有“前置”过滤器逻辑，然后发出代理请求。发出代理请求后，将执行“后置”过滤器逻辑。 拦截器也同样有前进和逆过程，即前置后置处理。

    二、配置路由谓词工厂

        有两种配置谓词和过滤器的方法：快捷方式和完全扩展的参数。下面的大多数示例都使用快捷方式。配置路由谓词工厂使用application.yml配置文件。

    1、快捷方式

    1.1、快捷方式配置

    快捷方式配置由过滤器名称识别，后跟等号（=），后跟由逗号分隔的参数值（,）。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: after_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Cookie=mycookie,mycookievalue

    先前的示例使用两个参数定义了Cookie Route Predicate Factory，即cookie名称mycookie和与mycookievalue相匹配的值。

    1.2、完全展开的参数

    完全扩展的参数看起来更像带有名称/值对的标准Yaml配置。通常，将有一个name键和一个args键。args键是用于配置谓词或过滤器的键值对的映射。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: after_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - name: Cookie
    9.           args:
    10.             name: mycookie
    11.             regexp: mycookievalue

    这是上面显示的Cookie谓词的快捷方式配置的完整配置。

    2、路由谓词工厂

    Spring Cloud网关将路由匹配为Spring WebFlux HandlerMapping基础结构的一部分。Spring Cloud网关包括许多内置的Route Predicate工厂。所有这些谓词都与HTTP请求的不同属性匹配。多个路由谓词工厂可以合并，也可以通过逻辑and合并。

    2.1、路由谓词工厂之后

    After路由谓词工厂采用一个参数，即datetime（这是Java ZonedDateTime）。该谓词匹配在当前日期时间之后发生的请求。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: after_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - After=2017-01-20T17:42:47.789-07:00[America/Denver]

    该路线与2017年1月20日17:42山区时间（丹佛）之后的所有请求匹配。

    2.2、路线谓词工厂之前

    Before路由谓词工厂采用一个参数datetime（它是Java ZonedDateTime）。该谓词匹配当前日期时间之前发生的请求。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: before_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

    该路线与2017年1月20日17:42山区时间（丹佛）之前的所有请求匹配。

    2.3、路由谓词工厂之间

    Between路由谓词工厂采用两个参数datetime1和datetime2，它们是Java ZonedDateTime对象。该谓词匹配在datetime1之后和datetime2之前发生的请求。datetime2参数必须在datetime1之后。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: between_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

    该路线与2017年1月20日山区时间（丹佛）之后和2017年1月21日17:42山区时间（丹佛）之后的所有请求匹配。这对于维护时段可能很有用。

    3、Cookie路线谓词工厂

    Cookie Route Predicate Factory采用两个参数，即cookie name和regexp（这是Java正则表达式）。该谓词匹配具有给定名称的cookie，并且值匹配正则表达式。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: cookie_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Cookie=chocolate, ch.p

    此路由与请求匹配，具有一个名为chocolate的cookie，该cookie的值与ch.p正则表达式匹配。

    4、标头路由谓词工厂

    Header Route Predicate Factory具有两个参数，标头name和regexp（这是Java正则表达式）。该谓词与具有给定名称的标头匹配，并且值与正则表达式匹配。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: header_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Header=X-Request-Id, \d+

    如果请求具有名为X-Request-Id的标头，且其值与\d+正则表达式匹配（具有一个或多个数字的值），则此路由匹配。

    5、主机路由谓词工厂

    Host Route Predicate Factory采用一个参数：主机名patterns的列表。模式是Ant样式的模式，以.作为分隔符。该谓词与匹配模式的Host头匹配。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: host_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Host=**.somehost.org,**.anotherhost.org

    还支持URI模板变量，例如{sub}.myhost.org。

    如果请求的Host标头的值为www.somehost.org或beta.somehost.org或www.anotherhost.org，则此路由将匹配。

    该谓词提取URI模板变量（如上例中定义的sub）作为名称和值的映射，并使用在ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE中定义的键将其放置在ServerWebExchange.getAttributes()中。这些值可供GatewayFilter工厂使用。

    6、方法路线谓词工厂

    Method路由谓词工厂采用一个methods参数，该参数是一个或多个要匹配的HTTP方法。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: method_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Method=GET,POST

    如果请求方法是GET或POST，则此路由将匹配。

    7、路径路线谓词工厂

    Path路由谓词工厂采用两个参数：Spring PathMatcher patterns的列表和matchOptionalTrailingSeparator的可选标志。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: host_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Path=/foo/{segment},/bar/{segment}

    如果请求路径为例如/foo/1或/foo/bar或/bar/baz，则此路由将匹配。

    该谓词提取URI模板变量（如以上示例中定义的segment）作为名称和值的映射，并使用在ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE中定义的键将其放置在ServerWebExchange.getAttributes()中。这些值可供GatewayFilter工厂使用。

    可以使用实用程序方法来简化对这些变量的访问。

    1. Map uriVariables = ServerWebExchangeUtils.getPathPredicateVariables(exchange);
    2.  
    3. String segment = uriVariables.get("segment");

    8、查询路由谓词工厂

    Query Route Predicate Factory采用两个参数：必需的param和可选的regexp（这是Java正则表达式）。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: query_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Query=baz

    如果请求包含baz查询参数，则此路由将匹配。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: query_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - Query=foo, ba.

    如果请求包含一个foo查询参数，其值与ba.正则表达式匹配，则此路由将匹配，因此bar和baz将匹配。

    9、RemoteAddr路由谓词工厂

    RemoteAddr路由谓词工厂采用sources的列表（最小大小1），它是CIDR表示法（IPv4或IPv6）字符串，例如192.168.0.1/16（其中192.168.0.1是IP地址， 16是子网掩码）。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: remoteaddr_route
    6.         uri: https://example.org
    7.         predicates:
    8.         - RemoteAddr=192.168.1.1/24

    如果请求的远程地址为192.168.1.10，则此路由将匹配。

    10、重量路线谓词工厂

    Weight Route Predicate Factory接受两个参数group和weight（一个int）。权重是按组计算的。

    1. spring:
    2.   cloud:
    3.     gateway:
    4.       routes:
    5.       - id: weight_high
    6.         uri: https://weighthigh.org
    7.         predicates:
    8.         - Weight=group1, 8
    9.       - id: weight_low
    10.         uri: https://weightlow.org
    11.         predicates:
    12.         - Weight=group1, 2

    此路由会将约80％的流量转发到https://weighthigh.org，并将约20％的流量转发到https://weighlow.org

    10.1、修改解析远程地址的方式

    默认情况下，RemoteAddr路由谓词工厂使用传入请求中的远程地址。如果Spring Cloud网关位于代理层后面，则此地址可能与实际的客户端IP地址不匹配。

    可以通过设置自定义RemoteAddressResolver来自定义解析远程地址的方式。Spring Cloud网关带有一个基于 X-Forwarded-For标头XForwardedRemoteAddressResolver的非默认远程地址解析器。

    XForwardedRemoteAddressResolver有两个静态构造方法，它们采用不同的安全性方法：

    • XForwardedRemoteAddressResolver::trustAll返回一个RemoteAddressResolver，该地址始终使用在X-Forwarded-For标头中找到的第一个IP地址。这种方法容易受到欺骗，因为恶意客户端可能会为X-Forwarded-For设置一个初始值，该初始值将被解析程序接受。
    • XForwardedRemoteAddressResolver::maxTrustedIndex获取一个索引，该索引与在Spring Cloud网关前面运行的受信任基础结构的数量相关。例如，如果Spring Cloud网关只能通过HAProxy访问，则应使用值1。如果在访问Spring Cloud网关之前需要两跳可信基础结构，则应使用值2。

    给定以下标头值：

    X-Forwarded-For: 0.0.0.1, 0.0.0.2, 0.0.0.3

    下面的maxTrustedIndex值将产生以下远程地址。

    maxTrustedIndex结果

    [Integer.MIN_VALUE,0]

    (invalid, IllegalArgumentException during initialization)

    1

    0.0.0.3

    2

    0.0.0.2

    3

    0.0.0.1

    [4, Integer.MAX_VALUE]

    0.0.0.1

    使用Java配置：

    GatewayConfig.java

    1. RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
    2.     .maxTrustedIndex(1);
    3.  
    4. ...
    5.  
    6. .route("direct-route",
    7.     r -> r.remoteAddr("10.1.1.1", "10.10.1.1/24")
    8.         .uri("https://downstream1")
    9. .route("proxied-route",
    10.     r -> r.remoteAddr(resolver,  "10.10.1.1", "10.10.1.1/24")
    11.         .uri("https://downstream2")
    12. )

  • 相关阅读:
    苹果召开WWDC：属于你的“定制”AI智能？
    期刊会议排名、信息检索网站推荐以及IEEE Latex模板下载
    十六、商城 - 品牌管理-CRUD（4）
    Sentry安装配置与使用
    浏览器如何导入Cookie
    低代码技术与仓储管理的新纪元：革命性的供应链变革
    编程时不知道怎么给函数起一个好名字时怎么办
    APP订单管理软件生活中不可或缺|小程序系统定制开发|网站搭建
    删除Github仓库中的指定的文件或文件夹
    从静态链接到动态链接，彻底理解ELF
  • 原文地址：https://blog.csdn.net/qq_57756904/article/details/127897279