跳到主要内容

响应式 Web 应用程序

DeepSeek V3 中英对照 Reactive Web Applications

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

Spring WebFlux 框架​

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

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

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);
    }

}
java

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

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

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();
    }

}
java
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) {
        ...
    }

}
java

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

提示

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

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

备注

在应用程序中同时添加 spring-boot-starter-web 和 spring-boot-starter-webflux 模块会导致 Spring Boot 自动配置 Spring MVC，而不是 WebFlux。选择这种行为是因为许多 Spring 开发者会在他们的 Spring MVC 应用程序中添加 spring-boot-starter-webflux 以使用反应式的 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.dateofLocalizedDate(FormatStyle.SHORT)java.util.Date 和 LocalDate
spring.webflux.format.timeofLocalizedTime(FormatStyle.SHORT)java.time 的 LocalTime 和 OffsetTime
spring.webflux.format.date-timeofLocalizedDateTime(FormatStyle.SHORT)java.time 的 LocalDateTime, OffsetDateTime, 和 ZonedDateTime

使用 HttpMessageReaders 和 HttpMessageWriters 的 HTTP 编解码器​

Spring WebFlux 使用 HttpMessageReader 和 HttpMessageWriter 接口来转换 HTTP 请求和响应。它们通过 CodecConfigurer 进行配置，以根据类路径中可用的库来设置合理的默认值。

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

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

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());
            // ...
        };
    }

}
java

静态内容​

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

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

spring.webflux.static-path-pattern=/resources/**
properties

你也可以通过使用 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 的顺序定义，默认顺序如下：

org.springframework.web.reactive.function.server.support.RouterFunctionMapping使用 RouterFunction 声明的端点
org.springframework.web.reactive.result.method.annotation.RequestMappingHandlerMapping在 @Controller 中声明的端点
RouterFunctionMapping 用于欢迎页面欢迎页面支持

模板引擎​

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

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

备注

并非所有的 FreeMarker 特性都在 WebFlux 中得到支持。更多详细信息，请查看每个属性的描述。

当你使用这些模板引擎并采用默认配置时，你的模板会自动从 src/main/resources/templates 目录中获取。

错误处理​

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

在直接定制 Spring Boot 中的错误处理之前，你可以利用 Spring WebFlux 中的 RFC 9457 Problem Details 支持。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"
}
json

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

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

要更改错误处理行为，你可以实现 ErrorWebExceptionHandler 并注册该类型的 Bean 定义。由于 ErrorWebExceptionHandler 是一个相当底层的接口，Spring Boot 还提供了一个方便的 AbstractErrorWebExceptionHandler，允许你以 WebFlux 函数式的方式处理错误，如下例所示：

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();
    }

}
java

为了获得更完整的解决方案，你也可以直接子类化 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>
none

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

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

Web 过滤器​

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

在过滤器顺序重要的情况下，它们可以实现 Ordered 或被注解为 @Order。Spring Boot 自动配置可能会为你配置 Web 过滤器。当它这样做时，将使用下表中显示的顺序：

Web 过滤器顺序
WebFilterChainProxy (Spring Security)-100
HttpExchangesWebFilterOrdered.LOWEST_PRECEDENCE - 10

嵌入式响应式服务器支持​

Spring Boot 包含对以下嵌入式响应式 Web 服务器的支持：Reactor Netty、Tomcat、Jetty 和 Undertow。大多数开发者使用相应的 starter 来获取一个完全配置的实例。默认情况下，嵌入式服务器在端口 8080 上监听 HTTP 请求。

自定义响应式服务器​

常见的响应式 Web 服务器设置可以通过使用 Spring Environment 属性进行配置。通常，你可以在 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 方法。以下示例展示了如何以编程方式设置端口：

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);
    }

}
java

JettyReactiveWebServerFactory、NettyReactiveWebServerFactory、TomcatReactiveWebServerFactory 和 UndertowReactiveWebServerFactory 是 ConfigurableReactiveWebServerFactory 的专用变体，它们分别提供了针对 Jetty、Reactor Netty、Tomcat 和 Undertow 的额外自定义设置方法。以下示例展示了如何自定义 NettyReactiveWebServerFactory，该工厂提供了访问 Reactor Netty 特定配置选项的功能：

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)));
    }

}
java

直接自定义 ConfigurableReactiveWebServerFactory​

对于更高级的用例，如果需要从 ReactiveWebServerFactory 扩展，你可以自行暴露一个该类型的 bean。

提供了许多配置选项的设置器。如果您需要执行更复杂的操作，还提供了一些受保护的“钩子”方法。详情请参阅 ConfigurableReactiveWebServerFactory API 文档。

备注

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

响应式服务器资源配置​

在自动配置 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 Runtime 部分了解更多关于客户端资源配置的信息。