org.springframework.web.reactive.function

Class RouterFunctions

java.lang.Object

org.springframework.web.reactive.function.RouterFunctions

public abstract class RouterFunctions
extends Object

Central entry point to Spring's functional web framework. Exposes routing functionality, such as to create a RouterFunction given a RequestPredicate and HandlerFunction, and to do further subrouting on an existing routing function.

Additionally, this class can transform a RouterFunction into an HttpHandler, which can be run in Servlet 3.1+, Reactor, RxNetty, or Undertow. And it can transform a RouterFunction into an HandlerMapping, which can be run in a DispatcherHandler.

Since:

5.0

Author:

Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_ATTRIBUTE Name of the ServerWebExchange attribute that contains the Request.
static String	URI_TEMPLATE_VARIABLES_ATTRIBUTE Name of the ServerWebExchange attribute that contains the URI templates map, mapping variable names to values.

Constructor Summary

Constructors

Constructor and Description
RouterFunctions()

Method Summary

Modifier and Type	Method and Description
static <T> RouterFunction<T>	route(RequestPredicate predicate, HandlerFunction<T> handlerFunction) Route to the given handler function if the given request predicate applies.
static <T> RouterFunction<T>	subroute(RequestPredicate predicate, RouterFunction<T> routerFunction) Route to the given routing function if the given request predicate applies.
static HandlerMapping	toHandlerMapping(RouterFunction<?> routerFunction) Convert the given RouterFunction into a HandlerMapping.
static HandlerMapping	toHandlerMapping(RouterFunction<?> routerFunction, StrategiesSupplier strategies) Convert the given routing function into a HandlerMapping, using the given strategies.
static org.springframework.http.server.reactive.HttpHandler	toHttpHandler(RouterFunction<?> routerFunction) Convert the given routing function into a HttpHandler.
static org.springframework.http.server.reactive.HttpHandler	toHttpHandler(RouterFunction<?> routerFunction, StrategiesSupplier strategies) Convert the given routing function into a HttpHandler, using the given strategies.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REQUEST_ATTRIBUTE

public static final String REQUEST_ATTRIBUTE

Name of the ServerWebExchange attribute that contains the Request.

URI_TEMPLATE_VARIABLES_ATTRIBUTE

public static final String URI_TEMPLATE_VARIABLES_ATTRIBUTE

Name of the ServerWebExchange attribute that contains the URI templates map, mapping variable names to values.

Constructor Detail

RouterFunctions

public RouterFunctions()

Method Detail

route

public static <T> RouterFunction<T> route(RequestPredicate predicate,
                                          HandlerFunction<T> handlerFunction)

Route to the given handler function if the given request predicate applies.

Type Parameters:

T - the type of the handler function

Parameters:

predicate - the predicate to test

handlerFunction - the handler function to route to

Returns:

a routing function that routes to handlerFunction if predicate evaluates to true

See Also:

RequestPredicates

subroute

public static <T> RouterFunction<T> subroute(RequestPredicate predicate,
                                             RouterFunction<T> routerFunction)

Route to the given routing function if the given request predicate applies.

Type Parameters:

T - the type of the handler function

Parameters:

predicate - the predicate to test

routerFunction - the routing function to route to

Returns:

a routing function that routes to routerFunction if predicate evaluates to true

See Also:

RequestPredicates

toHttpHandler

public static org.springframework.http.server.reactive.HttpHandler toHttpHandler(RouterFunction<?> routerFunction)

Convert the given routing function into a HttpHandler. This conversion uses default strategies.

The returned HttpHandler can be adapted to run in

• Servlet 3.1+ using the ServletHttpHandlerAdapter,
• Reactor using the ReactorHttpHandlerAdapter,
• RxNetty using the RxNettyHttpHandlerAdapter, or
• Undertow using the UndertowHttpHandlerAdapter.

Parameters:

routerFunction - the routing function to convert

Returns:

an http handler that handles HTTP request using the given routing function

toHttpHandler

public static org.springframework.http.server.reactive.HttpHandler toHttpHandler(RouterFunction<?> routerFunction,
                                                                                 StrategiesSupplier strategies)

Convert the given routing function into a HttpHandler, using the given strategies.

The returned HttpHandler can be adapted to run in

• Servlet 3.1+ using the ServletHttpHandlerAdapter,
• Reactor using the ReactorHttpHandlerAdapter,
• RxNetty using the RxNettyHttpHandlerAdapter, or
• Undertow using the UndertowHttpHandlerAdapter.

Parameters:

routerFunction - the routing function to convert

strategies - the strategies to use

Returns:

an http handler that handles HTTP request using the given routing function

toHandlerMapping

public static HandlerMapping toHandlerMapping(RouterFunction<?> routerFunction)

Convert the given RouterFunction into a HandlerMapping. This conversion uses default strategies.

The returned HandlerMapping can be run in a DispatcherHandler.

Parameters:

routerFunction - the routing function to convert

Returns:

an handler mapping that maps HTTP request to a handler using the given routing function

See Also:

HandlerFunctionAdapter, ResponseResultHandler

toHandlerMapping

public static HandlerMapping toHandlerMapping(RouterFunction<?> routerFunction,
                                              StrategiesSupplier strategies)

Convert the given routing function into a HandlerMapping, using the given strategies.

The returned HandlerMapping can be run in a DispatcherHandler.

Parameters:

routerFunction - the routing function to convert

strategies - the strategies to use

Returns:

an handler mapping that maps HTTP request to a handler using the given routing function

See Also:

HandlerFunctionAdapter, ResponseResultHandler