Springboot 2.0---WebFlux請求處理流程

筆記是學習了小馬哥在慕課網的課程的《Spring Boot 2.0深度實踐之核心技術篇》的內容結合自己的需要和理解做的筆記。

前言

在瞭解了WebFlux核心組件之後，我們就該瞭解相應的請求流程了，在之前就寫過幾篇關於 SpringMvc 請求的流程筆記，如果之前有過了解的並且自己debugger 過的小夥伴，相信瞭解 WebFlux 的執行流程會很快。

我們知道WebFlux支持兩種請求模式

• 註解驅動
• 函數式端點

接下來我們會重點講一下函數式端點請求的具體流程，註解驅動由於跟SpringMVC很像，所以大家只要看一下流程圖，基本就可以瞭解了。

註解驅動組件請求處理流程

流程圖

下面我們先來看一下具體流程圖

p14.png

我們可以對比SpringMVC的請求流程圖對比來看

p16.png

我們可以看到，處理流程基本一樣，有以下主要的點不同

• 處理核心

  • WebFlux--DispatcherHandler
  • SpringMvc--DispatcherServlet

• 返回值處理器

  • WebFlux--HandlerResultHandler
  • SpringMvc--HandlerMethodReturnValueHandler

• 內容協商配置器

  • WebFlux--RequestedContentTypeResolverBuilder
  • SpringMvc--ContentNegotiationConfigurer

還有很多就不一一例舉了，想知道核心組件對比結果的同學，可以看下圖。注意很多圖上的組件名稱相同，但是包的位置是不同的，所以大家要注意區分，不要弄混了。

Web MVC VS. WebFlux 核心組件對比

p17.png

函數式端點請求處理流程

流程圖

按照慣例，上流程圖

p15.png

通過上圖，我們可以看到，這個處理跟之前的註解驅動請求大有不同，但是請求的流程是萬變不離其宗，只是組件有所變化。

源碼解讀

接下來我們就跟着流程圖一步一步的來解讀WebFlux函數端點式請求的源碼。

裝配階段

由上圖我們可以看到 RouterFunctionMapping是由WebFluxConfigurationSupport創建的，在之前的筆記中我們已經有說明。

我們接下來看一下RouterFunctions是怎麼合併RouterFunction的並且如何關聯到RouterFunctionMapping的。

我們先來看一下 RouterFunctionMapping關於裝配階段的代碼。

 

public class RouterFunctionMapping extends AbstractHandlerMapping implements InitializingBean {

   @Nullable
   private RouterFunction<?> routerFunction;
    //省略部分代碼
    
    //afterPropertiesSet()方法 是組件初始化後回調 必須實現InitializingBean接口
    //
   @Override
   public void afterPropertiesSet() throws Exception {
      if (CollectionUtils.isEmpty(this.messageReaders)) {
         ServerCodecConfigurer codecConfigurer = ServerCodecConfigurer.create();
         this.messageReaders = codecConfigurer.getReaders();
      }

      //初始化routerFunction
      if (this.routerFunction == null) {
         initRouterFunctions();
      }
   }

   /**
    * Initialized the router functions by detecting them in the application context.
    * 從應用上下文中查找他們並初始化路由方法
    */
   protected void initRouterFunctions() {
      if (logger.isDebugEnabled()) {
         logger.debug("Looking for router functions in application context: " +
               getApplicationContext());
      }

      //查找合併所有路由方法的bean
      List<RouterFunction<?>> routerFunctions = routerFunctions();
      if (!CollectionUtils.isEmpty(routerFunctions) && logger.isInfoEnabled()) {
         routerFunctions.forEach(routerFunction -> logger.info("Mapped " + routerFunction));
      }
       
      //將一個請求中含有多個路由請求方法合併成一個方法
      this.routerFunction = routerFunctions.stream()
            .reduce(RouterFunction::andOther)
            .orElse(null);
   }

    //查找併合並所有路由方法
   private List<RouterFunction<?>> routerFunctions() {
       //聲明 SortedRouterFunctionsContainer bean
      SortedRouterFunctionsContainer container = new SortedRouterFunctionsContainer();
       //自動注入到上下文中 
      obtainApplicationContext().getAutowireCapableBeanFactory().autowireBean(container);
      //返回路由
      return CollectionUtils.isEmpty(container.routerFunctions) ? Collections.emptyList() :
            container.routerFunctions;
   }
    //省略部分代碼
   private static class SortedRouterFunctionsContainer {

      @Nullable
      private List<RouterFunction<?>> routerFunctions;

       //由上面的方法 自動注入bean時實現依賴查找，查找所有的 RouterFunction beans
       //並注入到 List<RouterFunction<?>> 中。這樣就會得到所有實現路由方法的集合
      @Autowired(required = false)
      public void setRouterFunctions(List<RouterFunction<?>> routerFunctions) {
         this.routerFunctions = routerFunctions;
      }
   }

}

請求階段

請求階段的核心代碼就是 org.springframework.web.reactive.DispatcherHandler#handle方法,我們來看一下源碼。

 

@Override
public Mono<Void> handle(ServerWebExchange exchange) {
   if (logger.isDebugEnabled()) {
      ServerHttpRequest request = exchange.getRequest();
      logger.debug("Processing " + request.getMethodValue() + " request for [" + request.getURI() + "]");
   }
   if (this.handlerMappings == null) {
      return Mono.error(HANDLER_NOT_FOUND_EXCEPTION);
   }
   // 1.HTTP請求進來後執行的流程
   return Flux.fromIterable(this.handlerMappings)  //2 遍歷handlerMappings定位RouterFunctionMapping
         .concatMap(mapping -> mapping.getHandler(exchange))   // 3.獲取HandlerFunction
         .next()
         .switchIfEmpty(Mono.error(HANDLER_NOT_FOUND_EXCEPTION))  
         .flatMap(handler -> invokeHandler(exchange, handler))   //4.執行
         .flatMap(result -> handleResult(exchange, result));  //5. 處理結果
}

上面的代碼已經把大部分的流程說明清楚了，那麼我們來看一下lambda表達式中每個內部方法的具體實現。

首先我們來看一下步驟3的具體實現 org.springframework.web.reactive.handler.AbstractHandlerMapping#getHandler

 

@Override
public Mono<Object> getHandler(ServerWebExchange exchange) {
    //調用 getHandlerInternal 方法來確定HandlerFunction
   return getHandlerInternal(exchange).map(handler -> {
      if (CorsUtils.isCorsRequest(exchange.getRequest())) {
         CorsConfiguration configA = this.globalCorsConfigSource.getCorsConfiguration(exchange);
         CorsConfiguration configB = getCorsConfiguration(handler, exchange);
         CorsConfiguration config = (configA != null ? configA.combine(configB) : configB);
         if (!getCorsProcessor().process(config, exchange) ||
               CorsUtils.isPreFlightRequest(exchange.getRequest())) {
            return REQUEST_HANDLED_HANDLER;
         }
      }
      return handler;
   });
}

上面一大段代碼其實主要來獲取handler的方法是 getHandlerInternal(exchange) 剩下的部分是 跨域處理的邏輯。我們看一下 這個方法。

 

@Override
protected Mono<?> getHandlerInternal(ServerWebExchange exchange) {
   if (this.routerFunction != null) {
      ServerRequest request = ServerRequest.create(exchange, this.messageReaders);
      exchange.getAttributes().put(RouterFunctions.REQUEST_ATTRIBUTE, request);
      return this.routerFunction.route(request);  //通過路由獲取到對應處理的HandlerFunction 也就是執行方法
   }
   else {
      return Mono.empty();
   }
}

獲取到對應的HandlerFunction後我們就來執行第四步，調用HandlerFunction。

 

private Mono<HandlerResult> invokeHandler(ServerWebExchange exchange, Object handler) {
   if (this.handlerAdapters != null) {
      for (HandlerAdapter handlerAdapter : this.handlerAdapters) {
         if (handlerAdapter.supports(handler)) {  //判斷HandlerAdapters中是否支持之前獲取到的handler
            return handlerAdapter.handle(exchange, handler);  //執行handler 對應下面handle的方法
         }
      }
   }
   return Mono.error(new IllegalStateException("No HandlerAdapter: " + handler));
}

org.springframework.web.reactive.function.server.support.HandlerFunctionAdapter#handle方法，這個類中的方法就是處理函數式端點請求的Adapter具體實現

 

@Override
public Mono<HandlerResult> handle(ServerWebExchange exchange, Object handler) {
   HandlerFunction<?> handlerFunction = (HandlerFunction<?>) handler;
   ServerRequest request = exchange.getRequiredAttribute(RouterFunctions.REQUEST_ATTRIBUTE);
   return handlerFunction.handle(request)   //由lambda模式 (返回值-參數)  無需準確的方法簽名
         .map(response -> new HandlerResult(handlerFunction, response, HANDLER_FUNCTION_RETURN_TYPE));   //返回HandlerResult對象 
}

這裏的lambda模式比較難理解，我也是看了好幾遍才理解馬哥所說，主要是看HandlerFunction這個函數式接口

 

@FunctionalInterface
public interface HandlerFunction<T extends ServerResponse> {

   /**
    * Handle the given request.
    * @param request the request to handle
    * @return the response
    */
   Mono<T> handle(ServerRequest request);

}

我們只需要滿足 入參是ServerRequest類型 返回值是Mono<T> 就可以執行。

調用完具體方法之後，我們就可以進行返回值解析序列化了。這裏就是步驟5 處理結果。

 

private Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult result) {
    //獲取對應的返回結果處理器並處理          
   return getResultHandler(result).handleResult(exchange, result)   
       //如果出現錯誤或者異常 則選擇對應的異常結果處理器進行處理
         .onErrorResume(ex -> result.applyExceptionHandler(ex).flatMap(exceptionResult ->                   getResultHandler(exceptionResult).handleResult(exchange, exceptionResult)));
}

我們再來看一下getResultHandler代碼

 

private HandlerResultHandler getResultHandler(HandlerResult handlerResult) {
   if (this.resultHandlers != null) {
      for (HandlerResultHandler resultHandler : this.resultHandlers) {
         if (resultHandler.supports(handlerResult)) {
            return resultHandler;
         }
      }
   }
   throw new IllegalStateException("No HandlerResultHandler for " + handlerResult.getReturnValue());
}

在這裏我們看一下resultHandlers中都含有哪些返回值處理器

p18.png

我們通過截圖可以看出返回值解析器跟流程圖一一對應。

之後的8,9步就是在匹配到對應的返回值解析器之後進行返回值的封裝和寫會，這裏要注意DataBuffer是NIO的寫處理，最後寫回到瀏覽器客戶端。

總結

其實在瞭解SpringMvc的請求流程源碼之後，理解WebFlux就容易的多，畢竟WebFlux處理流程是模仿Servlet另起爐竈的。如果感興趣的小夥伴可以跟着我的思路自己寫一個請求方法去debugger一下加深理解。