Spring Cloud Gateway匹配路由作为SpringWebFlux HandlerMapping基础设施的一部分。Spring Cloud Gateway包含许多内置的路由断言工厂,这些断言匹配不同属性的HTTP请求。可以组合多个路由断言工厂,并通过逻辑组合。
After Route Predicate Factory有一个时间参数.,此断言匹配发生在该时间参数之后的请求。
这个路由匹配发生在 Jan 20, 2017 17:42 Mountain Time (Denver)之后的请求。
Before Route Predicate Factory
Before Route Predicate Factory 有一个时间参数,此断言匹配发生在该时间参数之前的请求。
这个路由匹配发生在 Jan 20, 2017 17:42 Mountain Time (Denver)之前的请求。
Between Route Predicate Factory
Between Route Predicate Factory 有两个时间参数。此断言匹配发生在这两个时间之间的请求。
这个路由匹配发生在 Jan 20, 2017 17:42 Mountain Time (Denver)与Jan 21, 2017 17:42 Mountain Time (Denver)之间的请求。可应用于维护窗口。
Cookie Route Predicate Factory
Cookie Route Predicate Factory 有两个参数,包括cookie名称和正则表达式。此断言匹配cookies包括给定的名称和符合正则表达式的值。
此路由匹配cookie名称为chocolate ,cookie值为ch.p正则表达式,匹配chap,chbp等。
Header Route Predicate Factory
Header Route Predicate Factory 包括两个参数包括头名称和值的正则表达式。此断言匹配一个头信息包括该名称和符合该正则表达式值得请求。
此路由匹配头名称为X-Request-Id且值匹配\d+ 表达式(包含一个或多个数字)。
Host Route Predicate Factory包括一个参数host 名称模式列表。此模式是一种 Ant 风格模式,以 "." 作为分隔符。此断言匹配Host头。另外Host头来源有两种:第一种是请求地址;第二种是自己在http的header头中放入Host变量值。
URI 模板变量也支持这种格式 {sub}.myhost.org。
此路由匹配头文件中的Host值www.somehost.org,beta.somehost.org 或 www.anotherhost.org。此示例均为默认端口80,如果为其他端口,需要在表达式中定义。
此断言提取URI模板变量(如上面示例中定义的子变量)作为名称和值的映射,并将其放置在ServerWebExchange.getAttributes()中,其键在ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE属性中定义。这些值随后可供网关过滤器工厂( GatewayFilter Factories)使用。
在过滤其中加入如下代码示例:
Map uri_template_variables_attribute=exchange.getAttribute(ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
// Map variables=ServerWebExchangeUtils.getUriTemplateVariables(exchange);
uri_template_variables_attribute.forEach((K,V)->{
System.out.println("K:"+K+"--V:"+V);
});
访问Host为:www.myhost.org
输出结果: K:sub--V:www
ANT通配符有三种:
Method Route Predicate Factory
Method Route Predicate Factory 只有一个参数:HTTP method。
此路由匹配GET方法的请求。
Path Route Predicate Factory 包含两个参数:列表(Spring PathMatcher模式,默认也是AntMather模式) 和 可选matchOptionalTrailingSeparator.
此路由匹配请求如:/foo/1 、/foo/bar 或 /bar/baz。
此断言提取URI模板变量(如上面示例中定义的子变量)作为名称和值的映射,并将其放置在ServerWebExchange.getAttributes()中,其键在ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE属性中定义。这些值随后可供网关过滤器工厂( GatewayFilter Factories)使用。
实用程序方法可以使访问这些变量更容易。
Query Route Predicate Factory 包含两个参数:一个请求参数,可选的正则表达式。
此路由匹配包含baz参数的请求。
此路由匹配请求包含foo参数,并且值匹配为ba. 表达式,则将会被路由,如:bar、baz
RemoteAddr Route Predicate Factory
RemoteAddr Route Predicate Factory 包括 CIDR-notation (IPv4 or IPv6) 列表,至少有一个地址,例如:192.168.0.1/16 (192.168.0.1是IP地址, 16是子网掩码)。
此路由匹配远程请求地址满足上述地址的,例如192.1168.1.10,(前24位代表网络地址,最后8位代表主机数量)。
备注:本地调试时,可以根据ip地址进行访问,不要用localhost或者127.0.0.1进行访问。
修改远程地址的解析方式
RemoteAddr Route Predicate Factory默认使用来源请求的远程地址。如果SpringCloudGateway位于代理层后面,则这可能与实际的客户机IP地址不匹配。
你可以自定义RemoteAddressResolver来解析远程地址。 Spring Cloud Gateway有一个非默认的地址解析器-XForwardedRemoteAddressResolver,该解析器基于x-forwarded-for header。
XForwardedRemoteAddressResolver 有两个静态构造方法,他们分别采取了不同的安全措施,具体如下:
XForwardedRemoteAddressResolver::trustAll 返回一个RemoteAddressResolver,它始终使用在X-Forwarded-for头中找到的第一个IP地址。这种方法容易受到欺骗,因为恶意客户端设置一个X-Forwarded-For的初始值,且该初始值可以被解析器接受。
XForwardedRemoteAddressResolver::maxTrustedIndex获取索引,该索引与Spring Cloud Gateway之前受信任基础设施有关。如果Spring Cloud Gateway仅通过HAProxy访问,那么应使用值1;如果受信任基础设施在Spring Cloud Gateway之前可以是两级,那么改为就为2。
给出如下header值:
maxTrustedIndex值如下将生产出如下远程地址 :
用在java配置中,例如:
GatewayConfig.java
实例解析:Gateway做网关代理,路由和断言信息由第三方配置。假如:某个客户配置了RemoteAddr Route Predicate Factory,且当前gateway网关前有两层代理(第一层 HAproxy,第二层 Nginx)。如何获取到用户的真实IP?解决棒法:
1.在gateway前面的代理中修改头信息,第一层 HAproxy和第二层 Nginx对X-Forwarded-for不做叠加,只存原始用户的地址;
2.可以通过gateway提供的方式解决。通过动态生成类的方式,RemoteAddr Route Predicate Factory的方式,并且指定XForwardedRemoteAddressResolver;
3.自定义断言,将XForwardedRemoteAddressResolver作为默认的解析方式。