|
对于最新稳定版本,请使用 Spring Framework 7.0.6! |
函数式端点
Spring WebFlux 包含 WebFlux.fn,这是一种轻量级的函数式编程模型,使用函数来路由和处理请求,并且其契约设计为不可变的。 它是基于注解的编程模型的一种替代方案,但除此之外,它运行在相同的Reactive Core基础之上。
概述
在 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 配置运行,参见 运行服务器。
处理器函数
ServerRequest 和 ServerResponse 是不可变的接口,提供对 HTTP 请求和响应的 JDK 8 友好访问。
请求和响应都通过 Reactive Streams 对流式主体提供背压支持。
请求主体由 Reactor 的 Flux 或 Mono 表示。
响应主体可由任何 Reactive Streams 的 Publisher 表示,包括 Flux 和 Mono。
更多信息请参阅 响应式库。
服务器请求
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()
以下示例展示了如何将多部分数据作为映射(Map)进行访问:
-
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 响应的访问,并且由于它是不可变的,你可以使用 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()
根据所使用的编解码器(codec),可以传递提示参数(hint parameters)来自定义请求体的序列化或反序列化方式。例如,指定一个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 Not Found 响应。 |
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 Not Found 响应。 |
验证
-
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 响应抛出异常。 |
处理器也可以通过创建并注入一个基于 Validator 的全局 LocalValidatorFactoryBean 实例,来使用标准的 Bean Validation API(JSR-303)。
参见Spring 验证。
RouterFunction
路由函数(Router functions)用于将请求路由到相应的HandlerFunction。
通常,您不会自己编写路由函数,而是使用
RouterFunctions 工具类上的方法来创建路由函数。
RouterFunctions.route()(无参数)为您提供了一个流畅的构建器(fluent builder)来创建路由
函数,而 RouterFunctions.route(RequestPredicate, HandlerFunction) 则提供了一种直接创建路由函数的方式。
通常建议使用 route() 构建器,因为它为典型的映射场景提供了便捷的快捷方式,而无需使用难以发现的静态导入。
例如,路由函数构建器提供了 GET(String, HandlerFunction) 方法来创建 GET 请求的映射;以及用于 POST 请求的 POST(String, HandlerFunction) 方法。
除了基于 HTTP 方法的映射之外,路由构建器还提供了一种在映射请求时引入额外谓词(predicates)的方式。
对于每个 HTTP 方法,都提供了一个重载变体,该变体接受一个 RequestPredicate 参数,通过该参数可以表达额外的约束条件。
谓词
你可以编写自己的 RequestPredicate,但 RequestPredicates 工具类提供了常用的实现,这些实现基于请求路径、HTTP 方法、内容类型(content-type)等。
以下示例使用一个请求谓词(request predicate)根据 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()方法返回。
还有其他方式可以将多个路由函数组合在一起:
-
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 | 带有匹配 JSON 的 GET /person/{id} 请求头的 Accept 请求会被路由到
PersonHandler.getPerson |
| 2 | 带有匹配 JSON 的 GET /person 请求头的 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 | 带有匹配 JSON 的 GET /person/{id} 请求头的 Accept 请求会被路由到
PersonHandler.getPerson |
| 2 | 带有匹配 JSON 的 GET /person 请求头的 Accept 请求会被路由到
PersonHandler.listPeople |
| 3 | POST /person 请求在没有附加谓词的情况下被映射到
PersonHandler.createPerson,并且 |
| 4 | otherRoute 是在其他地方创建的路由器函数,并被添加到所构建的路由中。 |
嵌套路由
通常,一组路由函数会共享一个谓词(predicate),例如共享一个路径。在上面的示例中,共享的谓词是一个路径谓词,匹配 /person,并被其中三个路由所使用。在使用注解时,您可以通过在类型级别上使用 @RequestMapping 注解(映射到 /person)来消除这种重复。在 WebFlux.fn 中,可以通过路由器函数构建器(router function builder)上的 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 的第二个参数是一个接收路由构建器的消费者(Consumer)。 |
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)
}
}
}
运行服务器
如何在 HTTP 服务器中运行一个路由函数?一个简单的选项是通过以下方式之一将路由函数转换为 HttpHandler:
-
RouterFunctions.toHttpHandler(RouterFunction) -
RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)
然后,您可以按照HttpHandler中的服务器特定说明,将返回的webflux/reactive-spring.html#webflux-httphandler与多个服务器适配器一起使用。
一个更典型的选项(Spring Boot 也采用此方式)是通过
DispatcherHandler 配置运行,该配置借助
WebFlux 配置,利用 Spring 配置来声明处理请求所需的组件。WebFlux Java 配置会声明以下基础设施组件以支持函数式端点:
-
RouterFunctionMapping:检测 Spring 配置中一个或多个RouterFunction<?>Bean,对它们进行排序,通过RouterFunction.andOther将其组合,并将请求路由到最终合成的RouterFunction。 -
HandlerFunctionAdapter:一个简单的适配器,允许DispatcherHandler调用已映射到请求的HandlerFunction。 -
ServerResponseResultHandler:通过调用HandlerFunction的writeTo方法,处理ServerResponse调用所产生的结果。
上述组件使函数式端点能够融入 DispatcherHandler 的请求处理生命周期,并且(如果声明了任何注解控制器)还可以与注解控制器并行运行。这也是 Spring Boot WebFlux Starter 启用函数式端点的方式。
以下示例展示了一个 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...
}
}
过滤处理函数
你可以通过在路由函数构建器(routing function builder)上使用 before、after 或 filter 方法来过滤处理函数。
使用注解时,你可以通过 @ControllerAdvice、ServletFilter 或两者结合来实现类似的功能。
该过滤器将应用于由该构建器创建的所有路由。
这意味着在嵌套路由中定义的过滤器不会应用于“顶层”路由。
例如,考虑以下示例:
-
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过滤器用于记录响应。 |
路由器构建器上的 filter 方法接收一个 HandlerFilterFunction:
这是一个函数,它接收一个 ServerRequest 和一个 HandlerFunction,并返回一个 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 提供的。 |