Spring Cloud Gateway使用说明（3）-- Global filter

╰半夏微凉° 2023-03-02 13:22 26阅读 0赞

GlobalFilter接口与GatewayFilter具有相同的签名。是有条件地应用于所有路由的特殊过滤器。（此接口和用法可能在将来的里程碑版本中发生更改）。

# 7.1 filter顺序 #

当请求进入（并与路由匹配）时，筛选Web Handler 会将GlobalFilter的所有实例和所有的GatewayFilter路由特定实例添加到 filter chain。filter组合的排序由org.springframework.core.Ordered接口决定，可以通过实现getOrde()方法或使用@Order注释来设置。

由于Spring Cloud Gateway将用于执行过滤器逻辑区分为“前置”和“后置”阶段，具有最高优先级的过滤器将是“前置”阶段的第一个，而“后置”阶段的最后一个。  
**Example 57. ExampleConfiguration.java**

@Bean
    public GlobalFilter customFilter() { 
        return new CustomGlobalFilter();
    }
    
    public class CustomGlobalFilter implements GlobalFilter, Ordered { 
    
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 
            log.info("custom global filter");
            return chain.filter(exchange);
        }
    
        @Override
        public int getOrder() { 
            return -1;
        }
    }

# 7.2. Forward 路由 Filter #

ForwardRoutingFilter在exchange属性ServerWebExchangeUtils.GATEWAY\_REQUEST\_URL\_ATTR中查找URI。如果URL有一个forwardscheme (如 forward:///localendpoint)，它将使用Spring DispatcherHandler 来处理请求。请求URL的路径部分将被转发URL中的路径覆盖。未修改的原始URL将附加到 ServerWebExchangeUtils.GATEWAY\_ORIGINAL\_REQUEST\_URL\_ATTR属性中的列表中。

# 7.3. 负载均衡Filter #

LoadBalancerClientFilter在exchange属性ServerWebExchangeUtils.GATEWAY\_REQUEST\_URL\_ATTR中查找URI。如果URL有一个lbscheme (如 lb://myservice），它将使用Spring Cloud LoadBalancerClient 将名称（在前一个示例中为’myservice）解析为实际主机和端口，并替换URI。未修改的原始URL将附加到ServerWebExchangeUtils.GATEWAY\_ORIGINAL\_REQUEST\_URL\_ATTR属性中的列表中。过滤器还将查看ServerWebExchangeUtils.GATEWAY\_SCHEME\_PREFIX\_ATTR属性，查看它是否等于lb\`，然后应用相同的规则。

**Example 58. application.yml**

spring:
      cloud:
        gateway:
          routes:
          - id: myRoute
            uri: lb://service
            predicates:
            - Path=/service/**

> 提醒  
> 默认情况下，如果一个服务实例在LoadBalancer  
> 中没有发现，则返回503。可以通过设置 spring.cloud.gateway.loadbalancer.use404=true 来让网关返回404.

> 提醒  
> 从LoadBalancer返回的ServiceInstance的isSecure  
> 值将覆盖在对网关发出的请求中指定的scheme。例如，如果请求通过HTTPS进入网关，但ServiceInstance表示它不安全，则下游请求将通过HTTP协议。相反的情况也适用。但是，如果在网关配置中为路由指定了GATEWAY\_SCHEME\_PREFIX\_ATTR，则前缀将被删除，并且路由URL生成的scheme将覆盖ServiceInstance配置。

> 注意  
> LoadBalancerClientFilter 默认使用同步的ribbon LoadBalancerClient 。我们建议你使用ReactiveLoadBalancerClientFilter代替。可将spring.cloud.loadbalancer.ribbon.enabled设置为false切换过去。

# 7.4 响应式负载均衡Filter #

LoadBalancerClientFilter在exchange属性ServerWebExchangeUtils.GATEWAY\_REQUEST\_URL\_ATTR中查找URI。如果URL有一个lbscheme (如 lb://myservice），它将使用Spring Cloud ReactorLoadBalancer 将名称（在前一个示例中为’myservice）解析为实际主机和端口，并替换URI。未修改的原始URL将附加到ServerWebExchangeUtils.GATEWAY\_ORIGINAL\_REQUEST\_URL\_ATTR属性中的列表中。过滤器还将查看ServerWebExchangeUtils.GATEWAY\_SCHEME\_PREFIX\_ATTR属性，查看它是否等于lb，然后应用相同的规则。  
**Example 59. application.yml**

spring:
      cloud:
        gateway:
          routes:
          - id: myRoute
            uri: lb://service
            predicates:
            - Path=/service/**

> 提醒  
> 默认情况下，如果一个服务实例在ReactorLoadBalancer  
> 中没有发现，则返回503。可以通过设置 spring.cloud.gateway.loadbalancer.use404=true 来让网关返回404.

# 7.5. Netty 路由Filter #

如果位于 ServerWebExchangeUtils.GATEWAY\_REQUEST\_URL\_ATTR属性中的URL具有http 或https 模式，则会运行Netty Routing Filter。它使用Netty HttpClient 发出下游代理请求。响应放在 ServerWebExchangeUtils.CLIENT\_RESPONSE\_ATTR exchange属性中，以便在以后的过滤器中使用。（有一个实验阶段不需要Netty的相同的功能的Filter，WebClientHttpRoutingFilter）

# 7.6. Netty 响应Filter #

如果ServerWebExchangeUtils.CLIENT\_RESPONSE\_ATTR exchange属性中存在 Netty HttpClientResponse，则运行 NettyWriteResponseFilter 。它在其他所有过滤器完成后将代理响应写回网关客户端响应之后运行。（有一个不需要netty的实验性的WebClientWriteResponseFilter执行相同的功能）

# 7.7. 地址路由 Filter #

如果ServerWebExchangeUtils.GATEWAY\_ROUTE\_ATTR exchange属性中存在Route对象，RouteToRequestUrlFilter将运行。它基于请求URI创建一个新的URI，使用Route对象的uri属性进行更新。新的URI被放置在ServerWebExchangeUtils.GATEWAY\_REQUEST\_URL\_ATTR exchange属性中。

如果该URI有一个前缀scheme，例如lb:ws://serviceid，则会从该URI中剥离该 lb scheme，并将其放置在ServerWebExchangeUtils.GATEWAY\_SCHEME\_PREFIX\_ATTR中，以便稍后在过滤器链中使用。

# 7.8. Websocket 路由 Filter #

如果ServerWebExchangeUtils.GATEWAY\_REQUEST\_URL\_ATTRexchange属性中有 ws 、 wssscheme，则Websocket Routing Filter将被运行。它使用Spring Web Socket基础模块将Websocket转发到下游。

URI前缀为lb的Websockets可以被负载均衡，如 lb:ws://serviceid.

> 注意  
> 如果使用 SockJS 作为普通HTTP的fallback，则应配置普通HTTP路由以及WebSocket路由。

下面配置一个websocket路由filter：

**Example 60. application.yml**

spring:
      cloud:
        gateway:
          routes:
          # SockJS route
          - id: websocket_sockjs_route
            uri: http://localhost:3001
            predicates:
            - Path=/websocket/info/**
          # Normal Websocket route
          - id: websocket_route
            uri: ws://localhost:3001
            predicates:
            - Path=/websocket/**

# 7.9. 网关数据filter #

要启用网关指标，请将spring-boot-starter-actuator添加为项目依赖项。然后，默认情况下，只要属性spring.cloud.gateway.metrics.enabled未设置为false，网关指标过滤器就会运行。此过滤器添加名为“gateway.requests”的计时器指标，并带有以下标记：

*  routeId: The route id
 *  routeUri: API 将被转发的URI
 *  outcome: 结果分类依据 HttpStatus.Series
 *  status: 返回client的请求的Http Status

这些指标可以从/actuator/metrics/gateway.requests中获取，可以很容易地与Prometheus集成以创建Grafana dashboard.

> 注意  
> 要将pometheus启用，需要添加 micrometer-registry-prometheus为项目依赖。

# 7.10. 标记请求为已路由 #

网关路由ServerWebExchange之后，它将通过向Exchange属性添加gatewayAlreadyRouted，将该exchange标记为“routed”。一旦一个请求被标记为routed，其他路由过滤器将不会再次路由该请求，将跳过该过滤器。有一些方便的方法可以用来将exchange标记为routed，或者检查exchange是否已经routed。

*  ServerWebExchangeUtils.isAlreadyRouted 有一个 ServerWebExchange对象并检查它是否已"routed"
 *  ServerWebExchangeUtils.setAlreadyRouted 有一个 ServerWebExchange 对象并将其标记为"routed"

[Spring Cloud Gateway 2.2.3 官方使用说明（1）–路由][Spring Cloud Gateway 2.2.3 _1]  
[Spring Cloud Gateway 2.2.3 官方使用说明（2）-- 路由filter（上）][Spring Cloud Gateway 2.2.3 _2_-- _filter]  
[Spring Cloud Gateway 2.2.3 官方使用说明（2）-- 路由filter（下）][Spring Cloud Gateway 2.2.3 _2_-- _filter 1]

> [Spring Cloud Gateway 2.2.3 官方使用说明（3）-- Global filter][Spring Cloud Gateway 2.2.3 _3_-- Global filter]

[Spring Cloud Gateway 2.2.3 官方使用说明（4）-- HttpHeader Filters][Spring Cloud Gateway 2.2.3 _4_-- HttpHeader Filters]  
[Spring Cloud Gateway 2.2.3 使用说明（5）-- TLS 和 SSL][Spring Cloud Gateway 2.2.3 _5_-- TLS _ SSL]  
[Spring Cloud Gateway 2.2.3 使用说明（6）-- 其它配置][Spring Cloud Gateway 2.2.3 _6_--]  
[Spring Cloud Gateway 2.2.3 使用说明（7）-- actuator][Spring Cloud Gateway 2.2.3 _7_-- actuator]  
[Spring Cloud Gateway 2.2.3 使用说明（8）-- 开发指导][Spring Cloud Gateway 2.2.3 _8_--]

[Spring Cloud Gateway 2.2.3 _1]: https://blog.csdn.net/xgw1010/article/details/107343712
[Spring Cloud Gateway 2.2.3 _2_-- _filter]: https://blog.csdn.net/xgw1010/article/details/107582426
[Spring Cloud Gateway 2.2.3 _2_-- _filter 1]: https://blog.csdn.net/xgw1010/article/details/107642291
[Spring Cloud Gateway 2.2.3 _3_-- Global filter]: https://blog.csdn.net/xgw1010/article/details/107670715
[Spring Cloud Gateway 2.2.3 _4_-- HttpHeader Filters]: https://blog.csdn.net/xgw1010/article/details/107768108
[Spring Cloud Gateway 2.2.3 _5_-- TLS _ SSL]: https://blog.csdn.net/xgw1010/article/details/107851355
[Spring Cloud Gateway 2.2.3 _6_--]: https://blog.csdn.net/xgw1010/article/details/108034791
[Spring Cloud Gateway 2.2.3 _7_-- actuator]: https://blog.csdn.net/xgw1010/article/details/108036731
[Spring Cloud Gateway 2.2.3 _8_--]: https://blog.csdn.net/xgw1010/article/details/108038009