函數式端點

Spring WebFlux 包含 WebFlux.fn，這是一種輕量級函數式程式設計模型，其中函數用於路由和處理請求，而契約則設計為不可變的。它是基於註解的程式設計模型的替代方案，但在相同的 反應式核心 基礎上運行。

概觀

請參閱 Servlet 堆疊中的等效項

在 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 配置運行，請參閱 運行伺服器。

HandlerFunction

請參閱 Servlet 堆疊中的等效項

ServerRequest 和 ServerResponse 是不可變的介面，可提供對 HTTP 請求和回應的 JDK 8 友善存取。請求和回應都針對 Body 串流提供 Reactive Streams 背壓。請求 Body 以 Reactor Flux 或 Mono 表示。回應 Body 以任何 Reactive Streams Publisher 表示，包括 Flux 和 Mono。如需更多資訊，請參閱 反應式程式庫。

ServerRequest

ServerRequest 提供對 HTTP 方法、URI、標頭和查詢參數的存取，而對 Body 的存取則透過 body 方法提供。

以下範例將請求 Body 提取到 Mono<String>

  • Java

  • Kotlin

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

以下範例將 Body 提取到 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()

以下範例示範如何以映射形式存取 multipart 資料

  • Java

  • Kotlin

Mono<MultiValueMap<String, Part>> map = request.multipartData();
val map = request.awaitMultipartData()

以下範例示範如何以串流方式一次存取一個 multipart 資料

  • 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 物件的 Body 內容，以避免記憶體洩漏。

ServerResponse

ServerResponse 提供對 HTTP 回應的存取，而且由於它是不可變的，因此您可以使用 build 方法來建立它。您可以使用建構器來設定回應狀態、新增回應標頭或提供 Body。以下範例建立具有 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 標頭且沒有 Body 的 201 (CREATED) 回應

  • 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 可能會變得混亂。因此，將相關的處理器函數分組到處理器類別中非常有用，這與基於註解的應用程式中的 @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 是一個處理器函數，它以 JSON 形式返回儲存庫中找到的所有 Person 物件。
2 createPerson 是一個處理器函數，它儲存請求 Body 中包含的新 Person。請注意，PersonRepository.savePerson(Person) 返回 Mono<Void>：當從請求中讀取並儲存人員時，發出完成訊號的空 Mono。因此，當收到該完成訊號時 (即，當 Person 已儲存時)，我們使用 build(Publisher<Void>) 方法傳送回應。
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 是一個處理器函數，它以 JSON 形式返回儲存庫中找到的所有 Person 物件。
2 createPerson 是一個處理器函數，它儲存請求 Body 中包含的新 Person。請注意，PersonRepository.savePerson(Person) 是一個沒有回傳值的暫停函數。
3 getPerson 是一個處理器函數，它返回由 id 路徑變數識別的單個人員。如果找到該 Person，我們會從儲存庫中檢索它並建立 JSON 回應。如果找不到，我們會返回 404 Not Found 回應。

驗證

函數式端點可以使用 Spring 的 驗證功能，將驗證應用於請求 Body。例如，給定一個用於 Person 的自訂 Spring Validator 實作

  • 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 回應引發例外。

處理器也可以透過建立和注入基於 LocalValidatorFactoryBean 的全域 Validator 實例來使用標準 Bean 驗證 API (JSR-303)。請參閱 Spring 驗證。

RouterFunction

請參閱 Servlet 堆疊中的等效項

路由器函數用於將請求路由到對應的 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().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() 返回。還有其他方法可以將多個路由器函數組合在一起

  • 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.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 是一個在其他地方建立的路由器函數，並新增到已建立的路由中。 
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 是一個在其他地方建立的路由器函數，並新增到已建立的路由中。

巢狀路由

一組路由器函數通常具有共享謂詞，例如共享路徑。在上面的範例中，共享謂詞將是與 /person 匹配的路徑謂詞，由三個路由使用。當使用註解時，您可以透過使用類型層級 @RequestMapping 註解 (映射到 /person) 來消除此重複。在 WebFlux.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 的第二個參數是一個消費者，它接受路由器建構器。 
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)
		}
	}
}

提供資源

WebFlux.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) }

執行伺服器

請參閱 Servlet 堆疊中的等效項

如何在 HTTP 伺服器中運行路由器函數？一個簡單的選項是使用以下方法之一將路由器函數轉換為 HttpHandler

  • RouterFunctions.toHttpHandler(RouterFunction)

  • RouterFunctions.toHttpHandler(RouterFunction, HandlerStrategies)

然後，您可以將返回的 HttpHandler 與許多伺服器適配器一起使用，方法是遵循伺服器特定指示的 HttpHandler。

Spring Boot 也使用的更典型的選項是透過 WebFlux 配置 在基於 DispatcherHandler 的設定中運行，該設定使用 Spring 配置來宣告處理請求所需的元件。WebFlux Java 配置宣告了以下基礎架構元件以支援函數式端點

  • RouterFunctionMapping：偵測 Spring 配置中的一個或多個 RouterFunction<?> Bean，對它們進行排序，透過 RouterFunction.andOther 將它們組合起來，並將請求路由到產生的組合 RouterFunction。

  • HandlerFunctionAdapter：簡單的適配器，讓 DispatcherHandler 調用映射到請求的 HandlerFunction。

  • ServerResponseResultHandler：透過調用 ServerResponse 的 writeTo 方法來處理調用 HandlerFunction 的結果。

先前的元件讓函數式端點適合 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...
	}
}

過濾處理器函數

請參閱 Servlet 堆疊中的等效項

您可以使用路由函數建構器上的 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 篩選器適用於所有路由，包括巢狀路由。 
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。handler 函數參數代表鏈中的下一個元素。這通常是路由到的 handler，但也可能是另一個 filter（如果應用了多個 filter 的話）。

現在我們可以為我們的路由新增一個簡單的安全 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) 是可選的。我們只在存取被允許時才讓 handler 函數執行。

除了在路由器函數建構器上使用 filter 方法之外，也可以透過 RouterFunction.filter(HandlerFilterFunction) 將 filter 應用於現有的路由器函數。

對 functional endpoints 的 CORS 支援是透過專用的 CorsWebFilter 提供的。