深入剖析 Spring WebFlux

一、WebFlux 簡介

WebFlux 是 Spring Framework5.0 中引入的一種新的反應式Web框架。通過Reactor專案實現Reactive Streams規範，完全非同步和非阻塞框架。本身不會加快程式執行速度，但在高併發情況下藉助非同步IO能夠以少量而穩定的執行緒處理更高的吞吐，規避檔案IO/網路IO阻塞帶來的執行緒堆積。

1.1 WebFlux 的特性

WebFlux 具有以下特性：

• 非同步非阻塞 - 可以舉一個上傳例子。相對於 Spring MVC 是同步阻塞IO模型，Spring WebFlux這樣處理：執行緒發現檔案資料沒傳輸好，就先做其他事情，當檔案準備好時通知執行緒來處理（這裡就是輸入非阻塞方式），當接收完並寫入磁碟（該步驟也可以採用非同步非阻塞方式）完畢後再通知執行緒來處理響應（這裡就是輸出非阻塞方式）。

• 響應式函式程式設計 - 相對於Java8 Stream 同步、阻塞的Pull模式，Spring Flux 採用Reactor Stream 非同步、非阻塞Push模式。書寫採用 Java lambda 方式,接近自然語言形式且容易理解。

• 不拘束於Servlet - 可以執行在傳統的Servlet 容器（3.1+版本），還能執行在Netty、Undertow等NIO容器中。

1.2 WebFlux 的設計目標

• 適用高併發

• 高吞吐量

• 可伸縮性

二、Spring WebFlux 元件介紹

2.1 HTTPHandler

一個簡單的處理請求和響應的抽象，用來適配不同HTTP服務容器的API。

2.2 WebHandler

一個用於處理業務請求抽象介面，定義了一系列處理行為。相關核心實現類如下；

2.3 DispatcherHandler

請求處理的總控制器，實際工作是由多個可配置的元件來處理。

WebFlux是相容Spring MVC 基於@Controller，@RequestMapping等註解的程式設計開發方式的，可以做到平滑切換。

2.4 Functional Endpoints

這是一個輕量級函式程式設計模型。是基於@Controller，@RequestMapping等註解的程式設計模型的替代方案，提供一套函式式API 用於建立Router,Handler和Filter。呼叫處理元件如下：

簡單的RouterFuntion 路由註冊和業務處理過程：

@Bean
public RouterFunction<ServerResponse> initRouterFunction() {
    return RouterFunctions.route()
        .GET("/hello/{name}", serverRequest -> {
            String name = serverRequest.pathVariable("name");
            return ServerResponse.ok().bodyValue(name);
        }).build();
}

請求轉發處理過程：

2.5 Reactive Stream

這是一個重要的元件，WebFlux 就是利用Reactor 來重寫了傳統Spring MVC 邏輯。其中Flux和Mono 是Reactor中兩個關鍵概念。掌握了這兩個概念才能理解WebFlux工作方式。

Flux和Mono 都實現了Reactor的Publisher介面,屬於時間釋出者，對消費者提供訂閱介面，當有事件發生的時候，Flux或者Mono會通過回撥消費者的相應的方法來通知消費者相應的事件。這就是所謂的響應式程式設計模型。

Mono工作流程圖

只會在傳送出單個結果後完成。

Flux工作流程圖

傳送出零個或者多個，可能無限個結果後才完成。

對於流式媒體型別：application/stream+json 或者 text/event-stream ，可以讓呼叫端獲得伺服器滾動結果。
對於非流型別：application/json  WebFlux 預設JSON編碼器會將序列化的JSON 一次性重新整理到網路，這並不意味著阻塞，因為結果Flux<?> 是以反應式方式寫入網路的，沒有任何障礙。

三、WebFlux 工作原理

3.1 元件裝配過程

流程相關原始碼解析-WebFluxAutoConfiguration

@Configuration
//條件裝配 只有啟動的型別是REACTIVE時載入
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
//只有存在 WebFluxConfigurer例項  時載入
@ConditionalOnClass(WebFluxConfigurer.class)
//在不存在  WebFluxConfigurationSupport例項時 載入
@ConditionalOnMissingBean({ WebFluxConfigurationSupport.class })
//在之後裝配
@AutoConfigureAfter({ ReactiveWebServerFactoryAutoConfiguration.class,
      CodecsAutoConfiguration.class, ValidationAutoConfiguration.class })
//自動裝配順序
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
public class WebFluxAutoConfiguration {
   @Configuration
   @EnableConfigurationProperties({ ResourceProperties.class, WebFluxProperties.class })
   //介面程式設計 在裝配WebFluxConfig 之前要先 裝配EnableWebFluxConfiguration
   @Import({ EnableWebFluxConfiguration.class })
   public static class WebFluxConfig implements WebFluxConfigurer {
      //隱藏部分原始碼
     /**
     * Configuration equivalent to {@code @EnableWebFlux}.
     */
   } 
    @Configuration
    public static class EnableWebFluxConfiguration
            extends DelegatingWebFluxConfiguration {
        //隱藏部分程式碼
    }
    @Configuration
    @ConditionalOnEnabledResourceChain
    static class ResourceChainCustomizerConfiguration {
        //隱藏部分程式碼
    }
    private static class ResourceChainResourceHandlerRegistrationCustomizer
            implements ResourceHandlerRegistrationCustomizer {
        //隱藏部分程式碼
    }

WebFluxAutoConfiguration 自動裝配時先自動裝配EnableWebFluxConfiguration 而EnableWebFluxConfiguration->DelegatingWebFluxConfiguration ->WebFluxConfigurationSupport。

最終WebFluxConfigurationSupport 不僅配置DispatcherHandler 還同時配置了其他很多WebFlux核心元件包括 異常處理器WebExceptionHandler,對映處理器處理器HandlerMapping，請求介面卡HandlerAdapter，響應處理器HandlerResultHandler 等。

DispatcherHandler 建立初始化過程如下；

public class WebFluxConfigurationSupport implements ApplicationContextAware {
   //隱藏部分程式碼
   @Nullable
   public final ApplicationContext getApplicationContext() {
      return this.applicationContext;
   }
	//隱藏部分程式碼
   @Bean
   public DispatcherHandler webHandler() {
      return new DispatcherHandler();
   }

public class DispatcherHandler implements WebHandler, ApplicationContextAware {
   @Nullable
   private List<HandlerMapping> handlerMappings;
   @Nullable
   private List<HandlerAdapter> handlerAdapters;
   @Nullable
   private List<HandlerResultHandler> resultHandlers;
   	@Override
   public void setApplicationContext(ApplicationContext applicationContext) {
		initStrategies(applicationContext);
   }
   protected void initStrategies(ApplicationContext context) {
   	  //注入handlerMappings
      Map<String, HandlerMapping> mappingBeans = BeanFactoryUtils.beansOfTypeIncludingAncestors(
            context, HandlerMapping.class, true, false);

      ArrayList<HandlerMapping> mappings = new ArrayList<>(mappingBeans.values());
      AnnotationAwareOrderComparator.sort(mappings);
      this.handlerMappings = Collections.unmodifiableList(mappings);
 	  //注入handlerAdapters
      Map<String, HandlerAdapter> adapterBeans = BeanFactoryUtils.beansOfTypeIncludingAncestors(
            context, HandlerAdapter.class, true, false);

      this.handlerAdapters = new ArrayList<>(adapterBeans.values());
      AnnotationAwareOrderComparator.sort(this.handlerAdapters);
      //注入resultHandlers
      Map<String, HandlerResultHandler> beans = BeanFactoryUtils.beansOfTypeIncludingAncestors(
            context, HandlerResultHandler.class, true, false);

      this.resultHandlers = new ArrayList<>(beans.values());
      AnnotationAwareOrderComparator.sort(this.resultHandlers);
   }

流程相關原始碼解析-HTTPHandlerAutoConfiguration

上面已講解過WebFlux 核心元件裝載過程，那麼這些元件又是什麼時候注入到對應的容器上下文中的呢？其實是在重新整理容器上下文時注入進去的。

org.springframework.boot.web.reactive.context.ReactiveWebServerApplicationContext#onRefresh

public class ReactiveWebServerApplicationContext extends GenericReactiveWebApplicationContext
      implements ConfigurableWebServerApplicationContext {
   @Override
   protected void onRefresh() {
      super.onRefresh();
      try {
         createWebServer();
      }
      catch (Throwable ex) {
         throw new ApplicationContextException("Unable to start reactive web server", ex);
      }
   }
   private void createWebServer() {
      WebServerManager serverManager = this.serverManager;
      if (serverManager == null) {
         String webServerFactoryBeanName = getWebServerFactoryBeanName();
         ReactiveWebServerFactory webServerFactory = getWebServerFactory(webServerFactoryBeanName);
         boolean lazyInit = getBeanFactory().getBeanDefinition(webServerFactoryBeanName).isLazyInit();
         // 這裡建立容器管理時注入httpHandler
         this.serverManager = new WebServerManager(this, webServerFactory, this::getHttpHandler, lazyInit);
         getBeanFactory().registerSingleton("webServerGracefulShutdown",
               new WebServerGracefulShutdownLifecycle(this.serverManager));
         // 註冊一個 web容器啟動服務類,該類繼承了SmartLifecycle
         getBeanFactory().registerSingleton("webServerStartStop",
               new WebServerStartStopLifecycle(this.serverManager));
      }
      initPropertySources();
   }
   protected HttpHandler getHttpHandler() {
		String[] beanNames = getBeanFactory().getBeanNamesForType(HttpHandler.class);
		if (beanNames.length == 0) {
			throw new ApplicationContextException(
					"Unable to start ReactiveWebApplicationContext due to missing HttpHandler bean.");
		}
		if (beanNames.length > 1) {
			throw new ApplicationContextException(
					"Unable to start ReactiveWebApplicationContext due to multiple HttpHandler beans : "
							+ StringUtils.arrayToCommaDelimitedString(beanNames));
		}
        //容器上下文獲取httpHandler
		return getBeanFactory().getBean(beanNames[0], HttpHandler.class);
	}

而這個HTTPHandler 是由HTTPHandlerAutoConfiguration裝配進去的。

@Configuration
@ConditionalOnClass({ DispatcherHandler.class, HttpHandler.class })
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
@ConditionalOnMissingBean(HttpHandler.class)
@AutoConfigureAfter({ WebFluxAutoConfiguration.class })
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
public class HttpHandlerAutoConfiguration {
   @Configuration
   public static class AnnotationConfig {
      private ApplicationContext applicationContext;
      public AnnotationConfig(ApplicationContext applicationContext) {
         this.applicationContext = applicationContext;
      }
      //構建WebHandler
      @Bean
      public HttpHandler httpHandler() {
         return WebHttpHandlerBuilder.applicationContext(this.applicationContext)
               .build();
      }
   }

流程相關原始碼解析-web容器

org.springframework.boot.web.reactive.context.ReactiveWebServerApplicationContext#createWebServer 。在建立WebServerManager 容器管理器時會獲取對應web容器例項，並注入響應的HTTPHandler。

class WebServerManager {
   private final ReactiveWebServerApplicationContext applicationContext;
   private final DelayedInitializationHttpHandler handler;
   private final WebServer webServer;
   WebServerManager(ReactiveWebServerApplicationContext applicationContext, ReactiveWebServerFactory factory,
         Supplier<HttpHandler> handlerSupplier, boolean lazyInit) {
      this.applicationContext = applicationContext;
      Assert.notNull(factory, "Factory must not be null");
      this.handler = new DelayedInitializationHttpHandler(handlerSupplier, lazyInit);
      this.webServer = factory.getWebServer(this.handler);
   }
}

以Tomcat 容器為例展示建立過程，使用的是 TomcatHTTPHandlerAdapter 來連線Servlet 請求到HTTPHandler元件。

public class TomcatReactiveWebServerFactory extends AbstractReactiveWebServerFactory implements ConfigurableTomcatWebServerFactory {
    //隱藏部分程式碼   
    @Override
    public WebServer getWebServer(HttpHandler httpHandler) {
        if (this.disableMBeanRegistry) {
            Registry.disableRegistry();
        }
        Tomcat tomcat = new Tomcat();
        File baseDir = (this.baseDirectory != null) ? this.baseDirectory : createTempDir("tomcat");
        tomcat.setBaseDir(baseDir.getAbsolutePath());
        Connector connector = new Connector(this.protocol);
        connector.setThrowOnFailure(true);
        tomcat.getService().addConnector(connector);
        customizeConnector(connector);
        tomcat.setConnector(connector);
        tomcat.getHost().setAutoDeploy(false);
        configureEngine(tomcat.getEngine());
        for (Connector additionalConnector : this.additionalTomcatConnectors) {
            tomcat.getService().addConnector(additionalConnector);
        }
        TomcatHttpHandlerAdapter servlet = new TomcatHttpHandlerAdapter(httpHandler);
        prepareContext(tomcat.getHost(), servlet);
        return getTomcatWebServer(tomcat);
    }
}

最後Spring容器載入後通過SmartLifecycle實現類WebServerStartStopLifecycle 來啟動Web容器。

WebServerStartStopLifecycle 註冊過程詳見：org.springframework.boot.web.reactive.context.ReactiveWebServerApplicationContext#createWebServer

3.2 完整請求處理流程

(引用自：https://blog.csdn.net)

該圖給出了一個HTTP請求處理的呼叫鏈路。是採用Reactor Stream 方式書寫，只有最終呼叫 subscirbe 才真正執行業務邏輯。基於WebFlux 開發時要避免controller 中存在阻塞邏輯。列舉下面例子可以看到Spring MVC 和Spring Webflux 之間的請求處理區別。

@RestControllerpublic
class TestController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    @GetMapping("sync")
    public String sync() {
        logger.info("sync method start");
        String result = this.execute();
        logger.info("sync method end");
        return result;
    }
    @GetMapping("async/mono")
    public Mono<String> asyncMono() {
        logger.info("async method start");
        Mono<String> result = Mono.fromSupplier(this::execute);
        logger.info("async method end");
        return result;
    }
    private String execute() {
        try {
            TimeUnit.SECONDS.sleep(5);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return "hello";
    }
}

日誌輸出

2021-05-31 20:14:52.384  INFO 3508 --- [nio-8080-exec-2] c.v.internet.webflux.web.TestController  : sync method start
2021-05-31 20:14:57.385  INFO 3508 --- [nio-8080-exec-2] c.v.internet.webflux.web.TestController  : sync method end
2021-05-31 20:15:09.659  INFO 3508 --- [nio-8080-exec-3] c.v.internet.webflux.web.TestController  : async method start
2021-05-31 20:15:09.660  INFO 3508 --- [nio-8080-exec-3] c.v.internet.webflux.web.TestController  : async method end

從上面例子可以看出sync() 方法阻塞了請求，而asyncMono() 沒有阻塞請求並立刻返回的。asyncMono() 方法具體業務邏輯 被包裹在了Mono 中Supplier中的了。當execute 處理完業務邏輯後通過回撥方式響應給瀏覽器。

四、儲存支援

一旦控制層使用了 Spring Webflux 則安全認證層、資料訪問層都必須使用 Reactive API 才真正實現非同步非阻塞。

NOSQL Database

• MongoDB (org.springframework.boot:spring-boot-starter-data-mongodb-reactive)。

• Redis(org.springframework.boot:spring-boot-starter-data-redis-reactive)。

Relational Database

• H2 (io.r2dbc:r2dbc-h2)

• MariaDB (org.mariadb:r2dbc-mariadb)

• Microsoft SQL Server (io.r2dbc:r2dbc-mssql)

• MySQL (dev.miku:r2dbc-mysql)

• jasync-sql MySQL (com.github.jasync-sql:jasync-r2dbc-mysql)

• Postgres (io.r2dbc:r2dbc-postgresql)

• Oracle (com.oracle.database.r2dbc:oracle-r2dbc)

五、總結

關於Spring MVC 和Spring WebFlux 測評很多，本文引用下做簡單說明。參考：《Spring: Blocking vs non-blocking: R2DBC vs JDBC and WebFlux vs Web MVC》。

基本依賴

<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-data-r2dbc</artifactId> 
</dependency> 
<!-- r2dbc 連線池 --> 
<dependency> 
    <groupId >io.r2dbc</groupId> 
    <artifactId>r2dbc-pool</artifactId> 
</dependency> 
<!--r2dbc mysql 庫--> 
<dependency> 
    <groupId>dev.miku</groupId> 
    <artifactId>r2dbc- mysql</artifactId> 
</dependency> 
<!--自動配置需要引入一個嵌入式資料庫型別物件--> 
<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-data-jdbc</artifactId> 
</dependency>
<!-- 反應方程式 web 框架 webflux--> 
<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-webflux</artifactId> 
</dependency>

相同資料下效果如下；

Spring MVC + JDBC 在低併發下表現最好，但 WebFlux + R2DBC 在高併發下每個處理請求使用的記憶體最少。

Spring WebFlux + R2DBC 在高併發下，吞吐量表現優異。

作者：vivo網際網路伺服器團隊-Zhou Changqing