Gateway網關自定義攔截器的不可重復讀取數據問題

Posted on 2022-08-23 by WalkonNet

Gateway網關自定義攔截器的不可重復讀取數據

最近在開發gateway網關時，通過自定義攔截器對某些接口的數據進行處理，發現，無法讀取到數據。經過查詢，發現在Spring5的webflux編程或者普通web編程中，隻能從request中獲取body一次，後面無法再獲取。

參考網上的方法先通過全局過濾器把body先緩存起來。

這個網上有很多例子：

/**
 * @author zhong
 * @date 2022/1/6 - 15:34
 * 
 */
@Configuration
public class CacheBodyGlobalFilter implements Ordered, GlobalFilter {
 
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //判斷是否時認證接口
        if (!AuthUtils.isAuthorPath(exchange.getRequest())) {
            //不是認證接口
            return chain.filter(exchange);
        } else {
            //指定接口可建數據從新讀出構建
            return DataBufferUtils.join(exchange.getRequest().getBody())
                    .flatMap(dataBuffer -> {
                        DataBufferUtils.retain(dataBuffer);
                        Flux<DataBuffer> cachedFlux = Flux
                                .defer(() -> Flux.just(dataBuffer.slice(0, dataBuffer.readableByteCount())));
                        ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) {
                            @Override
                            public Flux<DataBuffer> getBody() {
                                return cachedFlux;
                            }
                        };
                        //exchange.getAttributes().put(CACHE_REQUEST_BODY_OBJECT_KEY, cachedFlux);
                        return chain.filter(exchange.mutate().request(mutatedRequest).build());
                    });
        }
    }
 
    @Override
    public int getOrder() {
        return Ordered.HIGHEST_PRECEDENCE;
    }
}

CacheBodyGlobalFilter這個全局過濾器的目的就是把原有的request請求中的body內容讀出來，並且使用ServerHttpRequestDecorator這個請求裝飾器對request進行包裝，重寫getBody方法，並把包裝後的請求放到過濾器鏈中傳遞下去。這樣後面的過濾器中再使用exchange.getRequest().getBody()來獲取body時，實際上就是調用的重載後的getBody方法，獲取的最先已經緩存瞭的body數據。這樣就能夠實現body的多次讀取瞭。

這個過濾器的order設置的是Ordered.HIGHEST_PRECEDENCE，即最高優先級的過濾器。優先級設置這麼高的原因是某些系統內置的過濾器可能也會去讀body。

但是在測試中我發現，如果我在請求接口中如果沒有body內容，就會導致程序隻能執行CacheBodyGlobalFilter這一個攔截器，而無法執行其他攔截器(自定義的和默認的)。而且接口返回200，這和我的預期時不一致的。

通過測試發現，原因是，按照以上代碼執行，如果是body為null，Conten-Type也為空，所以沒有執行代碼中的flatMap()方法.所以也就沒有執行後面的調用鏈。

chain.filter(exchange.mutate().request(mutatedRequest).build());

解決辦法，在獲取到數據流時，如果數據流為null，我們可以構建一個空的數據流，這也也就能執行我們後面的攔截器。

利用Flux.defaultIfEmpty(defaultDataBuffer);的方法可以實現這個功能。

public final Flux<T> defaultIfEmpty(T defaultV) {
   return onAssembly(new FluxDefaultIfEmpty<>(this, defaultV));
}

代碼如下：

@Configuration
public class CacheBodyGlobalFilter implements Ordered, GlobalFilter {
 
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //判斷是否時認證接口
        if (!AuthUtils.isAuthorPath(exchange.getRequest())) {
            //不是認證接口
            return chain.filter(exchange);
        } else {
            //指定接口可建數據從新讀出構建
 
            //當body中沒有緩存時，隻會執行這一個攔截器， 原因是fileMap中的代碼沒有執行，所以需要在波多野為空時構建一個空的緩存
            DefaultDataBufferFactory defaultDataBufferFactory = new DefaultDataBufferFactory();
            DefaultDataBuffer defaultDataBuffer = defaultDataBufferFactory.allocateBuffer(0);
            //構建新數據流， 當body為空時，構建空流
            Flux<DataBuffer> bodyDataBuffer = exchange.getRequest().getBody().defaultIfEmpty(defaultDataBuffer);
            return DataBufferUtils.join(bodyDataBuffer)
                    .flatMap(dataBuffer -> {
                        DataBufferUtils.retain(dataBuffer);
                        Flux<DataBuffer> cachedFlux = Flux
                                .defer(() -> Flux.just(dataBuffer.slice(0, dataBuffer.readableByteCount())));
                        ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) {
                            @Override
                            public Flux<DataBuffer> getBody() {
                                return cachedFlux;
                            }
                        };
                        //exchange.getAttributes().put(CACHE_REQUEST_BODY_OBJECT_KEY, cachedFlux);
                        return chain.filter(exchange.mutate().request(mutatedRequest).build());
                    });
        }
    }
 
    @Override
    public int getOrder() {
        return Ordered.HIGHEST_PRECEDENCE;
    }
}

當然這個是在我們的攔截的接口存在沒有body，但是也要執行後面的攔截器的情況下。如果說接口必須要有body。那我們可以在CacheBodyGlobalFilter 這攔截器中直接返回指定的內容。這個我還沒有測試過。

統一網關Gateway

一、為什麼需要網關

網關功能：

身份認證和權限校驗
服務路由、負載均衡
請求限流

二、搭建網關服務

搭建網關服務的步驟：

1、創建新的module,引入SpringCloudGateway的依賴和nacos的服務發現依賴

<!--網關依賴-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服務發現依賴-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> 
</dependency>

2、編寫路由配置及nacos地址

server:
  port: 10010 # 網關端口
spring:
  application:
    name: gateway # 服務名稱
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 網關路由配置
        - id: user-service # 路由id，自定義，隻要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目標地址 http就是固定地址
          uri: lb://userservice # 路由的目標地址 lb就是負載均衡，後面跟服務名稱
          predicates: # 路由斷言，也就是判斷請求是否符合路由規則的條件
            - Path=/user/** # 這個是按照路徑匹配，隻要以/user/開頭就符合要求

3、搭建步驟總結：

創建項目，引入nacos服務發現和gateway依賴

配置application.yml，包括服務基本信息、nacos地址、路由

路由配置包括：

路由id：路由的唯一標示
路由目標（uri）：路由的目標地址，http代表固定地址，lb代表根據服務名負載均衡
路由斷言（predicates）：判斷路由的規則，
路由過濾器（filters）：對請求或響應做處理

Gateway執行流程：

三、路由斷言工廠

上文中，在配置文件中寫的斷言規則隻是字符串，這些字符串會被Predicate Factory讀取並處理，轉變為路由判斷的條件！例如Path=/user/**是按照路徑匹配，這個規則是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory類來處理的，像這樣的斷言工廠在SpringCloudGateway還有十幾個

Spring提供瞭11種基本的Predicate工廠：

四、路由過濾器

路由過濾器 GatewayFilter

GatewayFilter是網關中提供的一種過濾器，可以對進入網關的請求和微服務返回的響應做處理：

過濾器工廠 GatewayFilterFactory

Spring提供瞭31種不同的路由過濾器工廠。例如：

過濾器工廠案例：給所有進入userservice的請求添加一個請求頭

給所有進入userservice的請求添加一個請求頭：Truth=xiaobai is headsome

spring:
 cloud:
   gateway:
     routes: # 網關路由配置
       - id: user-service
         uri: lb://userservice
         predicates:
           - Path=/user/**
         filters: # 過濾器
           - AddRequestHeader=Truth, xiaobai is headsome # 添加請求頭

默認過濾器

如果要對所有的路由都生效，則可以將過濾器工廠寫到default(默認過濾器)下。格式如下：

spring:
  application:
    name: gateway # 服務名稱
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 網關路由配置
        - id: user-service 
          uri: lb://userservice  
          predicates: 
            - Path=/user/** 
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
        default-filters: # 默認過濾器，會對所有的路由請求都生效
          - AddRequestHeader=Truth, xiaobai is headsome # 添加請求頭

全局過濾器 GlobalFilter

全局過濾器的作用也是處理一切進入網關的請求和微服務響應，與GatewayFilter的作用一樣。

區別在於GatewayFilter通過配置定義，處理邏輯是固定的。而GlobalFilter的邏輯需要自己寫代碼實現。

定義方式是實現GlobalFilter接口。

public interface GlobalFilter {
   /**
    *  處理當前請求，有必要的話通過{@link GatewayFilterChain}將請求交給下一個過濾器處理
    *
    * @param exchange 請求上下文，裡面可以獲取Request、Response等信息
    * @param chain 用來把請求委托給下一個過濾器 
    * @return {@code Mono<Void>} 返回標示當前過濾器業務結束
    */
        Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
     }

全局過濾器案例：定義全局過濾器，攔截並判斷用戶身份

需求：

定義全局過濾器，攔截請求，判斷請求的參數是否滿足下面條件：

參數中是否有authorization，authorization參數值是否為admin

如果同時滿足則放行，否則攔截

自定義類，實現GlobalFilter接口，添加@Order註解

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
         // 1.獲取請求參數
            MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.獲取authorization參數
            String auth = params.getFirst("authorization");
        // 3.校驗
            if ("admin".equals(auth)) {
        // 放行
            return chain.filter(exchange);
  }
       // 4.攔截
       // 4.1.禁止訪問                                                                                                
            exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
       // 4.2.結束處理
            return exchange.getResponse().setComplete();                       
   }
}

過濾器執行順序

請求進入網關會碰到三類過濾器：當前路由的過濾器、DefaultFilter、GlobalFilter

請求路由後，會將當前路由過濾器和DefaultFilter、GlobalFilter，合並到一個過濾器鏈（集合）中，排序後依次執行每個過濾器

每一個過濾器都必須指定一個int類型的order值，order值越小，優先級越高，執行順序越靠前。
GlobalFilter通過實現Ordered接口，或者添加@Order註解來指定order值，由我們自己指定
路由過濾器和defaultFilter的order由Spring指定，默認是按照聲明順序從1遞增。
當過濾器的order值一樣時，會按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執行。

五、跨域問題處理

跨域：域名不一致就是跨域，主要包括：

域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
域名相同，端口不同：localhost:8080和localhost8081

跨域問題：瀏覽器禁止請求的發起者與服務端發生跨域ajax請求，請求被瀏覽器攔截的問題

解決方案：CORS

網關處理跨域采用的同樣是CORS方案，並且隻需要簡單配置即可實現：

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域處理
        add-to-simple-url-handler-mapping: true # 解決options請求被攔截問題
        corsConfigurations:
          '[/**]':
	        allowedOrigins: # 允許哪些網站的跨域請求 
	          - "http://localhost:8090"
	          - "http://www.leyou.com"
	        allowedMethods: # 允許的跨域ajax的請求方式
	          - "GET"
	          - "POST"
	          - "DELETE"
	          - "PUT"
	          - "OPTIONS"
	        allowedHeaders: "*" # 允許在請求中攜帶的頭信息
	        allowCredentials: true # 是否允許攜帶cookie
	        maxAge: 360000 # 這次跨域檢測的有效期

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

Gateway網關自定義攔截器的不可重復讀取數據問題

目錄