SpringCloud Finchley Gateway緩存請求Body和Form表單的示例分析

這篇文章將為大家詳細講解有關SpringCloud Finchley Gateway緩存請求Body和Form表單的示例分析，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。

在接入Spring-Cloud-Gateway時，可能有需求進行緩存Json-Body數據或者Form-Urlencoded數據的情況。

由于Spring-Cloud-Gateway是以WebFlux為基礎的響應式架構設計，所以在原有Zuul基礎上遷移過來的過程中，傳統的編程思路，并不適合于Reactor Stream的開發。

網絡上有許多緩存案例，但是在測試過程中出現各種Bug問題，在緩存Body時，需要考慮整體的響應式操作，才能更合理的緩存數據

下面提供緩存Json-Body數據或者Form-Urlencoded數據的具體實現方案，該方案經測試，滿足各方面需求，以及避免了網絡上其他緩存方案所出現的問題

定義一個GatewayContext類，用于存儲請求中緩存的數據

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;

@Getter
@Setter
@ToString
public class GatewayContext {

  public static final String CACHE_GATEWAY_CONTEXT = "cacheGatewayContext";

  /**
   * cache json body
   */
  private String cacheBody;
  /**
   * cache formdata
   */
  private MultiValueMap<String, String> formData;
  /**
   * cache reqeust path
   */
  private String path;
}

實現GlobalFilter和Ordered接口用于緩存請求數據

1 . 該示例只支持緩存下面3種MediaType

• APPLICATION_JSON--Json數據

• APPLICATION_JSON_UTF8--Json數據

• APPLICATION_FORM_URLENCODED--FormData表單數據

2 . 經驗總結:

• 在緩存Body時,不能夠在Filter內部直接進行緩存，需要按照響應式的處理方式，在異步操作路途上進行緩存Body，由于Body只能讀取一次，所以要讀取完成后要重新封裝新的request和exchange才能保證請求正常傳遞到下游

• 在緩存FormData時，FormData也只能讀取一次，所以在讀取完畢后，需要重新封裝request和exchange,這里要注意，如果對FormData內容進行了修改，則必須重新定義Header中的content-length已保證傳輸數據的大小一致

import com.choice.cloud.architect.usergate.option.FilterOrderEnum;
import com.choice.cloud.architect.usergate.support.GatewayContext;
import io.netty.buffer.ByteBufAllocator;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.ByteArrayResource;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.core.io.buffer.DataBufferUtils;
import org.springframework.core.io.buffer.NettyDataBufferFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.codec.HttpMessageReader;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpRequestDecorator;
import org.springframework.util.MultiValueMap;
import org.springframework.web.reactive.function.server.HandlerStrategies;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;

@Slf4j
public class GatewayContextFilter implements GlobalFilter, Ordered {

  /**
   * default HttpMessageReader
   */
  private static final List<HttpMessageReader<?>> messageReaders = HandlerStrategies.withDefaults().messageReaders();

  @Override
  public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    /**
     * save request path and serviceId into gateway context
     */
    ServerHttpRequest request = exchange.getRequest();
    String path = request.getPath().pathWithinApplication().value();
    GatewayContext gatewayContext = new GatewayContext();
    gatewayContext.getAllRequestData().addAll(request.getQueryParams());
    gatewayContext.setPath(path);
    /**
     * save gateway context into exchange
     */
    exchange.getAttributes().put(GatewayContext.CACHE_GATEWAY_CONTEXT,gatewayContext);
    HttpHeaders headers = request.getHeaders();
    MediaType contentType = headers.getContentType();
    long contentLength = headers.getContentLength();
    if(contentLength>0){
      if(MediaType.APPLICATION_JSON.equals(contentType) || MediaType.APPLICATION_JSON_UTF8.equals(contentType)){
        return readBody(exchange, chain,gatewayContext);
      }
      if(MediaType.APPLICATION_FORM_URLENCODED.equals(contentType)){
        return readFormData(exchange, chain,gatewayContext);
      }
    }
    log.debug("[GatewayContext]ContentType:{},Gateway context is set with {}",contentType, gatewayContext);
    return chain.filter(exchange);

  }


  @Override
  public int getOrder() {
    return Integer.MIN_VALUE;
  }

  /**
   * ReadFormData
   * @param exchange
   * @param chain
   * @return
   */
  private Mono<Void> readFormData(ServerWebExchange exchange,GatewayFilterChain chain,GatewayContext gatewayContext){
    HttpHeaders headers = exchange.getRequest().getHeaders();
    return exchange.getFormData()
        .doOnNext(multiValueMap -> {
          gatewayContext.setFormData(multiValueMap);
          log.debug("[GatewayContext]Read FormData:{}",multiValueMap);
        })
        .then(Mono.defer(() -> {
          Charset charset = headers.getContentType().getCharset();
          charset = charset == null? StandardCharsets.UTF_8:charset;
          String charsetName = charset.name();
          MultiValueMap<String, String> formData = gatewayContext.getFormData();
          /**
           * formData is empty just return
           */
          if(null == formData || formData.isEmpty()){
            return chain.filter(exchange);
          }
          StringBuilder formDataBodyBuilder = new StringBuilder();
          String entryKey;
          List<String> entryValue;
          try {
            /**
             * remove system param ,repackage form data
             */
            for (Map.Entry<String, List<String>> entry : formData.entrySet()) {
              entryKey = entry.getKey();
              entryValue = entry.getValue();
              if (entryValue.size() > 1) {
                for(String value : entryValue){
                  formDataBodyBuilder.append(entryKey).append("=").append(URLEncoder.encode(value, charsetName)).append("&");
                }
              } else {
                formDataBodyBuilder.append(entryKey).append("=").append(URLEncoder.encode(entryValue.get(0), charsetName)).append("&");
              }
            }
          }catch (UnsupportedEncodingException e){
            //ignore URLEncode Exception
          }
          /**
           * substring with the last char '&'
           */
          String formDataBodyString = "";
          if(formDataBodyBuilder.length()>0){
            formDataBodyString = formDataBodyBuilder.substring(0, formDataBodyBuilder.length() - 1);
          }
          /**
           * get data bytes
           */
          byte[] bodyBytes = formDataBodyString.getBytes(charset);
          int contentLength = bodyBytes.length;
          ServerHttpRequestDecorator decorator = new ServerHttpRequestDecorator(
              exchange.getRequest()) {
            /**
             * change content-length
             * @return
             */
            @Override
            public HttpHeaders getHeaders() {
              HttpHeaders httpHeaders = new HttpHeaders();
              httpHeaders.putAll(super.getHeaders());
              if (contentLength > 0) {
                httpHeaders.setContentLength(contentLength);
              } else {
                httpHeaders.set(HttpHeaders.TRANSFER_ENCODING, "chunked");
              }
              return httpHeaders;
            }

            /**
             * read bytes to Flux<Databuffer>
             * @return
             */
            @Override
            public Flux<DataBuffer> getBody() {
              return DataBufferUtils.read(new ByteArrayResource(bodyBytes),new NettyDataBufferFactory(ByteBufAllocator.DEFAULT),contentLength);
            }
          };
          ServerWebExchange mutateExchange = exchange.mutate().request(decorator).build();
          log.debug("[GatewayContext]Rewrite Form Data :{}",formDataBodyString);
          return chain.filter(mutateExchange);
        }));
  }

  /**
   * ReadJsonBody
   * @param exchange
   * @param chain
   * @return
   */
  private Mono<Void> readBody(ServerWebExchange exchange,GatewayFilterChain chain,GatewayContext gatewayContext){
    /**
     * join the body
     */
    return DataBufferUtils.join(exchange.getRequest().getBody())
        .flatMap(dataBuffer -> {
          /**
           * read the body Flux<Databuffer>
           */
          DataBufferUtils.retain(dataBuffer);
          Flux<DataBuffer> cachedFlux = Flux.defer(() -> Flux.just(dataBuffer.slice(0, dataBuffer.readableByteCount())));
          /**
           * repackage ServerHttpRequest
           */
          ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) {
            @Override
            public Flux<DataBuffer> getBody() {
              return cachedFlux;
            }
          };
          /**
           * mutate exchage with new ServerHttpRequest
           */
          ServerWebExchange mutatedExchange = exchange.mutate().request(mutatedRequest).build();
          /**
           * read body string with default messageReaders
           */
          return ServerRequest.create(mutatedExchange, messageReaders)
              .bodyToMono(String.class)
              .doOnNext(objectValue -> {
                gatewayContext.setCacheBody(objectValue);
                log.debug("[GatewayContext]Read JsonBody:{}",objectValue);
              }).then(chain.filter(mutatedExchange));
        });
  }

}

在后續Filter中，可以直接從ServerExchange中獲取GatewayContext，就可以獲取到緩存的數據，如果需要緩存其他數據，則可以根據自己的需求，添加到GatewayContext中即可

GatewayContext gatewayContext = exchange.getAttribute(GatewayContext.CACHE_GATEWAY_CONTEXT);

關于“SpringCloud Finchley Gateway緩存請求Body和Form表單的示例分析”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，使各位可以學到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。