Spring WebFlux 包括 WebFlux.fn,这是一个轻量级的函数式编程模型,其中函数 用于路由和处理请求,而合约则设计为不可变性。 它是基于注释的编程模型的替代方案,但在其他方面运行 相同的 Reactive Core 基础。

概述

在 WebFlux.fn 中,HTTP 请求使用 : 一个函数处理,该函数接受并返回延迟(即 )。 request 和 response 对象都具有不可变的协定,这些协定提供对 JDK 8 友好的 访问 HTTP 请求和响应。 等价于方法的主体 基于注释的编程模型。HandlerFunctionServerRequestServerResponseMono<ServerResponse>HandlerFunction@RequestMapping

传入请求被路由到具有 : 的处理程序函数 : 获取并返回延迟(即 )。 当路由器函数匹配时,返回处理程序函数;否则为空的 Mono。 相当于一个注释,但带有 major 路由器功能不仅提供数据,还提供行为。RouterFunctionServerRequestHandlerFunctionMono<HandlerFunction>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 { }

运行 a 的一种方法是将其转换为 a 并安装它 通过其中一个内置服务器适配器RouterFunctionHttpHandler

  • RouterFunctions.toHttpHandler(RouterFunction)

  • RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)

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

HandlerFunction 函数

ServerRequest并且是提供 JDK 8 友好的不可变接口 访问 HTTP 请求和响应。 请求和响应都提供无功流背压 对抗身体流。 请求正文用 Reactor 或 . 响应正文用任何反应式流表示,包括 和 。 有关更多信息,请参阅反应式库ServerResponseFluxMonoPublisherFluxMono

服务器请求

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

以下示例将请求正文提取为 :Mono<String>

  • Java

  • Kotlin

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

以下示例将正文提取为 a(或 Kotlin 中的 a), 其中对象是从某些序列化形式(如 JSON 或 XML)解码的:Flux<Person>Flow<Person>Person

  • Java

  • Kotlin

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

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

  • 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提供对 HTTP 响应的访问,并且由于它是不可变的,因此您可以使用 创建它的方法。您可以使用构建器设置响应状态,添加响应 标头,或提供正文。以下示例使用 JSON 创建 200 (OK) 响应 内容:build

  • 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)

以下示例演示如何生成具有标头且没有正文的 201 (CREATED) 响应:Location

  • Java

  • Kotlin

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

根据所使用的编解码器,可以传递提示参数以自定义 body 被序列化或反序列化。例如,要指定 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 可能会变得混乱。 因此,将相关的处理程序函数组合到一个处理程序类中是很有用的,该类 具有与基于批注的应用程序类似的角色。 例如,以下类公开一个反应式存储库:@ControllerPerson

  • 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是一个处理程序函数,它将存储库中找到的所有对象返回为 JSON中。Person
2 createPerson是一个处理程序函数,用于存储请求正文中包含的新内容。 请注意,返回 : 一个空的 从请求中读取并存储人员时的完成信号。因此,我们使用该方法在接收到该完成信号时发送响应(即 当已保存时)。PersonPersonRepository.savePerson(Person)Mono<Void>Monobuild(Publisher<Void>)Person
3 getPerson是一个处理程序函数,返回单个人,由路径标识 变量。我们从存储库中检索它并创建一个 JSON 响应(如果是) 发现。如果未找到,我们用于返回 404 Not Found 响应。idPersonswitchIfEmpty(Mono<T>)
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是一个处理程序函数,它将存储库中找到的所有对象返回为 JSON中。Person
2 createPerson是一个处理程序函数,用于存储请求正文中包含的新内容。 请注意,这是一个没有返回类型的挂起函数。PersonPersonRepository.savePerson(Person)
3 getPerson是一个处理程序函数,返回单个人,由路径标识 变量。我们从存储库中检索它并创建一个 JSON 响应(如果是) 发现。如果未找到,我们将返回 404 Not Found 响应。idPerson

验证

功能端点可以使用 Spring 的验证工具来执行以下操作 将验证应用于请求正文。例如,给定一个自定义的 Spring Validator 实现:Person

  • 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 响应的异常。

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

RouterFunction

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

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

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

谓词

您可以编写自己的 ,但实用程序类 提供常用的实现,基于请求路径、HTTP 方法、 content-type、 等等。 以下示例使用请求谓词创建基于标头的约束:RequestPredicateRequestPredicatesAccept

  • 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)— 两者都可以匹配。

许多谓词都是由组成。 例如,由 和 组成。 上面显示的示例还使用了两个请求谓词,就像构建器在内部使用的那样,并用谓词组成。RequestPredicatesRequestPredicates.GET(String)RequestPredicates.method(HttpMethod)RequestPredicates.path(String)RequestPredicates.GETaccept

路线

路由器功能按顺序计算:如果第一条路由不匹配,则 第二是评估,依此类推。 因此,在一般路线之前声明更具体的路线是有意义的。 在将路由器功能注册为 Spring bean 时,这一点也很重要,就像 稍后再描述。 请注意,此行为与基于注释的编程模型不同,其中 自动选择“最具体”的控制器方法。

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

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

  • 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 匹配的标头AcceptPersonHandler.getPerson
2 GET /person与路由到 JSON 匹配的标头AcceptPersonHandler.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 匹配的标头AcceptPersonHandler.getPerson
2 GET /person与路由到 JSON 匹配的标头AcceptPersonHandler.listPeople
3 POST /person没有附加谓词映射到 ,并且PersonHandler.createPerson
4 otherRoute是在其他地方创建的路由器功能,并添加到构建的路由中。

嵌套路由

一组路由器函数通常具有共享谓词,例如 共享路径。在上面的示例中,共享谓词将是一个路径谓词 匹配项,由其中三条路由使用。使用批注时,您将删除 通过使用映射到 的类型级批注进行复制。在 WebFlux.fn 中,可以通过 路由器功能构建器。例如,上面示例的最后几行可以是 通过使用嵌套路由,通过以下方式进行了改进:/person@RequestMapping/personpath

  • 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 { }

尽管基于路径的嵌套是最常见的,但您可以使用 生成器上的方法。 上面仍然包含一些共享标头谓词形式的重复。 我们可以通过将该方法与以下方法结合使用来进一步改进:nestAcceptnestaccept

  • 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 = Arrays.asList("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 FileSystemResource("public-resources/");
RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
val location = FileSystemResource("public-resources/")
val resources = router { resources("/resources/**", location) }

运行服务器

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

  • RouterFunctions.toHttpHandler(RouterFunction)

  • RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)

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

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

  • RouterFunctionMapping:在春季检测一个或多个豆子 配置,对它们进行排序,将它们组合在一起,然后将请求路由到生成的组合 。RouterFunction<?>RouterFunction.andOtherRouterFunction

  • HandlerFunctionAdapter:允许调用的简单适配器 映射到请求的 a。DispatcherHandlerHandlerFunction

  • ServerResponseResultHandler:通过调用 .HandlerFunctionwriteToServerResponse

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

以下示例显示了 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 添加自定义请求标头的筛选器仅应用于两个 GET 路由。before
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 添加自定义请求标头的筛选器仅应用于两个 GET 路由。before
2 记录响应的筛选器将应用于所有路由,包括嵌套路由。after

路由器构建器上的方法需要 : a 函数接受 a 和 并返回 . 处理程序函数参数表示链中的下一个元素。 这通常是路由到的处理程序,但它也可以是另一个 筛选是否应用了多个。filterHandlerFilterFunctionServerRequestHandlerFunctionServerResponse

现在我们可以在路由中添加一个简单的安全过滤器,假设我们有一个 可以确定是否允许特定路径。 以下示例演示如何执行此操作: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)

除了在路由器功能构建器上使用该方法外,还可以应用 通过 过滤到现有路由器功能。filterRouterFunction.filter(HandlerFilterFunction)

通过专用的 CorsWebFilter 提供对功能终结点的 CORS 支持。