对于最新的稳定版本,请使用 Spring Framework 6.2.0! |
功能端点
Spring WebFlux 包括 WebFlux.fn,这是一个轻量级函数式编程模型,其中函数 用于路由和处理请求,而 Contract 旨在实现不变性。 它是基于 Comments 的编程模型的替代方案,但在其他方面运行 相同的 Reactive Core 基础。
概述
在 WebFlux.fn 中,HTTP 请求使用HandlerFunction
:一个函数,该函数采用ServerRequest
并返回一个延迟的ServerResponse
(即Mono<ServerResponse>
).
请求和响应对象都有不可变的契约,这些契约提供对 JDK 8 友好的
访问 HTTP 请求和响应。HandlerFunction
等价于@RequestMapping
方法中的
基于注释的编程模型。
传入请求被路由到具有RouterFunction
:一个函数,该函数
需要ServerRequest
并返回一个延迟的HandlerFunction
(即Mono<HandlerFunction>
).
当 router 函数匹配时,将返回一个处理程序函数;否则为空 Mono。RouterFunction
等价于@RequestMapping
注解,但带有 major
不同之处在于 router 函数不仅提供数据,还提供行为。
RouterFunctions.route()
提供便于创建路由器的 Router 构建器,
如下例所示:
-
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 | 使用 创建 routerroute() . |
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 | 使用 Coroutines router DSL 创建 router;反应式替代方案也可通过以下方式获得router { } . |
运行RouterFunction
是将其转换为HttpHandler
并安装
通过其中一个内置服务器适配器:
-
RouterFunctions.toHttpHandler(RouterFunction)
-
RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)
大多数应用程序可以通过 WebFlux Java 配置运行,请参阅运行服务器。
HandlerFunction 函数
ServerRequest
和ServerResponse
是提供 JDK 8 友好的不可变接口
访问 HTTP 请求和响应。
请求和响应都提供 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>
(或Flow<Person>
在 Kotlin 中)、
哪里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
方法创建它。您可以使用生成器设置响应状态,以添加响应
headers 或提供正文。以下示例使用 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
header 且没有正文:
-
Java
-
Kotlin
URI location = ...
ServerResponse.created(location).build();
val location: URI = ...
ServerResponse.created(location).build()
根据所使用的编解码器,可以传递 hint 参数来自定义 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 可能会变得混乱。
因此,将相关的处理程序函数一起分组到一个处理程序类中是很有用的,该
具有与@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 的 JSON 格式。 |
2 | createPerson 是一个处理程序函数,它将新的Person 包含在请求正文中。
请注意,PersonRepository.savePerson(Person) 返回Mono<Void> :空的Mono 那个会发出
从请求中读取并存储人员时的完成信号。所以我们使用build(Publisher<Void>) 方法在收到该完成信号时发送响应(即
当Person 已保存)。 |
3 | getPerson 是一个处理程序函数,它返回一个 person,由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 的 JSON 格式。 |
2 | createPerson 是一个处理程序函数,它将新的Person 包含在请求正文中。
请注意,PersonRepository.savePerson(Person) 是没有返回类型的挂起函数。 |
3 | getPerson 是一个处理程序函数,它返回一个 person,由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 响应的异常。 |
处理程序还可以通过创建和注入来使用标准 bean 验证 API (JSR-303)
一个全局Validator
实例基于LocalValidatorFactoryBean
.
参见 Spring Validation。
RouterFunction
Router 函数用于将请求路由到相应的HandlerFunction
.
通常,您不会自己编写 router 函数,而是在RouterFunctions
Utility 类来创建一个。RouterFunctions.route()
(无参数)为您提供用于创建路由器的 Fluent 构建器
函数,而RouterFunctions.route(RequestPredicate, HandlerFunction)
提供直接方式
创建路由器。
通常建议使用route()
builder,因为它提供了
适用于典型映射场景的便捷捷径,无需难以发现
static imports。
例如,router 函数构建器提供了GET(String, HandlerFunction)
为 GET 请求创建映射;和POST(String, HandlerFunction)
用于 POST。
除了基于 HTTP 方法的映射之外,路由构建器还提供了一种引入其他
谓词。
对于每个 HTTP 方法,都有一个重载的变体,它采用RequestPredicate
作为
参数,但可以表示其他约束。
谓词
您可以编写自己的RequestPredicate
,但RequestPredicates
Utility 类
提供常用的实现,基于请求路径、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
谓语。
路线
路由器功能按顺序评估:如果第一个路由不匹配,则 second 被评估,依此类推。 因此,在一般路由之前声明更具体的路由是有意义的。 在将路由器函数注册为 Spring bean 时,这一点也很重要,也是如此 稍后描述。 请注意,此行为与基于 Comments 的编程模型不同,其中 “最具体”控制器方法会自动选取。
当使用 router 函数构建器时,所有定义的路由都组合成一个RouterFunction
即从build()
.
还有其他方法可以将多个 router 功能组合在一起:
-
add(RouterFunction)
在RouterFunctions.route()
架构工人 -
RouterFunction.and(RouterFunction)
-
RouterFunction.andRoute(RequestPredicate, HandlerFunction)
— 的快捷方式RouterFunction.and()
with 嵌套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} 替换为Accept 匹配 JSON 的标头将路由到PersonHandler.getPerson |
2 | GET /person 替换为Accept 匹配 JSON 的标头将路由到PersonHandler.listPeople |
3 | POST /person 没有其他谓词映射到PersonHandler.createPerson 和 |
4 | otherRoute 是在其他地方创建并添加到 Route built 的 router 函数。 |
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} 替换为Accept 匹配 JSON 的标头将路由到PersonHandler.getPerson |
2 | GET /person 替换为Accept 匹配 JSON 的标头将路由到PersonHandler.listPeople |
3 | POST /person 没有其他谓词映射到PersonHandler.createPerson 和 |
4 | otherRoute 是在其他地方创建并添加到 Route built 的 router 函数。 |
嵌套路由
一组 router 函数通常具有共享谓词,例如
共享路径。在上面的示例中,共享谓词将是一个路径谓词,该
比赛/person
,由其中 3 条路由使用。使用注释时,您需要删除
此复制通过使用类型级别@RequestMapping
注解,映射到/person
.在 WebFlux.fn 中,路径谓词可以通过path
方法上的
router 函数构建器。例如,上面示例的最后几行可以是
通过使用嵌套路由,通过以下方式进行了改进:
-
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 是采用 router builder 的 consumer。 |
val route = coRouter { (1)
"/person".nest {
GET("/{id}", accept(APPLICATION_JSON), handler::getPerson)
GET(accept(APPLICATION_JSON), handler::listPeople)
POST(handler::createPerson)
}
}
1 | 使用 Coroutines router DSL 创建 router;反应式替代方案也可通过以下方式获得router { } . |
尽管基于路径的嵌套是最常见的,但你可以使用
这nest
方法。
以上仍然包含一些共享Accept
-header 谓词。
我们可以通过使用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 = 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) }
运行 Server
如何在 HTTP 服务器中运行路由器功能?一个简单的选择是将路由器
函数添加到HttpHandler
使用以下选项之一:
-
RouterFunctions.toHttpHandler(RouterFunction)
-
RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)
然后,您可以使用返回的HttpHandler
按照 HttpHandler 获取特定于服务器的说明。
Spring Boot 也使用一个更典型的选项,是使用DispatcherHandler
-based 设置,它使用 Spring 配置来声明
处理请求所需的组件。WebFlux Java 配置声明以下内容
支持功能终端节点的基础设施组件:
-
RouterFunctionMapping
:检测到一个或多个RouterFunction<?>
Spring的咖啡豆 配置、排序、组合RouterFunction.andOther
,并将请求路由到生成的 composeRouterFunction
. -
HandlerFunctionAdapter
:简单的适配器,让DispatcherHandler
调用 一个HandlerFunction
该请求已映射到一个请求。 -
ServerResponseResultHandler
:处理调用HandlerFunction
通过调用writeTo
方法ServerResponse
.
前面的组件允许功能端点适应DispatcherHandler
请求
处理生命周期,并且(可能)与带注释的控制器并行运行,如果
任何 (any) 都已声明。这也是 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...
}
}
筛选处理程序函数
您可以使用before
,after
或filter
路由上的 methods
函数构建器。
通过 annotations,您可以通过使用@ControllerAdvice
一个ServletFilter
和/或两者。
该筛选条件将应用于构建器构建的所有路由。
这意味着嵌套路由中定义的筛选条件不适用于 “top-level” 路由。
例如,请考虑以下示例:
-
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 添加自定义请求标头的 filter 仅适用于两个 GET 路由。 |
2 | 这after filter 记录响应的 filter 应用于所有路由,包括嵌套路由。 |
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 添加自定义请求标头的 filter 仅适用于两个 GET 路由。 |
2 | 这after filter 记录响应的 filter 应用于所有路由,包括嵌套路由。 |
这filter
方法采用HandlerFilterFunction
:一个
函数,该函数采用ServerRequest
和HandlerFunction
并返回一个ServerResponse
.
handler 函数参数表示链中的下一个元素。
这通常是路由到的处理程序,但也可以是另一个
filter (如果应用了多个)。
现在我们可以向路由添加一个简单的安全过滤器,假设我们有一个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
方法,则可以应用
过滤到现有的 router 函数RouterFunction.filter(HandlerFilterFunction)
.
对功能端点的 CORS 支持通过专用的CorsWebFilter . |