程序包 cn.taketoday.web.handler.function

类 RouterFunctionBuilder

java.lang.Object

cn.taketoday.web.handler.function.RouterFunctionBuilder

所有已实现的接口:

RouterFunctions.Builder

class RouterFunctionBuilder
extends Object
implements RouterFunctions.Builder

Default implementation of RouterFunctions.Builder.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	RouterFunctionBuilder.BuiltRouterFunction	Router function returned by build() that simply iterates over the registered routes.

字段概要

字段

修饰符和类型	字段	说明
private final ArrayList<HandlerFilterFunction<ServerResponse,ServerResponse>>	errorHandlers
private final ArrayList<HandlerFilterFunction<ServerResponse,ServerResponse>>	filterFunctions
private final ArrayList<RouterFunction<ServerResponse>>	routerFunctions

构造器概要

构造器

构造器	说明
RouterFunctionBuilder()

方法概要

修饰符和类型	方法	说明
private RouterFunctions.Builder	add(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)
RouterFunctions.Builder	add(RouterFunction<ServerResponse> routerFunction)	Adds the given route to this builder.
RouterFunctions.Builder	after(BiFunction<ServerRequest,ServerResponse,ServerResponse> responseProcessor)	Filter the response object for all routes created by this builder with the given response processing function.
RouterFunctions.Builder	before(Function<ServerRequest,ServerRequest> requestProcessor)	Filter the request object for all routes created by this builder with the given request processing function.
RouterFunction<ServerResponse>	build()	Builds the RouterFunction.
RouterFunctions.Builder	DELETE(HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles HTTP DELETE requests.
RouterFunctions.Builder	DELETE(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP DELETE requests that match the given predicate.
RouterFunctions.Builder	DELETE(String pattern, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP DELETE requests that match the given pattern.
RouterFunctions.Builder	DELETE(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP DELETE requests that match the given pattern and predicate.
RouterFunctions.Builder	filter(HandlerFilterFunction<ServerResponse,ServerResponse> filterFunction)	Filters all routes created by this builder with the given filter function.
RouterFunctions.Builder	GET(HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles HTTP GET requests.
RouterFunctions.Builder	GET(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP GET requests that match the given predicate.
RouterFunctions.Builder	GET(String pattern, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP GET requests that match the given pattern.
RouterFunctions.Builder	GET(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP GET requests that match the given pattern and predicate.
RouterFunctions.Builder	HEAD(HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles HTTP HEAD requests.
RouterFunctions.Builder	HEAD(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP HEAD requests that match the given predicate.
RouterFunctions.Builder	HEAD(String pattern, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP HEAD requests that match the given pattern.
RouterFunctions.Builder	HEAD(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP HEAD requests that match the given pattern and predicate.
RouterFunctions.Builder	nest(RequestPredicate predicate, Consumer<RouterFunctions.Builder> builderConsumer)	Route to a built router function if the given request predicate applies.
RouterFunctions.Builder	nest(RequestPredicate predicate, Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)	Route to the supplied router function if the given request predicate applies.
RouterFunctions.Builder	onError(Class<? extends Throwable> exceptionType, BiFunction<Throwable,ServerRequest,ServerResponse> responseProvider)	Filters all exceptions of the given type by applying the given response provider function.
RouterFunctions.Builder	onError(Predicate<Throwable> predicate, BiFunction<Throwable,ServerRequest,ServerResponse> responseProvider)	Filters all exceptions that match the predicate by applying the given response provider function.
RouterFunctions.Builder	OPTIONS(HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles HTTP OPTIONS requests.
RouterFunctions.Builder	OPTIONS(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given predicate.
RouterFunctions.Builder	OPTIONS(String pattern, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given pattern.
RouterFunctions.Builder	OPTIONS(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given pattern and predicate.
RouterFunctions.Builder	PATCH(HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles HTTP PATCH requests.
RouterFunctions.Builder	PATCH(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP PATCH requests that match the given predicate.
RouterFunctions.Builder	PATCH(String pattern, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP PATCH requests that match the given pattern.
RouterFunctions.Builder	PATCH(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP PATCH requests that match the given pattern and predicate.
RouterFunctions.Builder	path(String pattern, Consumer<RouterFunctions.Builder> builderConsumer)	Route to a built router function if the given path prefix pattern applies.
RouterFunctions.Builder	path(String pattern, Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)	Route to the supplied router function if the given path prefix pattern applies.
RouterFunctions.Builder	POST(HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles HTTP POST requests.
RouterFunctions.Builder	POST(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP POST requests that match the given predicate.
RouterFunctions.Builder	POST(String pattern, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP POST requests that match the given pattern.
RouterFunctions.Builder	POST(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP POST requests that match the given pattern and predicate.
RouterFunctions.Builder	PUT(HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles HTTP PUT requests.
RouterFunctions.Builder	PUT(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP PUT requests that match the given predicate.
RouterFunctions.Builder	PUT(String pattern, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP PUT requests that match the given pattern.
RouterFunctions.Builder	PUT(String pattern, RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all HTTP PUT requests that match the given pattern and predicate.
RouterFunctions.Builder	resources(String pattern, cn.taketoday.core.io.Resource location)	Route requests that match the given pattern to resources relative to the given root location.
RouterFunctions.Builder	resources(Function<ServerRequest,Optional<cn.taketoday.core.io.Resource>> lookupFunction)	Route to resources using the provided lookup function.
RouterFunctions.Builder	route(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction)	Adds a route to the given handler function that handles all requests that match the given predicate.
RouterFunctions.Builder	withAttribute(String name, Object value)	Add an attribute with the given name and value to the last route built with this builder.
RouterFunctions.Builder	withAttributes(Consumer<Map<String,Object>> attributesConsumer)	Manipulate the attributes of the last route built with the given consumer.

从类继承的方法 java.lang.Object

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

字段详细资料

routerFunctions

private final ArrayList<RouterFunction<ServerResponse>> routerFunctions

errorHandlers

private final ArrayList<HandlerFilterFunction<ServerResponse,ServerResponse>> errorHandlers

filterFunctions

private final ArrayList<HandlerFilterFunction<ServerResponse,ServerResponse>> filterFunctions

构造器详细资料

RouterFunctionBuilder

RouterFunctionBuilder()

方法详细资料

add

public RouterFunctions.Builder add(RouterFunction<ServerResponse> routerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds the given route to this builder. Can be used to merge externally defined router functions into this builder, or can be combined with RouterFunctions.route(RequestPredicate, HandlerFunction) to allow for more flexible predicate matching.

For instance, the following example adds the router function returned from OrderController.routerFunction(). to the changeUser method in userController:

 RouterFunction<ServerResponse> route =
   RouterFunctions.route()
     .GET("/users", userController::listUsers)
     .add(orderController.routerFunction());
     .build();
 

指定者:

add 在接口中 RouterFunctions.Builder

参数:

routerFunction - the router function to be added

返回:

this builder

另请参阅:

• RequestPredicates

add

private RouterFunctions.Builder add(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

GET

public RouterFunctions.Builder GET(HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles HTTP GET requests.

指定者:

GET 在接口中 RouterFunctions.Builder

参数:

handlerFunction - the handler function to handle all GET requests

返回:

this builder

GET

public RouterFunctions.Builder GET(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP GET requests that match the given predicate.

指定者:

GET 在接口中 RouterFunctions.Builder

参数:

predicate - predicate to match

handlerFunction - the handler function to handle all GET requests that match predicate

返回:

this builder

另请参阅:

• RequestPredicates

GET

public RouterFunctions.Builder GET(String pattern,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP GET requests that match the given pattern.

指定者:

GET 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

handlerFunction - the handler function to handle all GET requests that match pattern

返回:

this builder

GET

public RouterFunctions.Builder GET(String pattern,
 RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP GET requests that match the given pattern and predicate.

For instance, the following example routes GET requests for "/user" that accept JSON to the listUsers method in userController:

 RouterFunction<ServerResponse> route =
   RouterFunctions.route()
     .GET("/user", RequestPredicates.accept(MediaType.APPLICATION_JSON), userController::listUsers)
     .build();
 

指定者:

GET 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

predicate - additional predicate to match

handlerFunction - the handler function to handle all GET requests that match pattern and the predicate

返回:

this builder

另请参阅:

• RequestPredicates

HEAD

public RouterFunctions.Builder HEAD(HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles HTTP HEAD requests.

指定者:

HEAD 在接口中 RouterFunctions.Builder

参数:

handlerFunction - the handler function to handle all HEAD requests

返回:

this builder

HEAD

public RouterFunctions.Builder HEAD(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP HEAD requests that match the given predicate.

指定者:

HEAD 在接口中 RouterFunctions.Builder

参数:

predicate - predicate to match

handlerFunction - the handler function to handle all HEAD requests that match predicate

返回:

this builder

另请参阅:

• RequestPredicates

HEAD

public RouterFunctions.Builder HEAD(String pattern,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP HEAD requests that match the given pattern.

指定者:

HEAD 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

handlerFunction - the handler function to handle all HEAD requests that match pattern

返回:

this builder

HEAD

public RouterFunctions.Builder HEAD(String pattern,
 RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP HEAD requests that match the given pattern and predicate.

指定者:

HEAD 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

predicate - additional predicate to match

handlerFunction - the handler function to handle all HEAD requests that match pattern

返回:

this builder

POST

public RouterFunctions.Builder POST(HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles HTTP POST requests.

指定者:

POST 在接口中 RouterFunctions.Builder

参数:

handlerFunction - the handler function to handle all POST requests

返回:

this builder

POST

public RouterFunctions.Builder POST(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP POST requests that match the given predicate.

指定者:

POST 在接口中 RouterFunctions.Builder

参数:

predicate - predicate to match

handlerFunction - the handler function to handle all POST requests that match predicate

返回:

this builder

另请参阅:

• RequestPredicates

POST

public RouterFunctions.Builder POST(String pattern,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP POST requests that match the given pattern.

指定者:

POST 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

handlerFunction - the handler function to handle all POST requests that match pattern

返回:

this builder

POST

public RouterFunctions.Builder POST(String pattern,
 RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP POST requests that match the given pattern and predicate.

For instance, the following example routes POST requests for "/user" that contain JSON to the addUser method in userController:

 RouterFunction<ServerResponse> route =
   RouterFunctions.route()
     .POST("/user", RequestPredicates.contentType(MediaType.APPLICATION_JSON), userController::addUser)
     .build();
 

指定者:

POST 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

predicate - additional predicate to match

handlerFunction - the handler function to handle all POST requests that match pattern

返回:

this builder

PUT

public RouterFunctions.Builder PUT(HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles HTTP PUT requests.

指定者:

PUT 在接口中 RouterFunctions.Builder

参数:

handlerFunction - the handler function to handle all PUT requests

返回:

this builder

PUT

public RouterFunctions.Builder PUT(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP PUT requests that match the given predicate.

指定者:

PUT 在接口中 RouterFunctions.Builder

参数:

predicate - predicate to match

handlerFunction - the handler function to handle all PUT requests that match predicate

返回:

this builder

另请参阅:

• RequestPredicates

PUT

public RouterFunctions.Builder PUT(String pattern,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP PUT requests that match the given pattern.

指定者:

PUT 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

handlerFunction - the handler function to handle all PUT requests that match pattern

返回:

this builder

PUT

public RouterFunctions.Builder PUT(String pattern,
 RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP PUT requests that match the given pattern and predicate.

For instance, the following example routes PUT requests for "/user" that contain JSON to the editUser method in userController:

 RouterFunction<ServerResponse> route =
   RouterFunctions.route()
     .PUT("/user", RequestPredicates.contentType(MediaType.APPLICATION_JSON), userController::editUser)
     .build();
 

指定者:

PUT 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

predicate - additional predicate to match

handlerFunction - the handler function to handle all PUT requests that match pattern

返回:

this builder

PATCH

public RouterFunctions.Builder PATCH(HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles HTTP PATCH requests.

指定者:

PATCH 在接口中 RouterFunctions.Builder

参数:

handlerFunction - the handler function to handle all PATCH requests

返回:

this builder

PATCH

public RouterFunctions.Builder PATCH(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP PATCH requests that match the given predicate.

指定者:

PATCH 在接口中 RouterFunctions.Builder

参数:

predicate - predicate to match

handlerFunction - the handler function to handle all PATCH requests that match predicate

返回:

this builder

另请参阅:

• RequestPredicates

PATCH

public RouterFunctions.Builder PATCH(String pattern,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP PATCH requests that match the given pattern.

指定者:

PATCH 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

handlerFunction - the handler function to handle all PATCH requests that match pattern

返回:

this builder

PATCH

public RouterFunctions.Builder PATCH(String pattern,
 RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP PATCH requests that match the given pattern and predicate.

For instance, the following example routes PATCH requests for "/user" that contain JSON to the editUser method in userController:

 RouterFunction<ServerResponse> route =
   RouterFunctions.route()
     .PATCH("/user", RequestPredicates.contentType(MediaType.APPLICATION_JSON), userController::editUser)
     .build();
 

指定者:

PATCH 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

predicate - additional predicate to match

handlerFunction - the handler function to handle all PATCH requests that match pattern

返回:

this builder

DELETE

public RouterFunctions.Builder DELETE(HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles HTTP DELETE requests.

指定者:

DELETE 在接口中 RouterFunctions.Builder

参数:

handlerFunction - the handler function to handle all DELETE requests

返回:

this builder

DELETE

public RouterFunctions.Builder DELETE(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP DELETE requests that match the given predicate.

指定者:

DELETE 在接口中 RouterFunctions.Builder

参数:

predicate - predicate to match

handlerFunction - the handler function to handle all DELETE requests that match predicate

返回:

this builder

另请参阅:

• RequestPredicates

DELETE

public RouterFunctions.Builder DELETE(String pattern,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP DELETE requests that match the given pattern.

指定者:

DELETE 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

handlerFunction - the handler function to handle all DELETE requests that match pattern

返回:

this builder

DELETE

public RouterFunctions.Builder DELETE(String pattern,
 RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP DELETE requests that match the given pattern and predicate.

指定者:

DELETE 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

predicate - additional predicate to match

handlerFunction - the handler function to handle all DELETE requests that match pattern

返回:

this builder

OPTIONS

public RouterFunctions.Builder OPTIONS(HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles HTTP OPTIONS requests.

指定者:

OPTIONS 在接口中 RouterFunctions.Builder

参数:

handlerFunction - the handler function to handle all OPTIONS requests

返回:

this builder

OPTIONS

public RouterFunctions.Builder OPTIONS(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given predicate.

指定者:

OPTIONS 在接口中 RouterFunctions.Builder

参数:

predicate - predicate to match

handlerFunction - the handler function to handle all OPTIONS requests that match predicate

返回:

this builder

另请参阅:

• RequestPredicates

OPTIONS

public RouterFunctions.Builder OPTIONS(String pattern,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given pattern.

指定者:

OPTIONS 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

handlerFunction - the handler function to handle all OPTIONS requests that match pattern

返回:

this builder

OPTIONS

public RouterFunctions.Builder OPTIONS(String pattern,
 RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all HTTP OPTIONS requests that match the given pattern and predicate.

指定者:

OPTIONS 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

predicate - additional predicate to match

handlerFunction - the handler function to handle all OPTIONS requests that match pattern

返回:

this builder

route

public RouterFunctions.Builder route(RequestPredicate predicate,
 HandlerFunction<ServerResponse> handlerFunction)

从接口复制的说明: RouterFunctions.Builder

Adds a route to the given handler function that handles all requests that match the given predicate.

指定者:

route 在接口中 RouterFunctions.Builder

参数:

predicate - the request predicate to match

handlerFunction - the handler function to handle all requests that match the predicate

返回:

this builder

另请参阅:

• RequestPredicates

resources

public RouterFunctions.Builder resources(String pattern,
 cn.taketoday.core.io.Resource location)

从接口复制的说明: RouterFunctions.Builder

Route requests that match the given pattern to resources relative to the given root location. For instance

 Resource location = new FileSystemResource("public-resources/");
 RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
 

指定者:

resources 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match

location - the location directory relative to which resources should be resolved

返回:

this builder

resources

public RouterFunctions.Builder resources(Function<ServerRequest,Optional<cn.taketoday.core.io.Resource>> lookupFunction)

从接口复制的说明: RouterFunctions.Builder

Route to resources using the provided lookup function. If the lookup function provides a Resource for the given request, it will be it will be exposed using a HandlerFunction that handles GET, HEAD, and OPTIONS requests.

指定者:

resources 在接口中 RouterFunctions.Builder

参数:

lookupFunction - the function to provide a Resource given the ServerRequest

返回:

this builder

nest

public RouterFunctions.Builder nest(RequestPredicate predicate,
 Consumer<RouterFunctions.Builder> builderConsumer)

从接口复制的说明: RouterFunctions.Builder

Route to a built router function if the given request predicate applies. This method can be used to create nested routes, where a group of routes share a common path (prefix), header, or other request predicate.

For instance, the following example creates a nested route with a "/user" path predicate, so that GET requests for "/user" will list users, and POST request for "/user" will create a new user.

 RouterFunction<ServerResponse> nestedRoute =
   RouterFunctions.route()
     .nest(RequestPredicates.path("/user"), builder ->
       builder.GET(this::listUsers)
              .POST(this::createUser))
     .build();
 

指定者:

nest 在接口中 RouterFunctions.Builder

参数:

predicate - the predicate to test

builderConsumer - consumer for a Builder that provides the nested router function

返回:

this builder

另请参阅:

• RequestPredicates

nest

public RouterFunctions.Builder nest(RequestPredicate predicate,
 Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)

从接口复制的说明: RouterFunctions.Builder

Route to the supplied router function if the given request predicate applies. This method can be used to create nested routes, where a group of routes share a common path (prefix), header, or other request predicate.

For instance, the following example creates a nested route with a "/user" path predicate, so that GET requests for "/user" will list users, and POST request for "/user" will create a new user.

 RouterFunction<ServerResponse> nestedRoute =
   RouterFunctions.route()
     .nest(RequestPredicates.path("/user"), () ->
       RouterFunctions.route()
         .GET(this::listUsers)
         .POST(this::createUser)
         .build())
     .build();
 

指定者:

nest 在接口中 RouterFunctions.Builder

参数:

predicate - the predicate to test

routerFunctionSupplier - supplier for the nested router function to delegate to if the predicate applies

返回:

this builder

另请参阅:

• RequestPredicates

path

public RouterFunctions.Builder path(String pattern,
 Consumer<RouterFunctions.Builder> builderConsumer)

从接口复制的说明: RouterFunctions.Builder

Route to a built router function if the given path prefix pattern applies. This method can be used to create nested routes, where a group of routes share a common path prefix.

For instance, the following example creates a nested route with a "/user" path predicate, so that GET requests for "/user" will list users, and POST request for "/user" will create a new user.

 RouterFunction<ServerResponse> nestedRoute =
   RouterFunctions.route()
     .path("/user", builder ->
       builder.GET(this::listUsers)
              .POST(this::createUser))
     .build();
 

指定者:

path 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

builderConsumer - consumer for a Builder that provides the nested router function

返回:

this builder

path

public RouterFunctions.Builder path(String pattern,
 Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)

从接口复制的说明: RouterFunctions.Builder

Route to the supplied router function if the given path prefix pattern applies. This method can be used to create nested routes, where a group of routes share a common path prefix. Specifically, this method can be used to merge externally defined router functions under a path prefix.

For instance, the following example creates a nested route with a "/user" path predicate that delegates to the router function defined in userController, and with a "/order" path that delegates to orderController.

 RouterFunction<ServerResponse> nestedRoute =
   RouterFunctions.route()
     .path("/user", userController::routerFunction)
     .path("/order", orderController::routerFunction)
     .build();
 

指定者:

path 在接口中 RouterFunctions.Builder

参数:

pattern - the pattern to match to

routerFunctionSupplier - supplier for the nested router function to delegate to if the pattern matches

返回:

this builder

filter

public RouterFunctions.Builder filter(HandlerFilterFunction<ServerResponse,ServerResponse> filterFunction)

从接口复制的说明: RouterFunctions.Builder

Filters all routes created by this builder with the given filter function. Filter functions are typically used to address cross-cutting concerns, such as logging, security, etc.

For instance, the following example creates a filter that returns a 401 Unauthorized response if the request does not contain the necessary authentication headers.

 RouterFunction<ServerResponse> filteredRoute =
   RouterFunctions.route()
     .GET("/user", this::listUsers)
     .filter((request, next) -> {
       // check for authentication headers
       if (isAuthenticated(request)) {
         return next.handle(request);
       }
       else {
         return ServerResponse.status(HttpStatus.UNAUTHORIZED).build();
       }
     })
     .build();
 

指定者:

filter 在接口中 RouterFunctions.Builder

参数:

filterFunction - the function to filter all routes built by this builder

返回:

this builder

before

public RouterFunctions.Builder before(Function<ServerRequest,ServerRequest> requestProcessor)

从接口复制的说明: RouterFunctions.Builder

Filter the request object for all routes created by this builder with the given request processing function. Filters are typically used to address cross-cutting concerns, such as logging, security, etc.

For instance, the following example creates a filter that logs the request before the handler function executes.

 RouterFunction<ServerResponse> filteredRoute =
   RouterFunctions.route()
     .GET("/user", this::listUsers)
     .before(request -> {
       log(request);
       return request;
     })
     .build();
 

指定者:

before 在接口中 RouterFunctions.Builder

参数:

requestProcessor - a function that transforms the request

返回:

this builder

after

public RouterFunctions.Builder after(BiFunction<ServerRequest,ServerResponse,ServerResponse> responseProcessor)

从接口复制的说明: RouterFunctions.Builder

Filter the response object for all routes created by this builder with the given response processing function. Filters are typically used to address cross-cutting concerns, such as logging, security, etc.

For instance, the following example creates a filter that logs the response after the handler function executes.

 RouterFunction<ServerResponse> filteredRoute =
   RouterFunctions.route()
     .GET("/user", this::listUsers)
     .after((request, response) -> {
       log(response);
       return response;
     })
     .build();
 

指定者:

after 在接口中 RouterFunctions.Builder

参数:

responseProcessor - a function that transforms the response

返回:

this builder

onError

public RouterFunctions.Builder onError(Predicate<Throwable> predicate,
 BiFunction<Throwable,ServerRequest,ServerResponse> responseProvider)

从接口复制的说明: RouterFunctions.Builder

Filters all exceptions that match the predicate by applying the given response provider function.

For instance, the following example creates a filter that returns a 500 response status when an IllegalStateException occurs.

 RouterFunction<ServerResponse> filteredRoute =
   RouterFunctions.route()
     .GET("/user", this::listUsers)
     .onError(e -> e instanceof IllegalStateException,
       (e, request) -> ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR).build())
     .build();
 

指定者:

onError 在接口中 RouterFunctions.Builder

参数:

predicate - the type of exception to filter

responseProvider - a function that creates a response

返回:

this builder

onError

public RouterFunctions.Builder onError(Class<? extends Throwable> exceptionType,
 BiFunction<Throwable,ServerRequest,ServerResponse> responseProvider)

从接口复制的说明: RouterFunctions.Builder

Filters all exceptions of the given type by applying the given response provider function.

For instance, the following example creates a filter that returns a 500 response status when an IllegalStateException occurs.

 RouterFunction<ServerResponse> filteredRoute =
   RouterFunctions.route()
     .GET("/user", this::listUsers)
     .onError(IllegalStateException.class,
       (e, request) -> ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR).build())
     .build();
 

指定者:

onError 在接口中 RouterFunctions.Builder

参数:

exceptionType - the type of exception to filter

responseProvider - a function that creates a response

返回:

this builder

withAttribute

public RouterFunctions.Builder withAttribute(String name,
 Object value)

从接口复制的说明: RouterFunctions.Builder

Add an attribute with the given name and value to the last route built with this builder.

指定者:

withAttribute 在接口中 RouterFunctions.Builder

参数:

name - the attribute name

value - the attribute value

返回:

this builder

withAttributes

public RouterFunctions.Builder withAttributes(Consumer<Map<String,Object>> attributesConsumer)

从接口复制的说明: RouterFunctions.Builder

Manipulate the attributes of the last route built with the given consumer.

The map provided to the consumer is "live", so that the consumer can be used to overwrite existing attributes, remove attributes, or use any of the other Map methods.

指定者:

withAttributes 在接口中 RouterFunctions.Builder

参数:

attributesConsumer - a function that consumes the attributes map

返回:

this builder

build

public RouterFunction<ServerResponse> build()

从接口复制的说明: RouterFunctions.Builder

Builds the RouterFunction. All created routes are composed with one another, and filters (if any) are applied to the result.

指定者:

build 在接口中 RouterFunctions.Builder

返回:

the built router function