功能端点

Spring WebFlux 包括 WebFlux.fn,这是一种轻量级的函数式编程模型,其中函数用于路由和处理请求,并且契约设计为不可变的。它是基于注解的编程模型的替代方案,但在其他方面运行在相同的响应式核心基础上。

概述

在 WebFlux.fn 中,HTTP 请求由HandlerFunction处理:一个接收ServerRequest并返回延迟的ServerResponse(即Mono<ServerResponse>)的函数。请求和响应对象都具有不可变的契约,这些契约提供对 HTTP 请求和响应的 JDK 8 友好访问。HandlerFunction相当于基于注解的编程模型中@RequestMapping方法的主体。

传入请求通过RouterFunction路由到处理程序函数:一个接收ServerRequest并返回延迟的HandlerFunction(即Mono<HandlerFunction>)的函数。当路由器函数匹配时,将返回一个处理程序函数;否则为一个空的 Mono。RouterFunction相当于@RequestMapping注解,但主要区别在于路由器函数不仅提供数据,还提供行为。

RouterFunctions.route()提供了一个路由器构建器,它有助于创建路由器,如下例所示

  • Java

  • Kotlin

import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.web.reactive.function.server.RequestPredicates.*;
import static org.springframework.web.reactive.function.server.RouterFunctions.route;

PersonRepository repository = ...
PersonHandler handler = new PersonHandler(repository);

RouterFunction<ServerResponse> route = route() (1)
	.GET("/person/{id}", accept(APPLICATION_JSON), handler::getPerson)
	.GET("/person", accept(APPLICATION_JSON), handler::listPeople)
	.POST("/person", handler::createPerson)
	.build();


public class PersonHandler {

	// ...

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

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

	public Mono<ServerResponse> getPerson(ServerRequest request) {
		// ...
	}
}
1 使用route()创建路由器。
val repository: PersonRepository = ...
val handler = PersonHandler(repository)

val route = coRouter { (1)
	accept(APPLICATION_JSON).nest {
		GET("/person/{id}", handler::getPerson)
		GET("/person", handler::listPeople)
	}
	POST("/person", handler::createPerson)
}


class PersonHandler(private val repository: PersonRepository) {

	// ...

	suspend fun listPeople(request: ServerRequest): ServerResponse {
		// ...
	}

	suspend fun createPerson(request: ServerRequest): ServerResponse {
		// ...
	}

	suspend fun getPerson(request: ServerRequest): ServerResponse {
		// ...
	}
}
1 使用协程路由器 DSL 创建路由器;通过router { }还可以使用响应式替代方案。

运行RouterFunction的一种方法是将其转换为HttpHandler并通过内置的服务器适配器之一进行安装

  • RouterFunctions.toHttpHandler(RouterFunction)

  • RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)

大多数应用程序可以通过 WebFlux Java 配置运行,请参阅运行服务器

HandlerFunction

ServerRequestServerResponse是不可变的接口,提供对 HTTP 请求和响应的 JDK 8 友好访问。请求和响应都对主体流提供Reactive Streams背压。请求体由 Reactor FluxMono表示。响应体由任何 Reactive Streams Publisher表示,包括FluxMono。有关更多信息,请参阅响应式库

ServerRequest

ServerRequest提供对 HTTP 方法、URI、标头和查询参数的访问,而对主体的访问则通过body方法提供。

以下示例将请求体提取到Mono<String>

  • Java

  • Kotlin

Mono<String> string = request.bodyToMono(String.class);
val string = request.awaitBody<String>()

以下示例将主体提取到Flux<Person>(或 Kotlin 中的Flow<Person>)中,其中Person对象从某种序列化形式(例如 JSON 或 XML)解码

  • Java

  • Kotlin

Flux<Person> people = request.bodyToFlux(Person.class);
val people = request.bodyToFlow<Person>()

前面的示例是使用更通用的ServerRequest.body(BodyExtractor)的快捷方式,它接受BodyExtractor函数式策略接口。实用程序类BodyExtractors提供对许多实例的访问。例如,前面的示例也可以写成如下所示

  • Java

  • Kotlin

Mono<String> string = request.body(BodyExtractors.toMono(String.class));
Flux<Person> people = request.body(BodyExtractors.toFlux(Person.class));
	val string = request.body(BodyExtractors.toMono(String::class.java)).awaitSingle()
	val people = request.body(BodyExtractors.toFlux(Person::class.java)).asFlow()

以下示例显示了如何访问表单数据

  • Java

  • Kotlin

Mono<MultiValueMap<String, String>> map = request.formData();
val map = request.awaitFormData()

以下示例显示了如何将多部分数据作为映射访问

  • Java

  • Kotlin

Mono<MultiValueMap<String, Part>> map = request.multipartData();
val map = request.awaitMultipartData()

以下示例显示了如何以流式方式逐个访问多部分数据

  • Java

  • Kotlin

Flux<PartEvent> allPartEvents = request.bodyToFlux(PartEvent.class);
allPartsEvents.windowUntil(PartEvent::isLast)
      .concatMap(p -> p.switchOnFirst((signal, partEvents) -> {
          if (signal.hasValue()) {
              PartEvent event = signal.get();
              if (event instanceof FormPartEvent formEvent) {
                  String value = formEvent.value();
                  // handle form field
              }
              else if (event instanceof FilePartEvent fileEvent) {
                  String filename = fileEvent.filename();
                  Flux<DataBuffer> contents = partEvents.map(PartEvent::content);
                  // handle file upload
              }
              else {
                  return Mono.error(new RuntimeException("Unexpected event: " + event));
              }
          }
          else {
              return partEvents; // either complete or error signal
          }
      }));
val parts = request.bodyToFlux<PartEvent>()
allPartsEvents.windowUntil(PartEvent::isLast)
    .concatMap {
        it.switchOnFirst { signal, partEvents ->
            if (signal.hasValue()) {
                val event = signal.get()
                if (event is FormPartEvent) {
                    val value: String = event.value();
                    // handle form field
                } else if (event is FilePartEvent) {
                    val filename: String = event.filename();
                    val contents: Flux<DataBuffer> = partEvents.map(PartEvent::content);
                    // handle file upload
                } else {
                    return Mono.error(RuntimeException("Unexpected event: " + event));
                }
            } else {
                return partEvents; // either complete or error signal
            }
        }
    }
}

请注意,必须完全使用、转发或释放PartEvent对象的正文内容,以避免内存泄漏。

ServerResponse

ServerResponse提供对 HTTP 响应的访问,并且由于它是不可变的,因此可以使用build方法创建它。您可以使用构建器设置响应状态、添加响应标头或提供主体。以下示例创建了一个带有 JSON 内容的 200(OK)响应

  • Java

  • Kotlin

Mono<Person> person = ...
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(person, Person.class);
val person: Person = ...
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).bodyValue(person)

以下示例显示了如何构建一个带有Location标头且没有主体的 201(CREATED)响应

  • Java

  • Kotlin

URI location = ...
ServerResponse.created(location).build();
val location: URI = ...
ServerResponse.created(location).build()

根据使用的编解码器,可以传递提示参数以自定义主体如何序列化或反序列化。例如,要指定Jackson JSON 视图

  • Java

  • Kotlin

ServerResponse.ok().hint(Jackson2CodecSupport.JSON_VIEW_HINT, MyJacksonView.class).body(...);
ServerResponse.ok().hint(Jackson2CodecSupport.JSON_VIEW_HINT, MyJacksonView::class.java).body(...)

处理程序类

我们可以将处理程序函数编写为 lambda,如下例所示

  • Java

  • Kotlin

HandlerFunction<ServerResponse> helloWorld =
  request -> ServerResponse.ok().bodyValue("Hello World");
val helloWorld = HandlerFunction<ServerResponse> { ServerResponse.ok().bodyValue("Hello World") }

这很方便,但在应用程序中我们需要多个函数,并且多个内联 lambda 会变得很混乱。因此,将相关的处理程序函数组合到处理程序类中很有用,它在基于注解的应用程序中具有与@Controller类似的作用。例如,以下类公开了响应式的Person存储库

  • Java

  • Kotlin

import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.web.reactive.function.server.ServerResponse.ok;

public class PersonHandler {

	private final PersonRepository repository;

	public PersonHandler(PersonRepository repository) {
		this.repository = repository;
	}

	public Mono<ServerResponse> listPeople(ServerRequest request) { (1)
		Flux<Person> people = repository.allPeople();
		return ok().contentType(APPLICATION_JSON).body(people, Person.class);
	}

	public Mono<ServerResponse> createPerson(ServerRequest request) { (2)
		Mono<Person> person = request.bodyToMono(Person.class);
		return ok().build(repository.savePerson(person));
	}

	public Mono<ServerResponse> getPerson(ServerRequest request) { (3)
		int personId = Integer.valueOf(request.pathVariable("id"));
		return repository.getPerson(personId)
			.flatMap(person -> ok().contentType(APPLICATION_JSON).bodyValue(person))
			.switchIfEmpty(ServerResponse.notFound().build());
	}
}
1 listPeople是一个处理程序函数,它将存储库中找到的所有Person对象作为 JSON 返回。

2 createPerson 是一个处理程序函数,用于存储请求体中包含的新 Person。请注意,PersonRepository.savePerson(Person) 返回 Mono<Void>:一个空 Mono,在从请求中读取并存储人员后发出完成信号。因此,我们使用 build(Publisher<Void>) 方法在收到该完成信号时(即,当 Person 已保存时)发送响应。
3 getPerson 是一个处理程序函数,用于返回单个人员,由 id 路径变量标识。我们从存储库中检索该 Person 并创建一个 JSON 响应(如果找到)。如果未找到,我们使用 switchIfEmpty(Mono<T>) 返回 404 未找到响应。
class PersonHandler(private val repository: PersonRepository) {

	suspend fun listPeople(request: ServerRequest): ServerResponse { (1)
		val people: Flow<Person> = repository.allPeople()
		return ok().contentType(APPLICATION_JSON).bodyAndAwait(people);
	}

	suspend fun createPerson(request: ServerRequest): ServerResponse { (2)
		val person = request.awaitBody<Person>()
		repository.savePerson(person)
		return ok().buildAndAwait()
	}

	suspend fun getPerson(request: ServerRequest): ServerResponse { (3)
		val personId = request.pathVariable("id").toInt()
		return repository.getPerson(personId)?.let { ok().contentType(APPLICATION_JSON).bodyValueAndAwait(it) }
				?: ServerResponse.notFound().buildAndAwait()

	}
}
1 listPeople是一个处理程序函数,它将存储库中找到的所有Person对象作为 JSON 返回。

2 createPerson 是一个处理程序函数,用于存储请求体中包含的新 Person。请注意,PersonRepository.savePerson(Person) 是一个没有返回类型的挂起函数。
3 getPerson 是一个处理程序函数,用于返回单个人员,由 id 路径变量标识。我们从存储库中检索该 Person 并创建一个 JSON 响应(如果找到)。如果未找到,我们返回 404 未找到响应。

验证

功能性端点可以使用 Spring 的 验证功能 对请求体应用验证。例如,给定 Person 的自定义 Spring Validator 实现

  • Java

  • Kotlin

public class PersonHandler {

	private final Validator validator = new PersonValidator(); (1)

	// ...

	public Mono<ServerResponse> createPerson(ServerRequest request) {
		Mono<Person> person = request.bodyToMono(Person.class).doOnNext(this::validate); (2)
		return ok().build(repository.savePerson(person));
	}

	private void validate(Person person) {
		Errors errors = new BeanPropertyBindingResult(person, "person");
		validator.validate(person, errors);
		if (errors.hasErrors()) {
			throw new ServerWebInputException(errors.toString()); (3)
		}
	}
}
1 创建 Validator 实例。
2 应用验证。
3 为 400 响应引发异常。
class PersonHandler(private val repository: PersonRepository) {

	private val validator = PersonValidator() (1)

	// ...

	suspend fun createPerson(request: ServerRequest): ServerResponse {
		val person = request.awaitBody<Person>()
		validate(person) (2)
		repository.savePerson(person)
		return ok().buildAndAwait()
	}

	private fun validate(person: Person) {
		val errors: Errors = BeanPropertyBindingResult(person, "person");
		validator.validate(person, errors);
		if (errors.hasErrors()) {
			throw ServerWebInputException(errors.toString()) (3)
		}
	}
}
1 创建 Validator 实例。
2 应用验证。
3 为 400 响应引发异常。

处理程序还可以通过创建和注入基于 LocalValidatorFactoryBean 的全局 Validator 实例来使用标准 Bean 验证 API(JSR-303)。请参阅 Spring 验证

RouterFunction

路由函数用于将请求路由到相应的 HandlerFunction。通常,您不会自己编写路由函数,而是使用 RouterFunctions 实用程序类上的方法来创建一个。RouterFunctions.route()(无参数)为您提供了一个用于创建路由函数的流畅构建器,而 RouterFunctions.route(RequestPredicate, HandlerFunction) 提供了一种直接创建路由器的方法。

通常,建议使用 route() 构建器,因为它为典型的映射场景提供了方便的快捷方式,而无需难以发现的静态导入。例如,路由函数构建器提供了 GET(String, HandlerFunction) 方法来创建 GET 请求的映射;以及 POST(String, HandlerFunction) 用于 POST 请求。

除了基于 HTTP 方法的映射之外,路由构建器还提供了一种在映射到请求时引入其他谓词的方法。对于每种 HTTP 方法,都有一种重载变体采用 RequestPredicate 作为参数,可以通过它表达其他约束。

谓词

您可以编写自己的 RequestPredicate,但 RequestPredicates 实用程序类提供了常用的实现,基于请求路径、HTTP 方法、内容类型等。以下示例使用请求谓词基于 Accept 标头创建约束

  • Java

  • Kotlin

RouterFunction<ServerResponse> route = RouterFunctions.route()
	.GET("/hello-world", accept(MediaType.TEXT_PLAIN),
		request -> ServerResponse.ok().bodyValue("Hello World")).build();
val route = coRouter {
	GET("/hello-world", accept(TEXT_PLAIN)) {
		ServerResponse.ok().bodyValueAndAwait("Hello World")
	}
}

您可以通过使用以下方法将多个请求谓词组合在一起

  • RequestPredicate.and(RequestPredicate) – 两个都必须匹配。

  • RequestPredicate.or(RequestPredicate) – 任何一个都可以匹配。

RequestPredicates 中的许多谓词都是组合的。例如,RequestPredicates.GET(String)RequestPredicates.method(HttpMethod)RequestPredicates.path(String) 组合而成。上面显示的示例也使用了两个请求谓词,因为构建器在内部使用 RequestPredicates.GET,并将其与 accept 谓词组合。

路由

路由函数按顺序评估:如果第一个路由不匹配,则评估第二个路由,依此类推。因此,在通用路由之前声明更具体的路由是有意义的。这在将路由函数注册为 Spring Bean 时也很重要,这将在后面介绍。请注意,此行为与基于注解的编程模型不同,在基于注解的编程模型中,会自动选择“最具体”的控制器方法。

使用路由函数构建器时,所有定义的路由都组合成一个 RouterFunction,该函数从 build() 返回。还有其他方法可以将多个路由函数组合在一起

  • RouterFunctions.route() 构建器上的 add(RouterFunction)

  • RouterFunction.and(RouterFunction)

  • RouterFunction.andRoute(RequestPredicate, HandlerFunction)RouterFunction.and() 与嵌套 RouterFunctions.route() 的快捷方式。

以下示例显示了四个路由的组合

  • Java

  • Kotlin

import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.web.reactive.function.server.RequestPredicates.*;

PersonRepository repository = ...
PersonHandler handler = new PersonHandler(repository);

RouterFunction<ServerResponse> otherRoute = ...

RouterFunction<ServerResponse> route = route()
	.GET("/person/{id}", accept(APPLICATION_JSON), handler::getPerson) (1)
	.GET("/person", accept(APPLICATION_JSON), handler::listPeople) (2)
	.POST("/person", handler::createPerson) (3)
	.add(otherRoute) (4)
	.build();
1 GET /person/{id} 以及与 JSON 匹配的 Accept 标头将路由到 PersonHandler.getPerson
2 GET /person 以及与 JSON 匹配的 Accept 标头将路由到 PersonHandler.listPeople
3 POST /person 没有其他谓词将映射到 PersonHandler.createPerson,以及
4 otherRoute 是在其他地方创建并添加到构建的路由中的路由函数。
import org.springframework.http.MediaType.APPLICATION_JSON

val repository: PersonRepository = ...
val handler = PersonHandler(repository);

val otherRoute: RouterFunction<ServerResponse> = coRouter {  }

val route = coRouter {
	GET("/person/{id}", accept(APPLICATION_JSON), handler::getPerson) (1)
	GET("/person", accept(APPLICATION_JSON), handler::listPeople) (2)
	POST("/person", handler::createPerson) (3)
}.and(otherRoute) (4)
1 GET /person/{id} 以及与 JSON 匹配的 Accept 标头将路由到 PersonHandler.getPerson
2 GET /person 以及与 JSON 匹配的 Accept 标头将路由到 PersonHandler.listPeople
3 POST /person 没有其他谓词将映射到 PersonHandler.createPerson,以及
4 otherRoute 是在其他地方创建并添加到构建的路由中的路由函数。

嵌套路由

一组路由函数通常具有共享的谓词,例如共享路径。在上面的示例中,共享谓词将是一个与 /person 匹配的路径谓词,三个路由都使用它。使用注解时,您可以通过使用映射到 /person 的类型级 @RequestMapping 注解来消除此重复。在 WebFlux.fn 中,路径谓词可以通过路由函数构建器上的 path 方法共享。例如,上面示例的最后几行可以通过使用嵌套路由以以下方式改进

  • Java

  • Kotlin

RouterFunction<ServerResponse> route = route()
	.path("/person", builder -> builder (1)
		.GET("/{id}", accept(APPLICATION_JSON), handler::getPerson)
		.GET(accept(APPLICATION_JSON), handler::listPeople)
		.POST(handler::createPerson))
	.build();
1 请注意,path 的第二个参数是一个采用路由构建器的消费者。
val route = coRouter { (1)
	"/person".nest {
		GET("/{id}", accept(APPLICATION_JSON), handler::getPerson)
		GET(accept(APPLICATION_JSON), handler::listPeople)
		POST(handler::createPerson)
	}
}
1 使用协程路由器 DSL 创建路由器;通过router { }还可以使用响应式替代方案。

虽然基于路径的嵌套是最常见的,但您可以通过使用构建器上的 nest 方法对任何类型的谓词进行嵌套。上面仍然包含一些重复,例如共享的 Accept 标头谓词。我们可以通过将 nest 方法与 accept 一起使用来进一步改进

  • Java

  • Kotlin

RouterFunction<ServerResponse> route = route()
	.path("/person", b1 -> b1
		.nest(accept(APPLICATION_JSON), b2 -> b2
			.GET("/{id}", handler::getPerson)
			.GET(handler::listPeople))
		.POST(handler::createPerson))
	.build();
val route = coRouter {
	"/person".nest {
		accept(APPLICATION_JSON).nest {
			GET("/{id}", handler::getPerson)
			GET(handler::listPeople)
			POST(handler::createPerson)
		}
	}
}

服务资源

WebFlux.fn 提供了对服务资源的内置支持。

除了下面描述的功能外,还可以实现更灵活的资源处理,这要归功于 RouterFunctions#resource(java.util.function.Function)

重定向到资源

可以将与指定谓词匹配的请求重定向到资源。例如,这对于处理单页应用程序中的重定向很有用。

  • Java

  • Kotlin

ClassPathResource index = new ClassPathResource("static/index.html");
List<String> extensions = List.of("js", "css", "ico", "png", "jpg", "gif");
RequestPredicate spaPredicate = path("/api/**").or(path("/error")).or(pathExtension(extensions::contains)).negate();
RouterFunction<ServerResponse> redirectToIndex = route()
	.resource(spaPredicate, index)
	.build();
val redirectToIndex = router {
	val index = ClassPathResource("static/index.html")
	val extensions = listOf("js", "css", "ico", "png", "jpg", "gif")
	val spaPredicate = !(path("/api/**") or path("/error") or
		pathExtension(extensions::contains))
	resource(spaPredicate, index)
}

从根位置提供资源

还可以将与给定模式匹配的请求路由到给定根位置的相对资源。

  • Java

  • Kotlin

Resource location = new FileUrlResource("public-resources/");
RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
val location = FileUrlResource("public-resources/")
val resources = router { resources("/resources/**", location) }

运行服务器

如何在一个 HTTP 服务器中运行路由函数?一个简单的选项是通过使用以下方法之一将路由函数转换为 HttpHandler

  • RouterFunctions.toHttpHandler(RouterFunction)

  • RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)

然后,您可以按照 HttpHandler 中针对特定服务器的说明,将返回的 HttpHandler 与许多服务器适配器一起使用。

一个更典型的选项(Spring Boot 也使用该选项)是通过 DispatcherHandler 基于设置的运行 WebFlux 配置,该配置使用 Spring 配置来声明处理请求所需的组件。WebFlux Java 配置声明以下基础设施组件以支持功能性端点

  • RouterFunctionMapping:在 Spring 配置中检测一个或多个 RouterFunction<?> Bean,对它们进行排序,通过 RouterFunction.andOther 将它们组合起来,并将请求路由到生成的组合 RouterFunction

  • HandlerFunctionAdapter:简单的适配器,允许 DispatcherHandler 调用已映射到请求的 HandlerFunction

  • ServerResponseResultHandler:通过调用 ServerResponsewriteTo 方法来处理 HandlerFunction 调用结果。

前面的组件允许功能性端点适合 DispatcherHandler 请求处理生命周期,并且(可能)与任何已声明的带注解的控制器并行运行。这也是 Spring Boot WebFlux 启动器启用功能性端点的方式。

以下示例显示了一个 WebFlux Java 配置(有关如何运行它,请参阅 DispatcherHandler

  • Java

  • Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Bean
	public RouterFunction<?> routerFunctionA() {
		// ...
	}

	@Bean
	public RouterFunction<?> routerFunctionB() {
		// ...
	}

	// ...

	@Override
	public void configureHttpMessageCodecs(ServerCodecConfigurer configurer) {
		// configure message conversion...
	}

	@Override
	public void addCorsMappings(CorsRegistry registry) {
		// configure CORS...
	}

	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {
		// configure view resolution for HTML rendering...
	}
}
@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	@Bean
	fun routerFunctionA(): RouterFunction<*> {
		// ...
	}

	@Bean
	fun routerFunctionB(): RouterFunction<*> {
		// ...
	}

	// ...

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

	override fun addCorsMappings(registry: CorsRegistry) {
		// configure CORS...
	}

	override fun configureViewResolvers(registry: ViewResolverRegistry) {
		// configure view resolution for HTML rendering...
	}
}

过滤处理程序函数

您可以通过使用路由函数构建器上的 beforeafterfilter 方法来过滤处理程序函数。使用注解,您可以通过使用 @ControllerAdviceServletFilter 或两者来实现类似的功能。过滤器将应用于构建器构建的所有路由。这意味着在嵌套路由中定义的过滤器不适用于“顶级”路由。例如,请考虑以下示例

  • Java

  • Kotlin

RouterFunction<ServerResponse> route = route()
	.path("/person", b1 -> b1
		.nest(accept(APPLICATION_JSON), b2 -> b2
			.GET("/{id}", handler::getPerson)
			.GET(handler::listPeople)
			.before(request -> ServerRequest.from(request) (1)
				.header("X-RequestHeader", "Value")
				.build()))
		.POST(handler::createPerson))
	.after((request, response) -> logResponse(response)) (2)
	.build();
1 添加自定义请求标头的 before 过滤器仅应用于两个 GET 路由。
2 记录响应的 after 过滤器应用于所有路由,包括嵌套路由。
val route = router {
	"/person".nest {
		GET("/{id}", handler::getPerson)
		GET("", handler::listPeople)
		before { (1)
			ServerRequest.from(it)
					.header("X-RequestHeader", "Value").build()
		}
		POST(handler::createPerson)
		after { _, response -> (2)
			logResponse(response)
		}
	}
}
1 添加自定义请求标头的 before 过滤器仅应用于两个 GET 路由。
2 记录响应的 after 过滤器应用于所有路由,包括嵌套路由。

路由构建器上的 filter 方法采用 HandlerFilterFunction:一个函数,它采用 ServerRequestHandlerFunction 并返回 ServerResponse。处理程序函数参数表示链中的下一个元素。这通常是路由到的处理程序,但如果应用了多个过滤器,它也可以是另一个过滤器。

现在,我们可以向路由添加一个简单的安全过滤器,假设我们有一个 SecurityManager 可以确定是否允许特定路径。以下示例显示了如何执行此操作

  • Java

  • Kotlin

SecurityManager securityManager = ...

RouterFunction<ServerResponse> route = route()
	.path("/person", b1 -> b1
		.nest(accept(APPLICATION_JSON), b2 -> b2
			.GET("/{id}", handler::getPerson)
			.GET(handler::listPeople))
		.POST(handler::createPerson))
	.filter((request, next) -> {
		if (securityManager.allowAccessTo(request.path())) {
			return next.handle(request);
		}
		else {
			return ServerResponse.status(UNAUTHORIZED).build();
		}
	})
	.build();
val securityManager: SecurityManager = ...

val route = router {
		("/person" and accept(APPLICATION_JSON)).nest {
			GET("/{id}", handler::getPerson)
			GET("", handler::listPeople)
			POST(handler::createPerson)
			filter { request, next ->
				if (securityManager.allowAccessTo(request.path())) {
					next(request)
				}
				else {
					status(UNAUTHORIZED).build();
				}
			}
		}
	}

前面的示例演示了调用 next.handle(ServerRequest) 是可选的。我们仅在允许访问时才允许处理程序函数运行。

除了使用路由函数构建器上的 filter 方法之外,还可以通过 RouterFunction.filter(HandlerFilterFunction) 将过滤器应用于现有的路由函数。

功能性端点的 CORS 支持通过专用的 CorsWebFilter 提供。