spring cloud gateway source code parsing

Keywords: Spring WebFlux Apache

1.gateway versus zuul

1.zuul is based on servlet 2.5 and compatible with servlet 3.0. It uses blocking API and does not support long connections such as websocket.

2.Gateway is based on spring 5, Reactor and spring boot 2. It uses non-blocking API, supports websocket, integrates perfectly with spring, and is friendly to developers.

3.zuul2 supports non-blocking API s, but is not integrated with spring cloud and has stopped maintenance, not considered.

2. architecture diagram

3. Automatic Configuration

Look at spring.factories under the spring-cloud-gateway-core package

# Auto Configure

3.1 Gateway ClassPath Warning AutoConfiguration Check Front-end Controller

package org.springframework.cloud.gateway.config;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass;
import org.springframework.context.annotation.Configuration;

public class GatewayClassPathWarningAutoConfiguration {

	private static final Log log = LogFactory

	private static final String BORDER = "\n\n**********************************************************\n\n";

	@ConditionalOnClass(name = "org.springframework.web.servlet.DispatcherServlet")
	protected static class SpringMvcFoundOnClasspathConfiguration {

		public SpringMvcFoundOnClasspathConfiguration() {
					+ "Spring MVC found on classpath, which is incompatible with Spring Cloud Gateway at this time. "
					+ "Please remove spring-boot-starter-web dependency." + BORDER);


	protected static class WebfluxMissingFromClasspathConfiguration {

		public WebfluxMissingFromClasspathConfiguration() {
			log.warn(BORDER + "Spring Webflux is missing from the classpath, "
					+ "which is required for Spring Cloud Gateway at this time. "
					+ "Please add spring-boot-starter-webflux dependency." + BORDER);




1. If there is a front-end controller of spring mvc, org. spring framework. web. servlet. Dispatcher Servlet, the alarm will occur because of the use of non-blocking API s.

2. If there is no spring webflux front-end controller, org. springframework. web. reactive. Dispatcher Handler, then the alarm will occur because of the need to use non-blocking API s.

3.2 Gateway Automatic Configuration


3.2.1 RoutePredicateHandlerMapping

	public RoutePredicateHandlerMapping routePredicateHandlerMapping(
			FilteringWebHandler webHandler, RouteLocator routeLocator,
			GlobalCorsProperties globalCorsProperties, Environment environment) {
		return new RoutePredicateHandlerMapping(webHandler, routeLocator,
				globalCorsProperties, environment);

RoutePredicate Handler Mapping inherits from AbstractHandler Mapping, where path lookup is performed

	protected Mono<?> getHandlerInternal(ServerWebExchange exchange) {
		// don't handle requests on management port if set and different than server port
		if (this.managementPortType == DIFFERENT && this.managementPort != null
				&& exchange.getRequest().getURI().getPort() == this.managementPort) {
			return Mono.empty();
		exchange.getAttributes().put(GATEWAY_HANDLER_MAPPER_ATTR, getSimpleName());

		return lookupRoute(exchange)
				// .log("route-predicate-handler-mapping", Level.FINER) //name this
				.flatMap((Function<Route, Mono<?>>) r -> {
					if (logger.isDebugEnabled()) {
								"Mapping [" + getExchangeDesc(exchange) + "] to " + r);

					exchange.getAttributes().put(GATEWAY_ROUTE_ATTR, r);
					return Mono.just(webHandler);
				}).switchIfEmpty(Mono.empty().then(Mono.fromRunnable(() -> {
					if (logger.isTraceEnabled()) {
						logger.trace("No RouteDefinition found for ["
								+ getExchangeDesc(exchange) + "]");
	protected Mono<Route> lookupRoute(ServerWebExchange exchange) {
		return this.routeLocator.getRoutes()
				// individually filter routes so that filterWhen error delaying is not a
				// problem
				.concatMap(route -> Mono.just(route).filterWhen(r -> {
					// add the current route we are testing
					exchange.getAttributes().put(GATEWAY_PREDICATE_ROUTE_ATTR, r.getId());
					return r.getPredicate().apply(exchange);
						// instead of immediately stopping main flux due to error, log and
						// swallow it
						.doOnError(e -> logger.error(
								"Error applying predicate for route: " + route.getId(),
						.onErrorResume(e -> Mono.empty()))
				// .defaultIfEmpty() put a static Route not found
				// or .switchIfEmpty()
				// .switchIfEmpty(Mono.<Route>empty().log("noroute"))
				// TODO: error handling
				.map(route -> {
					if (logger.isDebugEnabled()) {
						logger.debug("Route matched: " + route.getId());
					validateRoute(route, exchange);
					return route;

		 * TODO: trace logging if (logger.isTraceEnabled()) {
		 * logger.trace("RouteDefinition did not match: " + routeDefinition.getId()); }

1. Return Route through RouteLocator

Definition of Route

You can see that url and gatewayFilter are bound

2. Put Route into the properties of Server WebExchange.

3.2.2 FilteringWebHandler

	public FilteringWebHandler filteringWebHandler(List<GlobalFilter> globalFilters) {
		return new FilteringWebHandler(globalFilters);



Posted by noobyphpchick on Sat, 05 Oct 2019 10:21:41 -0700