DispatcherHandler

Spring WebFlux,类似于 Spring MVC,也是围绕前端控制器模式设计的, 其中一个中央 WebHandler,即 DispatcherHandler,为请求处理提供了一个共享算法, 而实际工作则由可配置的委托组件执行。 这种模型非常灵活,支持多种工作流。 DispatcherHandler 从 Spring 配置中发现它所需的委托组件。 它本身也被设计为一个 Spring bean,并实现了 ApplicationContextAware 以访问其运行的上下文。如果 DispatcherHandler 以 bean 名称 webHandler 声明,那么它将反过来被 WebHttpHandlerBuilder 发现,后者会组装一个请求处理链,如 WebHandler API 中所述。 WebFlux 应用程序中的 Spring 配置通常包含:

配置被提供给 WebHttpHandlerBuilder 以构建处理链, 如下例所示:

  • Java

  • Kotlin

ApplicationContext context = ...
HttpHandler handler = WebHttpHandlerBuilder.applicationContext(context).build();
val context: ApplicationContext = ...
val handler = WebHttpHandlerBuilder.applicationContext(context).build()

生成的 HttpHandler 可以与 服务器适配器 一起使用。

特殊 Bean 类型

DispatcherHandler 委托给特殊 bean 来处理请求并渲染适当的响应。 “特殊 bean”指的是实现 WebFlux 框架契约的 Spring 管理的 Object 实例。 这些通常带有内置契约,但您可以自定义它们的属性、扩展它们或替换它们。

下表列出了 DispatcherHandler 检测到的特殊 bean。请注意, 还有一些在较低级别检测到的其他 bean(参见 Web Handler API 中的特殊 bean 类型)。

Bean 类型 解释

HandlerMapping

将请求映射到处理器。映射基于某些标准, 其细节因 HandlerMapping 实现而异——注解控制器、简单 URL 模式映射等。

主要的 HandlerMapping 实现是用于 @RequestMapping 注解方法的 RequestMappingHandlerMapping,用于函数式端点 路由的 RouterFunctionMapping,以及用于显式注册 URI 路径模式 和 WebHandler 实例的 SimpleUrlHandlerMapping

HandlerAdapter

帮助 DispatcherHandler 调用映射到请求的处理器,而不管 处理器实际如何被调用。例如,调用注解控制器 需要解析注解。HandlerAdapter 的主要目的是保护 DispatcherHandler 免受这些细节的影响。

HandlerResultHandler

处理处理器调用结果并完成响应。 参见 结果处理

WebFlux 配置

应用程序可以声明处理请求所需的 基础设施 bean(列在 Web Handler APIDispatcherHandler 下)。 然而,在大多数情况下, WebFlux 配置 是最佳起点。它声明了所需的 bean 并提供了一个更高级别的 配置回调 API 来对其进行自定义。

Spring Boot 依赖 WebFlux 配置来配置 Spring WebFlux,并且还提供了 许多额外的便捷选项。

处理

DispatcherHandler 按如下方式处理请求:

  • 每个 HandlerMapping 都被要求查找匹配的处理器,并使用第一个匹配项。

  • 如果找到处理器,它会通过适当的 HandlerAdapter 运行,该适配器 将执行的返回值公开为 HandlerResult

  • HandlerResult 被交给适当的 HandlerResultHandler,通过直接写入响应 或使用视图渲染来完成处理。

结果处理

通过 HandlerAdapter 调用处理器的返回值被封装为 HandlerResult,并带有一些附加上下文,然后传递给第一个声明支持它的 HandlerResultHandler。下表显示了可用的 HandlerResultHandler 实现,所有这些都在 WebFlux 配置 中声明:

结果处理器类型 返回值 默认顺序

ResponseEntityResultHandler

ResponseEntity,通常来自 @Controller 实例。

0

ServerResponseResultHandler

ServerResponse,通常来自函数式端点。

0

ResponseBodyResultHandler

处理 @ResponseBody 方法或 @RestController 类中的返回值。

100

ViewResolutionResultHandler

CharSequence、https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/result/view/View.html[View]、 ModelMapRendering 或任何其他 Object 都被视为模型属性。

另请参见 视图解析

Integer.MAX_VALUE

异常

HandlerAdapter 实现可以内部处理调用请求处理器(例如控制器方法)时发生的异常。 但是,如果请求处理器返回异步值,则异常可能会被延迟。

HandlerAdapter 可以将其异常处理机制公开为在其返回的 HandlerResult 上设置的 DispatchExceptionHandler。当设置了该机制时, DispatcherHandler 也会将其应用于结果的处理。

HandlerAdapter 也可以选择实现 DispatchExceptionHandler。在这种情况下, DispatcherHandler 会将其应用于在处理器映射之前发生的异常, 例如,在处理器映射期间,或者更早,例如,在 WebFilter 中。

另请参见 “注解控制器” 部分中的 异常 或 WebHandler API 部分中的 异常

视图解析

视图解析支持使用 HTML 模板和模型向浏览器渲染,而无需绑定到特定的视图技术。 在 Spring WebFlux 中,视图解析通过一个专用的 HandlerResultHandler 来支持,该处理器使用 ViewResolver 实例将字符串(表示逻辑视图名称)映射到 View 实例。然后使用 View 来渲染响应。

Web 应用程序需要使用 视图渲染库 来支持此用例。

处理

传递给 ViewResolutionResultHandlerHandlerResult 包含处理器返回的值 以及在请求处理期间添加了属性的模型。返回值被处理为以下之一:

  • StringCharSequence:一个逻辑视图名称,通过配置的 ViewResolver 实现列表解析为 View

  • void:根据请求路径选择一个默认视图名称,去掉前导和 尾随斜杠,并将其解析为 View。当未提供视图名称时(例如,返回了模型属性) 或异步返回值(例如,Mono 完成为空)时,也会发生同样的情况。

  • Rendering:用于 视图解析场景的 API。在您的 IDE 中使用代码补全探索选项。

  • ModelMap:要添加到请求模型的额外模型属性。

  • 任何其他:任何其他返回值(除了简单类型,由 BeanUtils#isSimpleProperty 确定) 都被视为要添加到模型的模型属性。属性名称通过 约定 从类名派生, 除非存在处理器方法 @ModelAttribute 注解。

模型可以包含异步、响应式类型(例如,来自 Reactor 或 RxJava)。在渲染之前, AbstractView 将此类模型属性解析为具体值并更新模型。 单值响应式类型解析为单个值或无值(如果为空),而多值响应式类型(例如,Flux<T>) 被 收集并解析为 List<T>

配置视图解析就像将 ViewResolutionResultHandler bean 添加到您的 Spring 配置一样简单。 WebFlux 配置 为视图解析提供了 专用的配置 API。

有关与 Spring WebFlux 集成的视图技术的更多信息,请参见 视图技术

重定向

视图名称中的特殊 redirect: 前缀允许您执行重定向。 UrlBasedViewResolver(及其子类)将其识别为需要重定向的指令。 视图名称的其余部分是重定向 URL。

其最终效果与控制器返回 RedirectViewRendering.redirectTo("abc").build() 相同,但现在控制器本身可以 根据逻辑视图名称进行操作。像 redirect:/some/resource 这样的视图名称是相对于当前应用程序的,而像 redirect:https://example.com/arbitrary/path 这样的视图名称则重定向到绝对 URL。

与 Servlet 栈不同, Spring WebFlux 不支持 "FORWARD" 调度,因此不支持 forward: 前缀作为结果。

内容协商

ViewResolutionResultHandler 支持内容协商。它将请求 媒体类型与每个选定 View 支持的媒体类型进行比较。 使用第一个支持请求媒体类型(或多个媒体类型)的 View

为了支持 JSON 和 XML 等媒体类型,Spring WebFlux 提供了 HttpMessageWriterView,它是一个特殊的 View,通过 HttpMessageWriter 进行渲染。 通常,您会通过 WebFlux 配置 将它们配置为默认视图。 如果默认视图与请求的媒体类型匹配,则始终选择并使用它们。