WebFlux 配置

参见 Servlet 堆栈中的等效项

WebFlux Java 配置声明了处理带注解的控制器或功能端点的请求所需的组件，并提供了一个 API 来自定义配置。这意味着您无需了解 Java 配置创建的底层 bean。但是，如果您想了解它们，可以在 WebFluxConfigurationSupport 中查看它们，或阅读有关它们是什么的更多信息，请参阅特殊 Bean 类型。

对于配置 API 中不可用的更高级的自定义，您可以通过高级配置模式完全控制配置。

启用 WebFlux 配置

参见 Servlet 堆栈中的等效项

您可以在 Java 配置中使用 @EnableWebFlux 注解，如下例所示

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig {
}

@Configuration
@EnableWebFlux
class WebConfig

上面的示例注册了一些 Spring WebFlux 基础设施 Bean，并适应类路径上可用的依赖项——例如 JSON、XML 等。

WebFlux 配置 API

参见 Servlet 堆栈中的等效项

在您的 Java 配置中，您可以实现 WebFluxConfigurer 接口，如下例所示

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	// Implement configuration methods...
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	// Implement configuration methods...
}

转换、格式化

参见 Servlet 堆栈中的等效项

默认情况下，会安装各种数字和日期类型的格式化程序，以及通过字段上的 @NumberFormat 和 @DateTimeFormat 进行自定义的支持。

要在 Java 配置中注册自定义格式化程序和转换器，请使用以下方法

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void addFormatters(FormatterRegistry registry) {
		// ...
	}

}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun addFormatters(registry: FormatterRegistry) {
		// ...
	}
}

默认情况下，Spring WebFlux 在解析和格式化日期值时会考虑请求区域设置。这适用于日期以字符串形式表示并使用“input”表单字段的表单。但是，对于“date”和“time”表单字段，浏览器使用 HTML 规范中定义的固定格式。对于此类情况，可以按如下方式自定义日期和时间格式

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void addFormatters(FormatterRegistry registry) {
		DateTimeFormatterRegistrar registrar = new DateTimeFormatterRegistrar();
		registrar.setUseIsoFormat(true);
		registrar.registerFormatters(registry);
     	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun addFormatters(registry: FormatterRegistry) {
		val registrar = DateTimeFormatterRegistrar()
		registrar.setUseIsoFormat(true)
		registrar.registerFormatters(registry)
	}
}

有关何时使用 FormatterRegistrar 实现的更多信息，请参阅 FormatterRegistrar SPI 和 FormattingConversionServiceFactoryBean。

验证

参见 Servlet 堆栈中的等效项

默认情况下，如果类路径上存在 Bean Validation（例如，Hibernate Validator），则 LocalValidatorFactoryBean 将注册为全局验证器，用于与 @Controller 方法参数上的 @Valid 和 @Validated 一起使用。

在您的 Java 配置中，您可以自定义全局 Validator 实例，如下例所示

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public Validator getValidator() {
		// ...
	}

}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun getValidator(): Validator {
		// ...
	}

}

请注意，您也可以在本地注册 Validator 实现，如下例所示

Java
Kotlin

@Controller
public class MyController {

	@InitBinder
	protected void initBinder(WebDataBinder binder) {
		binder.addValidators(new FooValidator());
	}

}

@Controller
class MyController {

	@InitBinder
	protected fun initBinder(binder: WebDataBinder) {
		binder.addValidators(FooValidator())
	}
}

如果您需要在某个地方注入 LocalValidatorFactoryBean，请创建一个 Bean 并用 @Primary 标记它，以避免与 MVC 配置中声明的 Bean 发生冲突。

内容类型解析器

参见 Servlet 堆栈中的等效项

您可以配置 Spring WebFlux 如何从请求中确定 @Controller 实例的请求媒体类型。默认情况下，只检查 Accept 标头，但您也可以启用基于查询参数的策略。

以下示例展示了如何自定义请求内容类型解析

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder) {
		// ...
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun configureContentTypeResolver(builder: RequestedContentTypeResolverBuilder) {
		// ...
	}
}

HTTP 消息编解码器

参见 Servlet 堆栈中的等效项

以下示例展示了如何自定义请求和响应主体如何读取和写入

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void configureHttpMessageCodecs(ServerCodecConfigurer configurer) {
		configurer.defaultCodecs().maxInMemorySize(512 * 1024);
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun configureHttpMessageCodecs(configurer: ServerCodecConfigurer) {
		// ...
	}
}

ServerCodecConfigurer 提供了一组默认的读取器和写入器。您可以使用它来添加更多读取器和写入器、自定义默认读取器和写入器，或完全替换默认读取器和写入器。

对于 Jackson JSON 和 XML，请考虑使用 Jackson2ObjectMapperBuilder，它使用以下属性自定义 Jackson 的默认属性

DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES 已禁用。
MapperFeature.DEFAULT_VIEW_INCLUSION 已禁用。

它还会自动注册以下知名模块（如果在类路径中检测到它们）

jackson-datatype-joda: 支持 Joda-Time 类型。
jackson-datatype-jsr310: 支持 Java 8 日期和时间 API 类型。
jackson-datatype-jdk8: 支持其他 Java 8 类型，例如 Optional。
jackson-module-kotlin: 支持 Kotlin 类和数据类。

视图解析器

参见 Servlet 堆栈中的等效项

以下示例展示了如何配置视图解析

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {
		// ...
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun configureViewResolvers(registry: ViewResolverRegistry) {
		// ...
	}
}

ViewResolverRegistry 为 Spring 框架集成的视图技术提供了快捷方式。以下示例使用 FreeMarker（这也需要配置底层的 FreeMarker 视图技术）

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {


	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {
		registry.freeMarker();
	}

	// Configure Freemarker...

	@Bean
	public FreeMarkerConfigurer freeMarkerConfigurer() {
		FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
		configurer.setTemplateLoaderPath("classpath:/templates");
		return configurer;
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun configureViewResolvers(registry: ViewResolverRegistry) {
		registry.freeMarker()
	}

	// Configure Freemarker...

	@Bean
	fun freeMarkerConfigurer() = FreeMarkerConfigurer().apply {
		setTemplateLoaderPath("classpath:/templates")
	}
}

您也可以插入任何 ViewResolver 实现，如下例所示

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {


	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {
		ViewResolver resolver = ... ;
		registry.viewResolver(resolver);
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun configureViewResolvers(registry: ViewResolverRegistry) {
		val resolver: ViewResolver = ...
		registry.viewResolver(resolver
	}
}

为了支持内容协商并通过视图解析渲染其他格式（除了 HTML），您可以根据 HttpMessageWriterView 实现配置一个或多个默认视图，该实现接受来自 spring-web 的任何可用编解码器。以下示例展示了如何做到这一点

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {


	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {
		registry.freeMarker();

		Jackson2JsonEncoder encoder = new Jackson2JsonEncoder();
		registry.defaultViews(new HttpMessageWriterView(encoder));
	}

	// ...
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {


	override fun configureViewResolvers(registry: ViewResolverRegistry) {
		registry.freeMarker()

		val encoder = Jackson2JsonEncoder()
		registry.defaultViews(HttpMessageWriterView(encoder))
	}

	// ...
}

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

静态资源

参见 Servlet 堆栈中的等效项

此选项提供了一种便捷的方式，可以从 Resource 为基础的位置列表中提供静态资源。

在以下示例中，给定一个以 /resources 开头的请求，相对路径用于查找和提供相对于类路径上的 /static 的静态资源。资源以一年后的未来过期时间提供，以确保最大限度地利用浏览器缓存并减少浏览器发出的 HTTP 请求。Last-Modified 标头也会被评估，如果存在，则返回 304 状态代码。以下清单展示了该示例

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/resources/**")
				.addResourceLocations("/public", "classpath:/static/")
				.setCacheControl(CacheControl.maxAge(365, TimeUnit.DAYS));
	}

}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun addResourceHandlers(registry: ResourceHandlerRegistry) {
		registry.addResourceHandler("/resources/**")
				.addResourceLocations("/public", "classpath:/static/")
				.setCacheControl(CacheControl.maxAge(365, TimeUnit.DAYS))
	}
}

另请参见静态资源的 HTTP 缓存支持。

资源处理程序还支持 ResourceResolver 实现和 ResourceTransformer 实现的链，这些实现可用于创建用于处理优化资源的工具链。

您可以使用 VersionResourceResolver 为基于从内容计算的 MD5 哈希、固定应用程序版本或其他信息的版本化资源 URL。ContentVersionStrategy（MD5 哈希）是一个不错的选择，但也有一些值得注意的例外情况（例如与模块加载器一起使用的 JavaScript 资源）。

以下示例展示如何在 Java 配置中使用 VersionResourceResolver。

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		registry.addResourceHandler("/resources/**")
				.addResourceLocations("/public/")
				.resourceChain(true)
				.addResolver(new VersionResourceResolver().addContentVersionStrategy("/**"));
	}

}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun addResourceHandlers(registry: ResourceHandlerRegistry) {
		registry.addResourceHandler("/resources/**")
				.addResourceLocations("/public/")
				.resourceChain(true)
				.addResolver(VersionResourceResolver().addContentVersionStrategy("/**"))
	}

}

您可以使用 ResourceUrlProvider 重写 URL 并应用完整的解析器和转换器链（例如，插入版本）。WebFlux 配置提供了一个 ResourceUrlProvider，以便它可以被注入到其他地方。

与 Spring MVC 不同，目前在 WebFlux 中，没有办法透明地重写静态资源 URL，因为没有视图技术可以使用非阻塞的解析器和转换器链。当只提供本地资源时，解决方法是直接使用 ResourceUrlProvider（例如，通过自定义元素）并阻塞。

请注意，当同时使用 EncodedResourceResolver（例如，Gzip、Brotli 编码）和 VersionedResourceResolver 时，必须按此顺序注册它们，以确保基于内容的版本始终基于未编码文件可靠地计算。

对于 WebJars，像 /webjars/jquery/1.2.0/jquery.min.js 这样的版本化 URL 是使用它们的推荐方法，也是最有效的方法。相关资源位置在 Spring Boot 中开箱即用地配置（或者可以通过 ResourceHandlerRegistry 手动配置），不需要添加 org.webjars:webjars-locator-core 依赖项。

无版本 URL，例如 /webjars/jquery/jquery.min.js，通过 WebJarsResourceResolver 支持，该解析器在类路径上存在 org.webjars:webjars-locator-core 库时自动注册，但会以类路径扫描为代价，这可能会减慢应用程序启动速度。解析器可以重写 URL 以包含 jar 的版本，也可以匹配没有版本的传入 URL——例如，从 /webjars/jquery/jquery.min.js 到 /webjars/jquery/1.2.0/jquery.min.js。

基于 ResourceHandlerRegistry 的 Java 配置提供了更多选项，用于进行细粒度的控制，例如最后修改行为和优化的资源解析。

路径匹配

参见 Servlet 堆栈中的等效项

您可以自定义与路径匹配相关的选项。有关各个选项的详细信息，请参阅 PathMatchConfigurer javadoc。以下示例展示如何使用 PathMatchConfigurer。

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void configurePathMatch(PathMatchConfigurer configurer) {
		configurer.addPathPrefix(
				"/api", HandlerTypePredicate.forAnnotation(RestController.class));
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	@Override
	fun configurePathMatch(configurer: PathMatchConfigurer) {
		configurer.addPathPrefix(
				"/api", HandlerTypePredicate.forAnnotation(RestController::class.java))
	}
}

Spring WebFlux 依赖于请求路径的解析表示形式，称为 RequestPath，用于访问解码的路径段值，并删除分号内容（即路径或矩阵变量）。这意味着，与 Spring MVC 不同，您不需要指定是否解码请求路径，也不需要指定是否删除分号内容以用于路径匹配目的。

Spring WebFlux 不支持后缀模式匹配，这与 Spring MVC 不同，在 Spring MVC 中，我们也建议避免依赖这种方式。

阻塞执行

WebFlux Java 配置允许您自定义 WebFlux 中的阻塞执行。

您可以通过提供一个 AsyncTaskExecutor（例如 VirtualThreadTaskExecutor）来让阻塞控制器方法在单独的线程上执行，如下所示

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void configureBlockingExecution(BlockingExecutionConfigurer configurer) {
		AsyncTaskExecutor executor = ...
		configurer.setExecutor(executor);
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	@Override
	fun configureBlockingExecution(configurer: BlockingExecutionConfigurer) {
		val executor = ...
		configurer.setExecutor(executor)
	}
}

默认情况下，返回值类型未被配置的 ReactiveAdapterRegistry 识别的控制器方法被视为阻塞方法，但您可以通过 BlockingExecutionConfigurer 设置自定义的控制器方法谓词。

WebSocketService

WebFlux Java 配置声明了一个 WebSocketHandlerAdapter bean，它为调用 WebSocket 处理程序提供支持。这意味着，为了处理 WebSocket 握手请求，您只需要通过 SimpleUrlHandlerMapping 将一个 WebSocketHandler 映射到一个 URL。

在某些情况下，可能需要使用提供的 WebSocketService 服务创建 WebSocketHandlerAdapter bean，该服务允许配置 WebSocket 服务器属性。例如

Java
Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public WebSocketService getWebSocketService() {
		TomcatRequestUpgradeStrategy strategy = new TomcatRequestUpgradeStrategy();
		strategy.setMaxSessionIdleTimeout(0L);
		return new HandshakeWebSocketService(strategy);
	}
}

@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	@Override
	fun webSocketService(): WebSocketService {
		val strategy = TomcatRequestUpgradeStrategy().apply {
			setMaxSessionIdleTimeout(0L)
		}
		return HandshakeWebSocketService(strategy)
	}
}

高级配置模式

参见 Servlet 堆栈中的等效项

@EnableWebFlux 导入 DelegatingWebFluxConfiguration，它

为 WebFlux 应用程序提供默认的 Spring 配置
检测并委托给 WebFluxConfigurer 实现以自定义该配置。

对于高级模式，您可以删除 @EnableWebFlux，并直接从 DelegatingWebFluxConfiguration 扩展，而不是实现 WebFluxConfigurer，如下面的示例所示

Java
Kotlin

@Configuration
public class WebConfig extends DelegatingWebFluxConfiguration {

	// ...
}

@Configuration
class WebConfig : DelegatingWebFluxConfiguration {

	// ...
}

您可以保留 WebConfig 中的现有方法，但现在您也可以覆盖基类中的 bean 声明，并且仍然可以在类路径中拥有任意数量的其他 WebMvcConfigurer 实现。