功能端点

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方法来创建它。您可以使用构建器来设置响应状态，添加响应标头或提供主体。以下示例创建一个带有 JSON 内容的 200（OK）响应

  • Java

  • Kotlin

Person person = ...
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(person);
val person: Person = ...
ServerResponse.ok().contentType(MediaType.APPLICATION_JSON).body(person)

以下示例显示如何构建具有Location标头且没有主体的 201（CREATED）响应

  • 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方法提供。该方法提供的构建器允许您发送字符串或其他对象作为 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()

处理程序类

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

  • Java

  • Kotlin

HandlerFunction<ServerResponse> helloWorld =
  request -> ServerResponse.ok().body("Hello World");
val helloWorld: (ServerRequest) -> ServerResponse =
  { ServerResponse.ok().body("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 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 未找到响应。 
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 未找到响应。

验证

函数式端点可以使用 Spring 的验证工具将验证应用于请求主体。例如，给定Person的自定义 Spring Validator 实现

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

处理程序还可以使用标准 Bean 验证 API (JSR-303)，方法是基于LocalValidatorFactoryBean创建和注入全局Validator实例。参见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().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时也很重要，这将在后面描述。请注意，此行为与基于注解的编程模型不同，在基于注解的编程模型中，会自动选择“最具体”的控制器方法。

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

  • 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.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 GET /person/{id} 且Accept标头匹配JSON将路由到PersonHandler.getPerson
2 GET /person 且Accept标头匹配JSON将路由到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 GET /person/{id} 且Accept标头匹配JSON将路由到PersonHandler.getPerson
2 GET /person 且Accept标头匹配JSON将路由到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) }

运行服务器

参见响应式堆栈中的等效项

您通常在基于DispatcherHandler的设置中通过MVC配置运行路由函数，该配置使用Spring配置声明处理请求所需的组件。MVC Java配置声明以下基础结构组件以支持功能端点：

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

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

前面的组件使功能端点能够适应DispatcherServlet请求处理生命周期，并且还可以（可能）与已声明的任何带注解的控制器并行运行。这也是Spring Boot Web启动器启用功能端点的方式。

以下示例显示了一个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...
	}
}

过滤处理程序函数

参见响应式堆栈中的等效项

您可以使用路由函数构建器上的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提供。