一、Spring Cloud Gateway内置GatewayFilter

路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。路由过滤器的范围是特定路由。Spring Cloud Gateway 包括许多内置的 GatewayFilter 工厂。

官网地址：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

二、DefaultFilter

添加DefaultFilter将其应用于所有路由，您可以使用spring.cloud.gateway.default-filters，此属性配置采用DefaultFilter列表。

spring:cloud:gateway:default-filters:- AddResponseHeader=X-Response-Default-Red, Default-Blue- StripPrefix=1

三、GlobalFilter

GlobalFilter接口与GatewayFilter接口具有相同特征。GlobalFilter是有条件地应用于所有路由的特殊过滤器。

Spring Cloud Gateway 内置的GatewayFilter：

更多介绍请见官网：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters

以下为自定义GlobalFilter实现记录请求方状态及耗时：

ApiLoggingFilter.java

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.List;@Slf4j
public class ApiLoggingFilter implements GlobalFilter, Ordered {private static final String START_TIME = "startTime";private static final String X_REAL_IP = "X-Real-IP";// nginx需要配置@Overridepublic Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {if (log.isDebugEnabled()) {String info = String.format("Method:{%s} Host:{%s} Path:{%s} Query:{%s}",exchange.getRequest().getMethod().name(), exchange.getRequest().getURI().getHost(),exchange.getRequest().getURI().getPath(), exchange.getRequest().getQueryParams());log.debug(info);}exchange.getAttributes().put(START_TIME, System.currentTimeMillis());return chain.filter(exchange).then(Mono.fromRunnable(() -> {Long startTime = exchange.getAttribute(START_TIME);if (startTime != null) {Long executeTime = (System.currentTimeMillis() - startTime);List ips = exchange.getRequest().getHeaders().get(X_REAL_IP);String ip = ips != null ? ips.get(0) : exchange.getRequest().getRemoteAddress().getAddress().getHostAddress();String api = exchange.getRequest().getURI().getRawPath();int code = 500;if (exchange.getResponse().getStatusCode() != null) {code = exchange.getResponse().getStatusCode().value();}// 当前仅记录日志，后续可以添加日志队列，来过滤请求慢的接口if (log.isDebugEnabled()) {log.debug("来自IP地址：{}的请求接口：{}，响应状态码：{}，请求耗时：{}ms", ip, api, code, executeTime);}}}));}@Overridepublic int getOrder() {return Ordered.LOWEST_PRECEDENCE;}}

配置使用ApiLoggingFilter：

GatewayConfiguration.java

@Configuration(proxyBeanMethods = false)
public class GatewayConfiguration {@Beanpublic ApiLoggingFilter apiLoggingFilter() {return new ApiLoggingFilter();}
}

四、过滤器的执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter。

请求路由后,会将 当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，按org.springframework.core.Ordered接口排序，排序后依次执行每个过滤器：

排序的规则是什么呢？

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定。
• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
• 传入的 HTTP 请求的第一个过滤器具有最高优先级。
• 传出的 HTTP 响应的最后一个过滤器具有最高优先级。

详细内容，可以查看源码：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

private List getFilters(RouteDefinition routeDefinition) {List filters = new ArrayList();if (!this.gatewayProperties.getDefaultFilters().isEmpty()) {filters.addAll(this.loadGatewayFilters(routeDefinition.getId(), new ArrayList(this.gatewayProperties.getDefaultFilters())));}if (!routeDefinition.getFilters().isEmpty()) {filters.addAll(this.loadGatewayFilters(routeDefinition.getId(), new ArrayList(routeDefinition.getFilters())));}AnnotationAwareOrderComparator.sort(filters);return filters;
}

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链。

public Mono handle(ServerWebExchange exchange) {Route route = (Route)exchange.getRequiredAttribute(ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR);List gatewayFilters = route.getFilters();List combined = new ArrayList(this.globalFilters);combined.addAll(gatewayFilters);AnnotationAwareOrderComparator.sort(combined);if (logger.isDebugEnabled()) {logger.debug("Sorted gatewayFilterFactories: " + combined);}return (new DefaultGatewayFilterChain(combined)).filter(exchange);
}