談談你對網關過濾器的理解？

作者：磊哥 2024-12-06 14:34:00

在 Spring Cloud Gateway 中，過濾器是在請求到達目標服務之前或之后，執行某些特定操作的一種機制。例如，它可以實現對傳入的請求進行驗證、修改、日志記錄、身份驗證、流量控制等各種功能。

在 Spring Cloud Gateway 中，過濾器總共分為以下兩大類：

局部過濾器：只作用于某一個路由（route）。
全局過濾器：對所有的路由都有效。

內置全局過濾器：Spring Cloud Gateway 自帶的 30+ 過濾器，詳情請訪問：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories
自定義全局過濾器：開發者自行實現的過濾器。

1.局部過濾器

Spring Cloud Gateway 中的局部過濾器配置如下：

spring:
  cloud:
    gateway:
      routes:
        - id: userservice
          uri: http://192.168.1.7:56628
          predicates:
            - Path=/user/**
          filters:
            - AddResponseHeader=gateway-flag, javacn.site

以上過濾器的含義是在輸出對象 Response 中添加 Header 信息，key 為“gateway-flag”，value 為“javacn.site”。

PS：AddResponseHeader 也是 Gateway 內置過濾器之一。

2.全局過濾器

全局過濾器會對當前網關中的所有路由都生效。

（1）內置全局過濾器

Spring Cloud Gateway 中的內置全局過濾器配置如下：

spring:
  cloud:
    gateway:
      routes:
        - id: userservice
          uri: http://192.168.1.7:51627
          predicates:
          - Weight=group1,50
        - id: userservice2
          uri: http://192.168.1.7:56628
          predicates:
            - Weight=group1,50
          filters:
            - AddResponseHeader=gateway-flag, javacn.site
      default-filters:
        - AddResponseHeader=gateway-default-filters, www.javacn.site

其中的“default-filters”就是全局內置過濾器，它對所有的路由（route）有效，它的含義是在輸出對象 Response 中添加 Header 信息，key 為“gateway-default-filters”，value 為“www.javacn.site”。

（2）自定義全局過濾器

Spring Cloud Gateway 中自定義全局過濾器的實現是，定義一個類，使用 @Component 注解將其存入 IoC 容器，然后再實現 GlobalFilter 接口，重寫 filter 方法，在 filter 中寫自己的過濾方法即可，具體實現如下：

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component
public class AuthFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 得到 request、response 對象
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        // 業務邏輯代碼
        if(request.getQueryParams().getFirst("auth")==null){
            // 權限有問題返回，并結束執行
            response.setStatusCode(HttpStatus.FORBIDDEN);
            return response.setComplete();
        }
        // 此步驟正常，執行下一步
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        // 此值越小越早執行
        return 1;
    }
}

以上代碼是驗證請求參數中是否有“auth”參數，如果沒有的話就認為未登錄，調用“response.setComplete()”終止繼續執行，反之則認為已經登錄，可以執行后續流程了，使用“chain.filter(exchange)”來實現。

責任編輯：姜華來源：磊哥和Java

Spring 過濾器