如何在 Spring Cloud Gateway 中添加特定于路由的自定义过滤器

Posted 2023-03-28

【中文标题】如何在 Spring Cloud Gateway 中添加特定于路由的自定义过滤器

【英文标题】：How to add a custom filter specific to a route in Spring Cloud Gateway

【发布时间】：2020-02-29 09:28:26

【问题描述】：

所以我是 Spring Cloud Gateway 的新手，刚刚开始使用它。我在浏览文档时偶然发现了如何创建自定义过滤器。

https://cloud.spring.io/spring-cloud-gateway/reference/html/#developer-guide

这是我创建自定义过滤器的代码 -

       @Component
      public class CustomPreFilterFactory extends AbstractGatewayFilterFactory<CustomPreFilterFactory.Config> 


      public static class Config 
        //Put the configuration properties for your filter here
      

     @Override
     public GatewayFilter apply(Config config) 

       return (exchange,chain) ->
        ServerHttpRequest.Builder builder = exchange.getRequest().mutate();
        System.out.println("Request came in custom pre filter");
        return chain.filter(exchange.mutate().request(builder.build()).build());
      ;
    
  

现在，我正在使用网关提供的 java route api 来配置我的路由，所以这是我的路由代码 -

        @Bean
      public RouteLocator myRoutes(RouteLocatorBuilder routeLocatorBuilder) 

      return routeLocatorBuilder.routes()
         .route( p -> p.path("/hello").uri("http://localhost:8081"))
        .build();

现在，我想知道如何以编程方式将我刚刚创建的自定义过滤器工厂添加到上面定义的路由中。

我查看了以下注册自定义过滤器工厂的示例 -

  1. https://www.javainuse.com/spring/cloud-filter
  2. https://medium.com/@niral22/spring-cloud-gateway-tutorial-5311ddd59816

他们都使用属性而不是使用路由 api 创建路由。

非常感谢任何帮助。

【参考方案1】：

这个解决方案对我有用，我像这样使用注入的 CustomGatewayFilterFactory 创建了一个 OrderedGatewayFilter，并将该过滤器添加到路由中：

@Bean
public RouteLocator myRoutes(RouteLocatorBuilder routeLocatorBuilder, CustomGatewayFilterFactory customGatewayFilterFactory) 

    OrderedGatewayFilter orderedGatewayFilter =
      new OrderedGatewayFilter(customGatewayFilterFactory.apply(config), 45);
    return routeLocatorBuilder.routes()
         .route( p -> p.path("/hello").uri("http://localhost:8081").filter(orderedGatewayFilter))
        .build();

【参考方案2】：

您需要注入自定义过滤器并将其包含在路由中。像这样的..

        @Bean
      public RouteLocator myRoutes(RouteLocatorBuilder routeLocatorBuilder, CustomPreFilterFactory cpf) 

      return routeLocatorBuilder.routes()
         .route( p -> p.path("/hello").filters(f -> f.filter(myCustomFilter.apply(new Config()))).uri("http://localhost:8081"))
        .build();

【参考方案3】：

下面是一个路由示例，它定义了一个谓词来匹配所有请求 URL 与 /api/v1/first/** 并应用预过滤器来重写路径。应用了另一个过滤器来修改请求标头，然后将请求路由到负载均衡的 FIRST-SERVICE。

builder.routes()
            .route(r -> r.path("/api/v1/first/**")
                    .filters(f -> f.rewritePath("/api/v1/first/(?.*)", "/$remains")
                                    .addRequestHeader("X-first-Header", "first-service-header")
                    )
                    .uri("lb://FIRST-SERVICE/") //downstream endpoint  lb - load balanced
                    .id("queue-service"))

            .build();

下面是等效的 .yaml 配置。

spring:
  cloud:
    gateway:
      routes:
      - id: first-service
        uri: lb://FIRST-SERVICE
        predicates:
        - Path=/api/v1/first/**
        filters:
        - RewritePath=/api/v1/first/(?.*), /$\remains
        - AddRequestHeader=X-first-Header, first-service-header

你可以在link.找到更多这样的过滤器

希望这就是你要找的。​​p>

【讨论】：

提问者询问如何添加他的自定义过滤器“CustomPreFilterFactory”。 Spring Cloud 提供的过滤器不存在。