函数式端点
Spring Web MVC 包含 WebMvc.fn,这是一种轻量级的函数式编程模型,其中函数用于路由和处理请求,并且契约被设计为不可变的。它是基于注解的编程模型的替代方案,但它运行在相同的 DispatcherServlet 上。
概述
在 WebMvc.fn 中,HTTP 请求由 HandlerFunction
处理:这是一个接受 ServerRequest
并返回 ServerResponse
的函数。请求和响应对象都具有不可变的契约,提供对 HTTP 请求和响应的 JDK 8 友好访问。HandlerFunction
相当于基于注解的编程模型中 @RequestMapping
方法的主体。
传入的请求通过 RouterFunction
路由到处理函数:这是一个接受 ServerRequest
并返回可选 HandlerFunction
(即 Optional<HandlerFunction>
) 的函数。当路由函数匹配时,将返回一个处理函数;否则返回一个空的 Optional。RouterFunction
相当于 @RequestMapping
注解,但主要区别在于路由函数不仅提供数据,还提供行为。
RouterFunctions.route()
提供了一个路由构建器,方便创建路由器,示例如下
-
Java
-
Kotlin
import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.web.servlet.function.RequestPredicates.*;
import static org.springframework.web.servlet.function.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 ServerResponse listPeople(ServerRequest request) {
// ...
}
public ServerResponse createPerson(ServerRequest request) {
// ...
}
public ServerResponse getPerson(ServerRequest request) {
// ...
}
}
1 | 使用 route() 创建路由器。 |
import org.springframework.web.servlet.function.router
val repository: PersonRepository = ...
val handler = PersonHandler(repository)
val route = router { (1)
accept(APPLICATION_JSON).nest {
GET("/person/{id}", handler::getPerson)
GET("/person", handler::listPeople)
}
POST("/person", handler::createPerson)
}
class PersonHandler(private val repository: PersonRepository) {
// ...
fun listPeople(request: ServerRequest): ServerResponse {
// ...
}
fun createPerson(request: ServerRequest): ServerResponse {
// ...
}
fun getPerson(request: ServerRequest): ServerResponse {
// ...
}
}
1 | 使用路由器 DSL 创建路由器。 |
如果你将 RouterFunction
注册为一个 bean,例如通过在 @Configuration
类中暴露它,它将被 servlet 自动检测到,如 运行服务器 中所述。
HandlerFunction
ServerRequest
和 ServerResponse
是不可变的接口,它们提供了对 HTTP 请求和响应的 JDK 8 友好访问,包括头部、请求体、方法和状态码。
ServerRequest
ServerRequest
提供了对 HTTP 方法、URI、头部和查询参数的访问,而对请求体的访问则通过 body
方法提供。
以下示例将请求体提取为 String
-
Java
-
Kotlin
String string = request.body(String.class);
val string = request.body<String>()
以下示例将请求体提取为 List<Person>
,其中 Person
对象从序列化形式(例如 JSON 或 XML)解码得到
-
Java
-
Kotlin
List<Person> people = request.body(new ParameterizedTypeReference<List<Person>>() {});
val people = request.body<Person>()
以下示例展示了如何访问参数
-
Java
-
Kotlin
MultiValueMap<String, String> params = request.params();
val map = request.params()
ServerResponse
ServerResponse
提供了对 HTTP 响应的访问,并且由于它是不可变的,你可以使用 build
方法来创建它。你可以使用构建器来设置响应状态、添加响应头部或提供响应体。以下示例创建一个状态为 200 (OK) 且内容为 JSON 的响应
-
Java
-
Kotlin
Person person = ...
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(person);
val person: Person = ...
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(person)
以下示例展示了如何构建一个状态为 201 (CREATED) 且包含 Location
头部但没有响应体的响应
-
Java
-
Kotlin
URI location = ...
ServerResponse.created(location).build();
val location: URI = ...
ServerResponse.created(location).build()
你还可以使用异步结果作为响应体,形式可以是 CompletableFuture
、Publisher
或 ReactiveAdapterRegistry
支持的任何其他类型。例如
-
Java
-
Kotlin
Mono<Person> person = webClient.get().retrieve().bodyToMono(Person.class);
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(person);
val person = webClient.get().retrieve().awaitBody<Person>()
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(person)
如果不仅响应体,而且状态或头部也基于异步类型,你可以使用 ServerResponse
上的静态 async
方法,它接受 CompletableFuture<ServerResponse>
、Publisher<ServerResponse>
或 ReactiveAdapterRegistry
支持的任何其他异步类型。例如
-
Java
Mono<ServerResponse> asyncResponse = webClient.get().retrieve().bodyToMono(Person.class)
.map(p -> ServerResponse.ok().header("Name", p.name()).body(p));
ServerResponse.async(asyncResponse);
可以通过 ServerResponse
上的静态 sse
方法提供 Server-Sent Events。该方法提供的构建器允许你发送 String 或其他对象作为 JSON。例如
-
Java
-
Kotlin
public RouterFunction<ServerResponse> sse() {
return route(GET("/sse"), request -> ServerResponse.sse(sseBuilder -> {
// Save the sseBuilder object somewhere..
}));
}
// In some other thread, sending a String
sseBuilder.send("Hello world");
// Or an object, which will be transformed into JSON
Person person = ...
sseBuilder.send(person);
// Customize the event by using the other methods
sseBuilder.id("42")
.event("sse event")
.data(person);
// and done at some point
sseBuilder.complete();
fun sse(): RouterFunction<ServerResponse> = router {
GET("/sse") { request -> ServerResponse.sse { sseBuilder ->
// Save the sseBuilder object somewhere..
}
}
// In some other thread, sending a String
sseBuilder.send("Hello world")
// Or an object, which will be transformed into JSON
val person = ...
sseBuilder.send(person)
// Customize the event by using the other methods
sseBuilder.id("42")
.event("sse event")
.data(person)
// and done at some point
sseBuilder.complete()
Handler 类
我们可以将处理函数写成 Lambda 表达式,示例如下
-
Java
-
Kotlin
HandlerFunction<ServerResponse> helloWorld =
request -> ServerResponse.ok().body("Hello World");
val helloWorld: (ServerRequest) -> ServerResponse =
{ ServerResponse.ok().body("Hello World") }
这很方便,但在一个应用中我们需要多个函数,而多个内联 Lambda 表达式可能会变得杂乱。因此,将相关的处理函数组合到一个 Handler 类中很有用,Handler 类在基于注解的应用中扮演着类似于 @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 ServerResponse listPeople(ServerRequest request) { (1)
List<Person> people = repository.allPeople();
return ok().contentType(APPLICATION_JSON).body(people);
}
public ServerResponse createPerson(ServerRequest request) throws Exception { (2)
Person person = request.body(Person.class);
repository.savePerson(person);
return ok().build();
}
public ServerResponse getPerson(ServerRequest request) { (3)
int personId = Integer.parseInt(request.pathVariable("id"));
Person person = repository.getPerson(personId);
if (person != null) {
return ok().contentType(APPLICATION_JSON).body(person);
}
else {
return ServerResponse.notFound().build();
}
}
}
1 | listPeople 是一个处理函数,它将仓库中找到的所有 Person 对象作为 JSON 返回。 |
2 | createPerson 是一个处理函数,它存储请求体中包含的新 Person 。 |
3 | getPerson 是一个处理函数,它返回由路径变量 id 标识的单个人员。如果找到该 Person ,我们从仓库中检索并创建 JSON 响应。如果未找到,我们返回 404 Not Found 响应。 |
class PersonHandler(private val repository: PersonRepository) {
fun listPeople(request: ServerRequest): ServerResponse { (1)
val people: List<Person> = repository.allPeople()
return ok().contentType(APPLICATION_JSON).body(people);
}
fun createPerson(request: ServerRequest): ServerResponse { (2)
val person = request.body<Person>()
repository.savePerson(person)
return ok().build()
}
fun getPerson(request: ServerRequest): ServerResponse { (3)
val personId = request.pathVariable("id").toInt()
return repository.getPerson(personId)?.let { ok().contentType(APPLICATION_JSON).body(it) }
?: ServerResponse.notFound().build()
}
}
1 | listPeople 是一个处理函数,它将仓库中找到的所有 Person 对象作为 JSON 返回。 |
2 | createPerson 是一个处理函数,它存储请求体中包含的新 Person 。 |
3 | getPerson 是一个处理函数,它返回由路径变量 id 标识的单个人员。如果找到该 Person ,我们从仓库中检索并创建 JSON 响应。如果未找到,我们返回 404 Not Found 响应。 |
验证
-
Java
-
Kotlin
public class PersonHandler {
private final Validator validator = new PersonValidator(); (1)
// ...
public ServerResponse createPerson(ServerRequest request) {
Person person = request.body(Person.class);
validate(person); (2)
repository.savePerson(person);
return ok().build();
}
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)
// ...
fun createPerson(request: ServerRequest): ServerResponse {
val person = request.body<Person>()
validate(person) (2)
repository.savePerson(person)
return ok().build()
}
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 响应抛出异常。 |
Handler 还可以通过创建和注入基于 LocalValidatorFactoryBean
的全局 Validator
实例来使用标准的 bean 验证 API (JSR-303)。请参阅 Spring Validation。
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().body("Hello World")).build();
import org.springframework.web.servlet.function.router
val route = router {
GET("/hello-world", accept(TEXT_PLAIN)) {
ServerResponse.ok().body("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.servlet.function.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 匹配的 Accept 头部 的 GET /person/{id} 请求被路由到 PersonHandler.getPerson |
2 | 包含与 JSON 匹配的 Accept 头部 的 GET /person 请求被路由到 PersonHandler.listPeople |
3 | 不带附加谓词的 POST /person 请求被映射到 PersonHandler.createPerson ,并且 |
4 | otherRoute 是一个在别处创建并添加到所构建路由中的路由函数。 |
import org.springframework.http.MediaType.APPLICATION_JSON
import org.springframework.web.servlet.function.router
val repository: PersonRepository = ...
val handler = PersonHandler(repository);
val otherRoute = router { }
val route = router {
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 匹配的 Accept 头部 的 GET /person/{id} 请求被路由到 PersonHandler.getPerson |
2 | 包含与 JSON 匹配的 Accept 头部 的 GET /person 请求被路由到 PersonHandler.listPeople |
3 | 不带附加谓词的 POST /person 请求被映射到 PersonHandler.createPerson ,并且 |
4 | otherRoute 是一个在别处创建并添加到所构建路由中的路由函数。 |
嵌套路由
一组路由函数通常有一个共享谓词,例如共享路径。在上面的示例中,共享谓词是一个匹配 /person
的路径谓词,被三个路由使用。使用注解时,你可以通过使用映射到 /person
的类级别 @RequestMapping
注解来消除这种重复。在 WebMvc.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 的第二个参数是一个接受路由构建器的消费者。 |
import org.springframework.web.servlet.function.router
val route = router {
"/person".nest { (1)
GET("/{id}", accept(APPLICATION_JSON), handler::getPerson)
GET(accept(APPLICATION_JSON), handler::listPeople)
POST(handler::createPerson)
}
}
1 | 使用 nest DSL。 |
虽然基于路径的嵌套是最常见的,但你可以使用构建器上的 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();
import org.springframework.web.servlet.function.router
val route = router {
"/person".nest {
accept(APPLICATION_JSON).nest {
GET("/{id}", handler::getPerson)
GET("", handler::listPeople)
POST(handler::createPerson)
}
}
}
服务资源
WebMvc.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) }
运行服务器
你通常通过 MVC 配置 在基于 DispatcherHandler
的设置中运行路由函数,该配置使用 Spring 配置声明处理请求所需的组件。MVC Java 配置声明了以下基础设施组件来支持函数式端点
-
RouterFunctionMapping
:检测 Spring 配置中的一个或多个RouterFunction<?>
bean,对它们进行排序,通过RouterFunction.andOther
组合它们,并将请求路由到最终组合的RouterFunction
。 -
HandlerFunctionAdapter
:简单的适配器,允许DispatcherHandler
调用映射到请求的HandlerFunction
。
前面的组件使得函数式端点能够融入 DispatcherServlet
请求处理生命周期,并且(如果声明了)还可以与注解式控制器并行运行。这也是 Spring Boot Web starter 启用函数式端点的方式。
以下示例展示了 WebFlux Java 配置
-
Java
-
Kotlin
@Configuration
@EnableMvc
public class WebConfig implements WebMvcConfigurer {
@Bean
public RouterFunction<?> routerFunctionA() {
// ...
}
@Bean
public RouterFunction<?> routerFunctionB() {
// ...
}
// ...
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
// configure message conversion...
}
@Override
public void addCorsMappings(CorsRegistry registry) {
// configure CORS...
}
@Override
public void configureViewResolvers(ViewResolverRegistry registry) {
// configure view resolution for HTML rendering...
}
}
@Configuration
@EnableMvc
class WebConfig : WebMvcConfigurer {
@Bean
fun routerFunctionA(): RouterFunction<*> {
// ...
}
@Bean
fun routerFunctionB(): RouterFunction<*> {
// ...
}
// ...
override fun configureMessageConverters(converters: List<HttpMessageConverter<*>>) {
// configure message conversion...
}
override fun addCorsMappings(registry: CorsRegistry) {
// configure CORS...
}
override fun configureViewResolvers(registry: ViewResolverRegistry) {
// configure view resolution for HTML rendering...
}
}
过滤 Handler 函数
你可以使用路由函数构建器上的 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 | 添加自定义请求头部的 before 过滤器仅应用于两个 GET 路由。 |
2 | 记录响应的 after 过滤器应用于所有路由,包括嵌套路由。 |
import org.springframework.web.servlet.function.router
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
:这是一个接受 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();
import org.springframework.web.servlet.function.router
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 支持通过专门的 CorsFilter 提供。 |