响应式 Web 应用程序

Spring Boot 通过为 Spring Webflux 提供自动配置，简化了响应式 Web 应用程序的开发。

“Spring WebFlux 框架”

Spring WebFlux 是 Spring Framework 5.0 中引入的新响应式 Web 框架。与 Spring MVC 不同，它不需要 servlet API，完全异步且非阻塞，并通过 响应式流 规范实现 Reactor 项目。

Spring WebFlux 有两种形式：函数式和基于注解的。基于注解的形式与 Spring MVC 模型非常接近，如下例所示

  • Java

  • Kotlin

import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/users")
public class MyRestController {

	private final UserRepository userRepository;

	private final CustomerRepository customerRepository;

	public MyRestController(UserRepository userRepository, CustomerRepository customerRepository) {
		this.userRepository = userRepository;
		this.customerRepository = customerRepository;
	}

	@GetMapping("/{userId}")
	public Mono<User> getUser(@PathVariable Long userId) {
		return this.userRepository.findById(userId);
	}

	@GetMapping("/{userId}/customers")
	public Flux<Customer> getUserCustomers(@PathVariable Long userId) {
		return this.userRepository.findById(userId).flatMapMany(this.customerRepository::findByUser);
	}

	@DeleteMapping("/{userId}")
	public Mono<Void> deleteUser(@PathVariable Long userId) {
		return this.userRepository.deleteById(userId);
	}

}
import org.springframework.web.bind.annotation.DeleteMapping
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
import reactor.core.publisher.Flux
import reactor.core.publisher.Mono

@RestController
@RequestMapping("/users")
class MyRestController(private val userRepository: UserRepository, private val customerRepository: CustomerRepository) {

	@GetMapping("/{userId}")
	fun getUser(@PathVariable userId: Long): Mono<User?> {
		return userRepository.findById(userId)
	}

	@GetMapping("/{userId}/customers")
	fun getUserCustomers(@PathVariable userId: Long): Flux<Customer> {
		return userRepository.findById(userId).flatMapMany { user: User? ->
			customerRepository.findByUser(user)
		}
	}

	@DeleteMapping("/{userId}")
	fun deleteUser(@PathVariable userId: Long): Mono<Void> {
		return userRepository.deleteById(userId)
	}

}

WebFlux 是 Spring Framework 的一部分，详细的信息可以在其 参考文档 中找到。

“WebFlux.fn”，函数式变体，将路由配置与实际请求处理分离，如下例所示

  • Java

  • Kotlin

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.reactive.function.server.RequestPredicate;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.ServerResponse;

import static org.springframework.web.reactive.function.server.RequestPredicates.accept;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;

@Configuration(proxyBeanMethods = false)
public class MyRoutingConfiguration {

	private static final RequestPredicate ACCEPT_JSON = accept(MediaType.APPLICATION_JSON);

	@Bean
	public RouterFunction<ServerResponse> monoRouterFunction(MyUserHandler userHandler) {
		return route()
				.GET("/{user}", ACCEPT_JSON, userHandler::getUser)
				.GET("/{user}/customers", ACCEPT_JSON, userHandler::getUserCustomers)
				.DELETE("/{user}", ACCEPT_JSON, userHandler::deleteUser)
				.build();
	}

}
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.http.MediaType
import org.springframework.web.reactive.function.server.RequestPredicates.DELETE
import org.springframework.web.reactive.function.server.RequestPredicates.GET
import org.springframework.web.reactive.function.server.RequestPredicates.accept
import org.springframework.web.reactive.function.server.RouterFunction
import org.springframework.web.reactive.function.server.RouterFunctions
import org.springframework.web.reactive.function.server.ServerResponse

@Configuration(proxyBeanMethods = false)
class MyRoutingConfiguration {

	@Bean
	fun monoRouterFunction(userHandler: MyUserHandler): RouterFunction<ServerResponse> {
		return RouterFunctions.route(
			GET("/{user}").and(ACCEPT_JSON), userHandler::getUser).andRoute(
			GET("/{user}/customers").and(ACCEPT_JSON), userHandler::getUserCustomers).andRoute(
			DELETE("/{user}").and(ACCEPT_JSON), userHandler::deleteUser)
	}

	companion object {
		private val ACCEPT_JSON = accept(MediaType.APPLICATION_JSON)
	}

}

  • Java

  • Kotlin

import reactor.core.publisher.Mono;

import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;

@Component
public class MyUserHandler {

	public Mono<ServerResponse> getUser(ServerRequest request) {
		...
	}

	public Mono<ServerResponse> getUserCustomers(ServerRequest request) {
		...
	}

	public Mono<ServerResponse> deleteUser(ServerRequest request) {
		...
	}

}
import org.springframework.stereotype.Component
import org.springframework.web.reactive.function.server.ServerRequest
import org.springframework.web.reactive.function.server.ServerResponse
import reactor.core.publisher.Mono

@Component
class MyUserHandler {

	fun getUser(request: ServerRequest?): Mono<ServerResponse> {
		return ServerResponse.ok().build()
	}

	fun getUserCustomers(request: ServerRequest?): Mono<ServerResponse> {
		return ServerResponse.ok().build()
	}

	fun deleteUser(request: ServerRequest?): Mono<ServerResponse> {
		return ServerResponse.ok().build()
	}

}

“WebFlux.fn” 是 Spring Framework 的一部分，详细的信息可以在其 参考文档 中找到。

您可以根据需要定义任意数量的 RouterFunction bean 来模块化路由定义。如果需要应用优先级，可以对 bean 进行排序。

要开始使用，请将 spring-boot-starter-webflux 模块添加到您的应用程序中。

在您的应用程序中同时添加 spring-boot-starter-web 和 spring-boot-starter-webflux 模块会导致 Spring Boot 自动配置 Spring MVC，而不是 WebFlux。选择这种行为的原因是，许多 Spring 开发人员将 spring-boot-starter-webflux 添加到他们的 Spring MVC 应用程序中以使用响应式 WebClient。您仍然可以通过将选定的应用程序类型设置为 SpringApplication.setWebApplicationType(WebApplicationType.REACTIVE) 来强制执行您的选择。

Spring WebFlux 自动配置

Spring Boot 为 Spring WebFlux 提供自动配置，该配置适用于大多数应用程序。

自动配置在 Spring 的默认配置之上添加了以下功能

如果您想保留 Spring Boot WebFlux 功能并想添加额外的 WebFlux 配置，您可以添加自己的 @Configuration 类，该类是 WebFluxConfigurer 类型，但不带 @EnableWebFlux。

如果您想对自动配置的 HttpHandler 添加额外的自定义，您可以定义 WebHttpHandlerBuilderCustomizer 类型的 bean，并使用它们来修改 WebHttpHandlerBuilder。

如果您想完全控制 Spring WebFlux，您可以添加自己的 @Configuration，并用 @EnableWebFlux 进行注释。

Spring WebFlux 转换服务

如果您想自定义 Spring WebFlux 使用的 ConversionService，您可以提供一个带有 addFormatters 方法的 WebFluxConfigurer bean。

也可以使用 spring.webflux.format.* 配置属性自定义转换。如果没有配置，将使用以下默认值

属性 DateTimeFormatter

spring.webflux.format.date

ofLocalizedDate(FormatStyle.SHORT)

spring.webflux.format.time

ofLocalizedTime(FormatStyle.SHORT)

spring.webflux.format.date-time

ofLocalizedDateTime(FormatStyle.SHORT)

使用 HttpMessageReaders 和 HttpMessageWriters 的 HTTP 编解码器

Spring WebFlux 使用 HttpMessageReader 和 HttpMessageWriter 接口来转换 HTTP 请求和响应。它们使用 CodecConfigurer 配置，通过查看类路径中可用的库来获得合理的默认值。

Spring Boot 为编解码器提供了专门的配置属性，spring.codec.*。它还通过使用 CodecCustomizer 实例来应用进一步的自定义。例如，spring.jackson.* 配置键应用于 Jackson 编解码器。

如果您需要添加或自定义编解码器，您可以创建一个自定义的 CodecCustomizer 组件，如下例所示

  • Java

  • Kotlin

import org.springframework.boot.web.codec.CodecCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.codec.ServerSentEventHttpMessageReader;

@Configuration(proxyBeanMethods = false)
public class MyCodecsConfiguration {

	@Bean
	public CodecCustomizer myCodecCustomizer() {
		return (configurer) -> {
			configurer.registerDefaults(false);
			configurer.customCodecs().register(new ServerSentEventHttpMessageReader());
			// ...
		};
	}

}
import org.springframework.boot.web.codec.CodecCustomizer
import org.springframework.context.annotation.Bean
import org.springframework.http.codec.CodecConfigurer
import org.springframework.http.codec.ServerSentEventHttpMessageReader

class MyCodecsConfiguration {

	@Bean
	fun myCodecCustomizer(): CodecCustomizer {
		return CodecCustomizer { configurer: CodecConfigurer ->
			configurer.registerDefaults(false)
			configurer.customCodecs().register(ServerSentEventHttpMessageReader())
		}
	}

}

您还可以利用 Boot 的自定义 JSON 序列化器和反序列化器。

静态内容

默认情况下，Spring Boot 从类路径中名为 /static（或 /public 或 /resources 或 /META-INF/resources）的目录提供静态内容。它使用 Spring WebFlux 的 ResourceWebHandler，因此您可以通过添加自己的 WebFluxConfigurer 并覆盖 addResourceHandlers 方法来修改该行为。

默认情况下，资源映射到 /**，但您可以通过设置 spring.webflux.static-path-pattern 属性来调整它。例如，将所有资源重新定位到 /resources/** 可以通过以下方式实现

  • 属性

  • YAML

spring.webflux.static-path-pattern=/resources/**
spring:
  webflux:
    static-path-pattern: "/resources/**"

您还可以使用 spring.web.resources.static-locations 自定义静态资源位置。这样做会用目录位置列表替换默认值。如果您这样做，默认的欢迎页面检测将切换到您的自定义位置。因此，如果在启动时您的任何位置都有一个 index.html，它就是应用程序的主页。

除了前面列出的“标准”静态资源位置外，Webjars 内容 也是一个特殊情况。默认情况下，任何路径为 /webjars/** 的资源，如果以 Webjars 格式打包，则会从 jar 文件中提供服务。路径可以通过 spring.webflux.webjars-path-pattern 属性自定义。

Spring WebFlux 应用程序不严格依赖 servlet API，因此它们不能作为 war 文件部署，也不使用 src/main/webapp 目录。

欢迎页面

Spring Boot 支持静态和模板化的欢迎页面。它首先在配置的静态内容位置查找 index.html 文件。如果未找到，它将查找 index 模板。如果找到其中任何一个，它将自动用作应用程序的欢迎页面。

这仅作为应用程序定义的实际索引路由的回退。排序由 HandlerMapping bean 的顺序定义，默认情况下为以下顺序

RouterFunctionMapping

使用 RouterFunction bean 声明的端点

RequestMappingHandlerMapping

在 @Controller bean 中声明的端点

RouterFunctionMapping 用于欢迎页面

欢迎页面支持

模板引擎

除了 REST web 服务外，您还可以使用 Spring WebFlux 来提供动态 HTML 内容。Spring WebFlux 支持多种模板技术，包括 Thymeleaf、FreeMarker 和 Mustache。

Spring Boot 包含以下模板引擎的自动配置支持

当您使用这些模板引擎之一以及默认配置时，您的模板会自动从 src/main/resources/templates 中获取。

错误处理

Spring Boot 提供了一个 WebExceptionHandler，它以一种合理的方式处理所有错误。它在处理顺序中的位置紧接在 WebFlux 提供的处理程序之前，这些处理程序被认为是最后的。对于机器客户端，它会生成一个 JSON 响应，其中包含错误的详细信息、HTTP 状态和异常消息。对于浏览器客户端，有一个“白标签”错误处理程序，它以 HTML 格式呈现相同的数据。您也可以提供自己的 HTML 模板来显示错误（请参阅下一节）。

在直接自定义 Spring Boot 中的错误处理之前，您可以利用 Spring WebFlux 中的RFC 7807 问题详细信息支持。Spring WebFlux 可以使用 application/problem+json 媒体类型生成自定义错误消息，例如

{
	"type": "https://example.org/problems/unknown-project",
	"title": "Unknown project",
	"status": 404,
	"detail": "No project found for id 'spring-unknown'",
	"instance": "/projects/spring-unknown"
}

可以通过将 spring.webflux.problemdetails.enabled 设置为 true 来启用此支持。

自定义此功能的第一步通常涉及使用现有机制，但替换或增强错误内容。为此，您可以添加一个 ErrorAttributes 类型的 bean。

要更改错误处理行为，您可以实现 ErrorWebExceptionHandler 并注册该类型的 bean 定义。因为 ErrorWebExceptionHandler 的级别很低，所以 Spring Boot 还提供了一个方便的 AbstractErrorWebExceptionHandler，让您能够以 WebFlux 函数式的方式处理错误，如以下示例所示

  • Java

  • Kotlin

import reactor.core.publisher.Mono;

import org.springframework.boot.autoconfigure.web.WebProperties;
import org.springframework.boot.autoconfigure.web.reactive.error.AbstractErrorWebExceptionHandler;
import org.springframework.boot.web.reactive.error.ErrorAttributes;
import org.springframework.context.ApplicationContext;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.codec.ServerCodecConfigurer;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import org.springframework.web.reactive.function.server.ServerResponse.BodyBuilder;

@Component
public class MyErrorWebExceptionHandler extends AbstractErrorWebExceptionHandler {

	public MyErrorWebExceptionHandler(ErrorAttributes errorAttributes, WebProperties webProperties,
			ApplicationContext applicationContext, ServerCodecConfigurer serverCodecConfigurer) {
		super(errorAttributes, webProperties.getResources(), applicationContext);
		setMessageReaders(serverCodecConfigurer.getReaders());
		setMessageWriters(serverCodecConfigurer.getWriters());
	}

	@Override
	protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes errorAttributes) {
		return RouterFunctions.route(this::acceptsXml, this::handleErrorAsXml);
	}

	private boolean acceptsXml(ServerRequest request) {
		return request.headers().accept().contains(MediaType.APPLICATION_XML);
	}

	public Mono<ServerResponse> handleErrorAsXml(ServerRequest request) {
		BodyBuilder builder = ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR);
		// ... additional builder calls
		return builder.build();
	}

}
import org.springframework.boot.autoconfigure.web.WebProperties
import org.springframework.boot.autoconfigure.web.reactive.error.AbstractErrorWebExceptionHandler
import org.springframework.boot.web.reactive.error.ErrorAttributes
import org.springframework.context.ApplicationContext
import org.springframework.http.HttpStatus
import org.springframework.http.MediaType
import org.springframework.http.codec.ServerCodecConfigurer
import org.springframework.stereotype.Component
import org.springframework.web.reactive.function.server.RouterFunction
import org.springframework.web.reactive.function.server.RouterFunctions
import org.springframework.web.reactive.function.server.ServerRequest
import org.springframework.web.reactive.function.server.ServerResponse
import reactor.core.publisher.Mono

@Component
class MyErrorWebExceptionHandler(
		errorAttributes: ErrorAttributes, webProperties: WebProperties,
		applicationContext: ApplicationContext, serverCodecConfigurer: ServerCodecConfigurer
) : AbstractErrorWebExceptionHandler(errorAttributes, webProperties.resources, applicationContext) {

	init {
		setMessageReaders(serverCodecConfigurer.readers)
		setMessageWriters(serverCodecConfigurer.writers)
	}

	override fun getRoutingFunction(errorAttributes: ErrorAttributes): RouterFunction<ServerResponse> {
		return RouterFunctions.route(this::acceptsXml, this::handleErrorAsXml)
	}

	private fun acceptsXml(request: ServerRequest): Boolean {
		return request.headers().accept().contains(MediaType.APPLICATION_XML)
	}

	fun handleErrorAsXml(request: ServerRequest): Mono<ServerResponse> {
		val builder = ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR)
		// ... additional builder calls
		return builder.build()
	}

}

为了更完整地了解情况，您也可以直接子类化 DefaultErrorWebExceptionHandler 并覆盖特定方法。

在某些情况下，在控制器级别处理的错误不会被 Web 观察或指标基础设施记录。应用程序可以通过在观察上下文上设置已处理的异常来确保将此类异常记录到观察中。

自定义错误页面

如果您想为给定的状态代码显示自定义 HTML 错误页面，您可以添加从 error/* 解析的视图，例如通过将文件添加到 /error 目录。错误页面可以是静态 HTML（即添加到任何静态资源目录下）或使用模板构建。文件名称应为确切的状态代码、状态代码系列掩码或 error（如果没有任何其他匹配项，则为默认值）。请注意，默认错误视图的路径为 error/error，而使用 Spring MVC 时，默认错误视图为 error。

例如，要将 404 映射到静态 HTML 文件，您的目录结构如下所示

src/
 +- main/
     +- java/
     |   + <source code>
     +- resources/
         +- public/
             +- error/
             |   +- 404.html
             +- <other public assets>

要使用 Mustache 模板映射所有 5xx 错误，您的目录结构如下所示

src/
 +- main/
     +- java/
     |   + <source code>
     +- resources/
         +- templates/
             +- error/
             |   +- 5xx.mustache
             +- <other templates>

Web 过滤器

Spring WebFlux 提供了一个 WebFilter 接口，可以实现它来过滤 HTTP 请求-响应交换。应用程序上下文中找到的 WebFilter bean 将自动用于过滤每个交换。

如果过滤器的顺序很重要，它们可以实现 Ordered 或使用 @Order 注释。Spring Boot 自动配置可能会为您配置 Web 过滤器。在这种情况下，将使用下表中显示的顺序

Web 过滤器 顺序

WebFilterChainProxy（Spring Security）

-100

HttpExchangesWebFilter

Ordered.LOWEST_PRECEDENCE - 10

嵌入式反应式服务器支持

Spring Boot 包含对以下嵌入式反应式 Web 服务器的支持：Reactor Netty、Tomcat、Jetty 和 Undertow。大多数开发人员使用适当的“启动器”来获取完全配置的实例。默认情况下，嵌入式服务器在端口 8080 上监听 HTTP 请求。

自定义反应式服务器

可以使用 Spring Environment 属性配置常见的反应式 Web 服务器设置。通常，您会在 application.properties 或 application.yaml 文件中定义这些属性。

常见的服务器设置包括

  • 网络设置：传入 HTTP 请求的监听端口 (server.port)、要绑定的接口地址 (server.address) 等等。

  • 错误管理：错误页面的位置 (server.error.path) 等等。

  • SSL

  • HTTP 压缩

Spring Boot 尽可能地公开常见的设置，但这并不总是可能的。对于这些情况，专用命名空间（如 server.netty.*）提供了特定于服务器的自定义选项。

有关完整列表，请参阅 ServerProperties 类。

编程自定义

如果您需要以编程方式配置反应式 Web 服务器，可以注册一个实现 WebServerFactoryCustomizer 接口的 Spring bean。WebServerFactoryCustomizer 提供对 ConfigurableReactiveWebServerFactory 的访问，其中包含许多自定义 setter 方法。以下示例显示了以编程方式设置端口

  • Java

  • Kotlin

import org.springframework.boot.web.reactive.server.ConfigurableReactiveWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.stereotype.Component;

@Component
public class MyWebServerFactoryCustomizer implements WebServerFactoryCustomizer<ConfigurableReactiveWebServerFactory> {

	@Override
	public void customize(ConfigurableReactiveWebServerFactory server) {
		server.setPort(9000);
	}

}
import org.springframework.boot.web.server.WebServerFactoryCustomizer
import org.springframework.boot.web.reactive.server.ConfigurableReactiveWebServerFactory
import org.springframework.stereotype.Component

@Component
class MyWebServerFactoryCustomizer : WebServerFactoryCustomizer<ConfigurableReactiveWebServerFactory> {

	override fun customize(server: ConfigurableReactiveWebServerFactory) {
		server.setPort(9000)
	}

}

JettyReactiveWebServerFactory、NettyReactiveWebServerFactory、TomcatReactiveWebServerFactory 和 UndertowReactiveWebServerFactory 是 ConfigurableReactiveWebServerFactory 的专用变体，它们具有用于 Jetty、Reactor Netty、Tomcat 和 Undertow 的额外自定义 setter 方法。以下示例显示了如何自定义 NettyReactiveWebServerFactory，它提供了对 Reactor Netty 特定配置选项的访问

  • Java

  • Kotlin

import java.time.Duration;

import org.springframework.boot.web.embedded.netty.NettyReactiveWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.stereotype.Component;

@Component
public class MyNettyWebServerFactoryCustomizer implements WebServerFactoryCustomizer<NettyReactiveWebServerFactory> {

	@Override
	public void customize(NettyReactiveWebServerFactory factory) {
		factory.addServerCustomizers((server) -> server.idleTimeout(Duration.ofSeconds(20)));
	}

}
import org.springframework.boot.web.embedded.netty.NettyReactiveWebServerFactory
import org.springframework.boot.web.server.WebServerFactoryCustomizer
import org.springframework.stereotype.Component
import java.time.Duration

@Component
class MyNettyWebServerFactoryCustomizer : WebServerFactoryCustomizer<NettyReactiveWebServerFactory> {

	override fun customize(factory: NettyReactiveWebServerFactory) {
		factory.addServerCustomizers({ server -> server.idleTimeout(Duration.ofSeconds(20)) })
	}

}

直接自定义 ConfigurableReactiveWebServerFactory

对于需要从 ReactiveWebServerFactory 扩展的更高级用例，您可以自己公开此类类型的 bean。

为许多配置选项提供了 setter。如果您需要执行更奇特的操作，还提供了几个受保护的“钩子”方法。有关详细信息，请参阅 源代码文档。

自动配置的自定义程序仍然会应用于您的自定义工厂，因此请谨慎使用该选项。

响应式服务器资源配置

在自动配置 Reactor Netty 或 Jetty 服务器时，Spring Boot 将创建特定 bean，这些 bean 将向服务器实例提供 HTTP 资源：ReactorResourceFactory 或 JettyResourceFactory。

默认情况下，这些资源也将与 Reactor Netty 和 Jetty 客户端共享，以实现最佳性能，因为

  • 服务器和客户端使用相同的技术

  • 客户端实例使用 Spring Boot 自动配置的 WebClient.Builder bean 构建

开发人员可以通过提供自定义的 ReactorResourceFactory 或 JettyResourceFactory bean 来覆盖 Jetty 和 Reactor Netty 的资源配置 - 这将应用于客户端和服务器。

您可以在 WebClient 运行时部分 中了解有关客户端资源配置的更多信息。