（42）java Spring Cloud+Spring boot+mybatis企業快速開發架構之SpringCloud-Gateway過濾器工廠的使用

GatewayFilter Factory 是 Spring Cloud Gateway 中提供的過濾器工廠，Spring Cloud Gateway 的路由過濾器允許以某種方式修改傳入的 HTTP 請求或輸出的 HTTP 回應，只作用于特定的路由，需要框架原始碼的朋友可以看我個人簡介聯系我， 推薦鴻鵠分布式云架構原始碼

Spring Cloud Gateway 中內置了很多過濾器工廠，直接采用配置的方式使用即可，同時也支持自定義 GatewayFilter Factory 來實作更復雜的業務需求，

spring:
  cloud:
    gateway:
      routes:
        - id: add_request_header_route
  uri: http://c.biancheng.net
  filters:
    - AddRequestHeader=X-Request-Foo, Bar

接下來為大家介紹幾個常用的過濾器工廠類，

AddRequestHeader 過濾器工廠
通過名稱我們可以快速明白這個過濾器工廠的作用是添加請求頭，
符合規則匹配成功的請求，將添加 X-Request-Foo：bar 請求頭，將其傳遞到后端服務中，后方服務可以直接獲取請求頭資訊，代碼如下所示，

@GetMapping("/hello")
public String hello(HttpServletRequest request) throws Exception {
    System.err.println(request.getHeader("X-Request-Foo"));
    return "success";
}

RemoveRequestHeader 過濾器工廠
RemoveRequestHeader 是移除請求頭的過濾器工廠，可以在請求轉發到后端服務之前進行 Header 的移除操作，

spring:
  cloud:
    gateway:
      routes:
  - id: removerequestheader_route
  uri: http://c.biancheng.net
    - RemoveRequestHeader=X-Request-Foo

SetStatus 過濾器工廠
SetStatus 過濾器工廠接收單個狀態，用于設定 Http 請求的回應碼，它必須是有效的 Spring Httpstatus（org.springframework.http.HttpStatus），它可以是整數值 404 或列舉型別

NOT_FOUND，
spring:
  cloud:
    gateway:
      routes:
        - id: setstatusint_route
  uri: http://c.biancheng.net
  filters:
    - SetStatus=401

RedirectTo過濾器工廠
RedirectTo 過濾器工廠用于重定向操作，比如我們需要重定向到百度，

spring:
  cloud:
    gateway:
      routes:
        - id: prefixpath_route
  uri: http://c.biancheng.net
  filters:
    - RedirectTo=302, http://baidu.com

以上為大家介紹了幾個過濾器工廠的使用，教程后面還會為大家介紹 Retry 重試、RequestRateLimiter 限流、Hystrix 熔斷過濾器工廠等內容，其他的大家可以自行參考官方檔案進行學習，

自定義Spring Cloud Gateway過濾器工廠
自定義 Spring Cloud Gateway 過濾器工廠需要繼承 AbstractGatewayFilterFactory 類，重寫 apply 方法的邏輯，命名需要以 GatewayFilterFactory 結尾，比如 CheckAuthGatewayFilterFactory，那么在使用的時候 CheckAuth 就是這個過濾器工廠的名稱，

自定義過濾器工廠代碼如下所示，

@Component
public class CheckAuth2GatewayFilterFactory
        extends AbstractGatewayFilterFactory<CheckAuth2GatewayFilterFactory.Config> {

    public CheckAuth2GatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
    return (exchange, chain) -> {
      System.err.println("進入了CheckAuth2GatewayFilterFactory" + config.getName());
      ServerHttpRequest request = exchange.getRequest().mutate()
      .build();
      return
      chain.filter(exchange.mutate().request(request).build());
    }
  }

    public static class Config {
        private String name;

        public void setName(String name) {
            this.name = name;
        }

        public String getName() {
            return name;
        }
    }
}

使用如下：

filters:
  - name: CheckAuth2
  args:
    name: 張三

如果你的配置是 Key、Value 這種形式的，那么可以不用自己定義配置類，直接繼承 AbstractNameValueGatewayFilterFactory 類即可，

AbstractNameValueGatewayFilterFactory 類繼承了 AbstractGatewayFilterFactory，定義了一個 NameValueConfig 配置類，NameValueConfig 中有 name 和 value 兩個欄位，

我們可以直接使用，AddRequestHeaderGatewayFilterFactory、AddRequestParameterGatewayFilterFactory 等都是直接繼承的 AbstractNameValueGatewayFilterFactory，

繼承 AbstractNameValueGatewayFilterFactory 方式定義過濾器工廠，代碼如下所示，

@Component
public class CheckAuthGatewayFilterFactory extends AbstractNameValueGatewayFilter-actory {
    @Override
    public GatewayFilter apply(NameValueConfig config) {
        return (exchange, chain) -> {
            System.err.println("進入了CheckAuthGatewayFilterFactory" + config.getName() + "\t" + config.getValue());
            ServerHttpRequest request = exchange.getRequest().mutate().build();
            return chain.filter(exchange.mutate().request(request).build());
        };
    }
}

使用如下：

filters：
- CheckAuth=zhangsan,男