Gateway 总览

SpringCloudGateway核心设计基于Route,每个Route含有多个Predicatefilter,当请求满足Route的所有Predicate时,请求会被当前Route接受,之后Route含有的filter会处理请求,所有的核心逻辑处理都在Filter中。

SpringCloudGateway官网架构图非常清晰描述了gateway的工作原理。

Spring Cloud Gateway Diagram

  1. 发送到Gateway的请求会先被RoutePredicateHandlerMapping,如果请求能被Route接受,则返回一个WebHandler。(所谓的接受,就是有配置的Route,请求满足Route含有的所有predicate
  2. WebHandler处理请求,本质就是合并Route含有的filter和全局Filter,对请求进行filter处理。(包括请求重定向、重写header等等功能)
  3. 之后请求会被NettyRoutingFilter处理,转发给目标后端服务。
  4. NettyWriteResponseFilter会将后端返回的数据写入ServerWebExchange response内。
  5. 最后请求返回给前端完成。

Handler Mapping

SpringCloudGateway基于webflux实现,后者有一套自己的服务端框架,为了对其进行适配,SpringCloudGateway提供了RoutePredicateHandlerMapping,用于获取处理请求的WebHandler

RoutePredicateHandlerMapping设计比较简洁,根据请求和配置的Route predicates 查找是否有匹配的Route,如果有匹配的Route则返回FilteringWebHandler,否则返回空请求失败。

HandlerMapping的获取方式如下图:

在这里插入图片描述

FilteringWebHandler在应用初始化时构建传入RoutePredicateHandlerMapping,内部不会对FilteringWebHandler有任何的处理,只要有匹配的Route,就返回FilteringWebHandler;无匹配则请求失败。

匹配成功的Route会被放入ServerWebExchangeattribute内,Route会在WebHandler里被取出。

Web Handler

FilteringWebHandler核心逻辑是构建filter chain,处理RequestWebHandlerhandle方法如下

@Override
public Mono<Void> handle(ServerWebExchange exchange) {
    // 从 ServerWebExchange 里获取 Route
		Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR);
    // 获取 Route 下定义的 Filter List
		List<GatewayFilter> gatewayFilters = route.getFilters();
		// 合并全局 Filter List
		List<GatewayFilter> combined = new ArrayList<>(this.globalFilters);
		combined.addAll(gatewayFilters);
  	// 根据 order 排序,这步挺重要的,由于 gateway 基于 filter 实现,所以 filter 的顺序至关重要
		AnnotationAwareOrderComparator.sort(combined);
		if (logger.isDebugEnabled()) {
			logger.debug("Sorted gatewayFilterFactories: " + combined);
		}
  	// filter 处理请求
		return new DefaultGatewayFilterChain(combined).filter(exchange);
}

画张图简化理解

在这里插入图片描述

  • FilteringWebHandler会构建Filter List,合并Route FiltersGlobalFilter List,并进行排序。
  • Filter List处理请求,最后请求会被转发给后端系统。

SpringCloudGateway的请求转发由NettyRoutingFilter实现,后端返回结果由NettyWriteResponseFilter写回ServerWebExchange response内,完成一次gateway转发。

Logo

为开发者提供学习成长、分享交流、生态实践、资源工具等服务,帮助开发者快速成长。

更多推荐