Spring Cloud Gateway 源码剖析之Predicate谓词详解

} else {

Iterator var3 = cookies.iterator();

HttpCookie cookie;

do {

if (!var3.hasNext()) {

return false;

}

cookie = (HttpCookie)var3.next();

} while(!cookie.getValue().matches(config.regexp));

return true;

}

};

}

2.5 HeaderRoutePredicateFactory

• Route 匹配 ：请求头满足匹配

• 配置：

spring:

cloud:

gateway:

routes:

• id: header_route

uri: http://example.org

predicates:

• Header=X-Request-Id, \d+

• 代码：

public Predicate apply(HeaderRoutePredicateFactory.Config config) {

boolean hasRegex = !StringUtils.isEmpty(config.regexp);

return (exchange) -> {

List values = (List)exchange.getRequest().getHeaders().getOrDefault(config.header, Collections.emptyList());

if (values.isEmpty()) {

return false;

} else {

return hasRegex ? values.stream().anyMatch((value) -> {

return value.matches(config.regexp);

}) : true;

}

};

}

2.6 HostRoutePredicateFactory

• Route 匹配 ：请求 Host 匹配指定值

• 配置：

spring:

cloud:

gateway:

routes:

• id: host_route

uri: http://example.org

predicates:

• Host=**.somehost.org

• 代码：

public Predicate apply(HostRoutePredicateFactory.Config config) {

return (exchange) -> {

String host = exchange.getRequest().getHeaders().getFirst(“Host”);

Optional optionalPattern = config.getPatterns().stream().filter((pattern) -> {

return this.pathMatcher.match(pattern, host);

}).findFirst();

if (optionalPattern.isPresent()) {

Map<String, String> variables = this.pathMatcher.extractUriTemplateVariables((String)optionalPattern.get(), host);

ServerWebExchangeUtils.putUriTemplateVariables(exchange, variables);

return true;

} else {

return false;

}

};

}

2.7 MethodRoutePredicateFactory

• Route 匹配 ：请求 Method 匹配指定值

• 配置：

spring:

cloud:

gateway:

routes:

• id: method_route

uri: http://example.org

predicates:

• Method=GET

• 代码：

public Predicate apply(MethodRoutePredicateFactory.Config config) {

return (exchange) -> {

HttpMethod requestMethod = exchange.getRequest().getMethod();

return requestMethod == config.getMethod();

};

}

2.8 PathRoutePredicateFactory

• Route 匹配 ：请求 Path 匹配指定值

• 配置：

spring:

cloud:

gateway:

routes:

• id: host_route

uri: http://example.org

predicates:

• Path=/foo/{segment}

• 代码：

public Predicate apply(PathRoutePredicateFactory.Config config) {

ArrayList pathPatterns = new ArrayList();

synchronized(this.pathPatternParser) {

this.pathPatternParser.setMatchOptionalTrailingSeparator(config.isMatchOptionalTrailingSeparator());

config.getPatterns().forEach((pattern) -> {

PathPattern pathPattern = this.pathPatternParser.parse(pattern);

pathPatterns.add(pathPattern);

});

}

return (exchange) -> {

PathContainer path = PathContainer.parsePath(exchange.getRequest().getURI().getPath());

Optional optionalPathPattern = pathPatterns.stream().filter((pattern) -> {

return pattern.matches(path);

}).findFirst();

if (optionalPathPattern.isPresent()) {

PathPattern pathPattern = (PathPattern)optionalPathPattern.get();

traceMatch(“Pattern”, pathPattern.getPatternString(), path, true);

PathMatchInfo pathMatchInfo = pathPattern.matchAndExtract(path);

ServerWebExchangeUtils.putUriTemplateVariables(exchange, pathMatchInfo.getUriVariables());

return true;

} else {

traceMatch(“Pattern”, config.getPatterns(), path, false);

return false;

}

};

}

2.9 QueryRoutePredicateFactory

• Route 匹配 ：请求 QueryParam 匹配指定值

• 配置：

spring:

cloud:

gateway:

routes:

• id: query_route

uri: http://example.org

predicates:

• Query=baz

• Query=foo, ba.

• 代码：

public Predicate apply(QueryRoutePredicateFactory.Config config) {

return (exchange) -> {

if (!StringUtils.hasText(config.regexp)) {

return exchange.getRequest().getQueryParams().containsKey(config.param);

} else {

List values = (List)exchange.getRequest().getQueryParams().get(config.param);

if (values == null) {

return false;

} else {

Iterator var3 = values.iterator();

String value;

do {

if (!var3.hasNext()) {

return false;

}

value = (String)var3.next();

} while(value == null || !value.matches(config.regexp));

return true;

}

}

};

}

2.10 RemoteAddrRoutePredicateFactory

• Route 匹配 ：请求来源 IP 在指定范围内

• 配置：

spring:

cloud:

gateway:

routes:

• id: remoteaddr_route

uri: http://example.org

predicates:

• RemoteAddr=192.168.1.1/24

• 代码：

public Predicate apply(RemoteAddrRoutePredicateFactory.Config config) {

List sources = this.convert(config.sources);

return (exchange) -> {

InetSocketAddress remoteAddress = config.remoteAddressResolver.resolve(exchange);

if (remoteAddress != null && remoteAddress.getAddress() != null) {

String hostAddress = remoteAddress.getAddress().getHostAddress();

String host = exchange.getRequest().getURI().getHost();

if (log.isDebugEnabled() && !hostAddress.equals(host)) {

log.debug("Remote addresses didn’t match " + hostAddress + " != " + host);

}

Iterator var6 = sources.iterator();

while(var6.hasNext()) {

IpSubnetFilterRule source = (IpSubnetFilterRule)var6.next();

if (source.matches(remoteAddress)) {

return true;

}

}

}

return false;

};

}

三、RoutePredicateHandlerMapping

---

我们先来看下 Spring Cloud Gateway 官网提供的架构图：

上一节讲完了常见分类的 Predicate 匹配规则，客户端发送请求过来，通过 HandlerMapping 进行 predicate 的匹配，匹配成功再进行下面的处理。

3.1 org.springframework.web.reactive.DispatcherHandler

接收到请求，匹配 HandlerMapping ，此处会匹配到 RoutePredicateHandlerMapping。 由于 Gateway 是构建在 reactive 上的，所以这边的 web 类型就是 reactive。

public class DispatcherHandler implements WebHandler, ApplicationContextAware {

private static final Exception HANDLER_NOT_FOUND_EXCEPTION;

@Nullable

private List handlerMappings;

@Nullable

private List handlerAdapters;

@Nullable

private List resultHandlers;

public Mono handle(ServerWebExchange exchange) {

return this.handlerMappings == null ? this.createNotFoundError() :

// 顺序使用 handlerMappings 获得对应的 WebHandler

Flux.fromIterable(this.handlerMappings).concatMap((mapping) -> {

// 获得 Handler

return mapping.getHandler(exchange);

// 如果匹配不到 WebHandler ，返回 HANDLER_NOT_FOUND_EXCEPTION 。

}).next().switchIfEmpty(this.createNotFoundError()).flatMap((handler) -> {

// 调用 invokeHandler() 方法，执行 Handler 。

return this.invokeHandler(exchange, handler);

}).flatMap((result) -> {

// 调用 handleResult() 方法，处理结果

return this.handleResult(exchange, result);

});

}

…

}

继续跟一下 invokeHandler() 方法：

private Mono invokeHandler(ServerWebExchange exchange, Object handler) {

if (this.handlerAdapters != null) {

// 获取Adapters， WebHandler 的处理器适配器。

Iterator var3 = this.handlerAdapters.iterator();

while(var3.hasNext()) {

HandlerAdapter handlerAdapter = (HandlerAdapter)var3.next();

// 调用support方法 ，是否支持 WebHandler

if (handlerAdapter.supports(handler)) {

// 调用handle 方法，执行处理器

return handlerAdapter.handle(exchange, handler);

}

}

}

return Mono.error(new IllegalStateException("No HandlerAdapter: " + handler));

}

public boolean supports(Object handler) {

return WebHandler.class.isAssignableFrom(handler.getClass());

}

public Mono handle(ServerWebExchange exchange, Object handler) {

WebHandler webHandler = (WebHandler)handler;

// 执行处理器。例如，WebHandler 为 FilteringWebHandler 时，获得 Route 的 GatewayFilter 数组，创建 GatewayFilterChain 处理请求。

Mono mono = webHandler.handle(exchange);

// 在 WebHandler 执行完后 #then(Mongo)，然后返回 Mono.empty() 。

return mono.then(Mono.empty());

}

SimpleHandlerAdapter 返回的是 Mono.empty() ，所以不会触发该方法。

private Mono handleResult(ServerWebExchange exchange, HandlerResult result) {
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

对于很多Java工程师而言，想要提升技能，往往是自己摸索成长，不成体系的学习效果低效漫长且无助。

整理的这些资料希望对Java开发的朋友们有所参考以及少走弯路，本文的重点是你有没有收获与成长，其余的都不重要，希望读者们能谨记这一点。

再分享一波我的Java面试真题+视频学习详解+技能进阶书籍

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！
*[外链图片转存中…(img-rwDSENCG-1711817125643)]

[外链图片转存中…(img-5TjXRTDL-1711817125644)]

[外链图片转存中…(img-TsKSv6XG-1711817125644)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

对于很多Java工程师而言，想要提升技能，往往是自己摸索成长，不成体系的学习效果低效漫长且无助。

整理的这些资料希望对Java开发的朋友们有所参考以及少走弯路，本文的重点是你有没有收获与成长，其余的都不重要，希望读者们能谨记这一点。

再分享一波我的Java面试真题+视频学习详解+技能进阶书籍

[外链图片转存中…(img-TPeYPb15-1711817125645)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！