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

• Cookie=chocolate, ch.p

• 代码：

public Predicate apply(CookieRoutePredicateFactory.Config config) {

return (exchange) -> {

List cookies = (List)exchange.getRequest().getCookies().get(config.name);

if (cookies == null) {

return false;

} 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;

学习分享，共勉

这里是小编拿到的学习资源，其中包括“中高级Java开发面试高频考点题笔记300道.pdf”和“Java核心知识体系笔记.pdf”文件分享，内容丰富，囊括了JVM、锁、并发、Java反射、Spring原理、微服务、Zookeeper、数据库、数据结构等大量知识点。同时还有Java进阶学习的知识笔记脑图（内含大量学习笔记）！

资料整理不易，读者朋友可以转发分享下！

Java核心知识体系笔记.pdf

中高级Java开发面试高频考点题笔记300道.pdf

架构进阶面试专题及架构学习笔记脑图

Java架构进阶学习视频分享

rAdapter: " + handler));

}

public boolean supports(Object handler) {

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

}

public Mono handle(ServerWebExchange exchange, Object handler) {

WebHandler webHandler = (WebHandler)handler;

学习分享，共勉

这里是小编拿到的学习资源，其中包括“中高级Java开发面试高频考点题笔记300道.pdf”和“Java核心知识体系笔记.pdf”文件分享，内容丰富，囊括了JVM、锁、并发、Java反射、Spring原理、微服务、Zookeeper、数据库、数据结构等大量知识点。同时还有Java进阶学习的知识笔记脑图（内含大量学习笔记）！

资料整理不易，读者朋友可以转发分享下！

Java核心知识体系笔记.pdf

[外链图片转存中…(img-c5XVAlxN-1714453662911)]

中高级Java开发面试高频考点题笔记300道.pdf

[外链图片转存中…(img-dKRO4Xb5-1714453662912)]

架构进阶面试专题及架构学习笔记脑图

[外链图片转存中…(img-oDqoKv6K-1714453662912)]

Java架构进阶学习视频分享

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录