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

类 RouterFunctions

java.lang.Object
cn.taketoday.web.handler.function.RouterFunctions
public abstract class RouterFunctions extends Object
Central entry point to Infra functional web framework. Exposes routing functionality, such as to create a RouterFunction using a discoverable builder-style API, to create a RouterFunction given a RequestPredicate and HandlerFunction, and to do further subrouting on an existing routing function.
从以下版本开始:
4.0
作者:
Harry Yang, Arjen Poutsma

  • 字段详细资料

    • log

      private static final cn.taketoday.logging.Logger log

    • REQUEST_ATTRIBUTE

      public static final String REQUEST_ATTRIBUTE
      Name of the request attribute that contains the ServerRequest.

    • URI_TEMPLATE_VARIABLES_ATTRIBUTE

      public static final String URI_TEMPLATE_VARIABLES_ATTRIBUTE
      Name of the request attribute that contains the URI templates map, mapping variable names to values.

    • MATCHING_PATTERN_ATTRIBUTE

      public static final String MATCHING_PATTERN_ATTRIBUTE
      Name of the request attribute that contains the matching pattern, as a PathPattern.

  • 构造器详细资料

    • RouterFunctions

      public RouterFunctions()

  • 方法详细资料

    • route

      public static RouterFunctions.Builder route()
      Offers a discoverable way to create router functions through a builder-style interface.
      返回:
      a router function builder

    • route

      public static <T extends ServerResponse> RouterFunction<T> route(RequestPredicate predicate, HandlerFunction<T> handlerFunction)
      Route to the given handler function if the given request predicate applies.

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

       RouterFunction<ServerResponse> route =
     RouterFunctions.route(RequestPredicates.GET("/user"), userController::listUsers);
      类型参数:
      T - the type of response returned by the handler function
      参数:
      predicate - the predicate to test
      handlerFunction - the handler function to route to if the predicate applies
      返回:
      a router function that routes to handlerFunction if predicate evaluates to true
      另请参阅:

    • nest

      public static <T extends ServerResponse> RouterFunction<T> nest(RequestPredicate predicate, RouterFunction<T> routerFunction)
      Route to the given 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 first creates a composed route that resolves to listUsers for a GET, and createUser for a POST. This composed route then gets nested 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> userRoutes =
   RouterFunctions.route(RequestPredicates.method(HttpMethod.GET), this::listUsers)
     .andRoute(RequestPredicates.method(HttpMethod.POST), this::createUser);
 RouterFunction<ServerResponse> nestedRoute =
   RouterFunctions.nest(RequestPredicates.path("/user"), userRoutes);
      类型参数:
      T - the type of response returned by the handler function
      参数:
      predicate - the predicate to test
      routerFunction - the nested router function to delegate to if the predicate applies
      返回:
      a router function that routes to routerFunction if predicate evaluates to true
      另请参阅:

    • resources

      public static RouterFunction<ServerResponse> resources(String pattern, cn.taketoday.core.io.Resource location)
      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);
      参数:
      pattern - the pattern to match
      location - the location directory relative to which resources should be resolved
      返回:
      a router function that routes to resources
      另请参阅:

    • resourceLookupFunction

      public static Function<ServerRequest,Optional<cn.taketoday.core.io.Resource>> resourceLookupFunction(String pattern, cn.taketoday.core.io.Resource location)
      Returns the resource lookup function used by resources(String, Resource). The returned function can be composed on, for instance to return a default resource when the lookup function does not match: 
       Optional<Resource> defaultResource = Optional.of(new ClassPathResource("index.html"));
 Function<ServerRequest, Optional<Resource>> lookupFunction =
   RouterFunctions.resourceLookupFunction("/resources/**", new FileSystemResource("public-resources/"))
     .andThen(resource -> resource.or(() -> defaultResource));
 RouterFunction<ServerResponse> resources = RouterFunctions.resources(lookupFunction);
      参数:
      pattern - the pattern to match
      location - the location directory relative to which resources should be resolved
      返回:
      the default resource lookup function for the given parameters.

    • resources

      public static RouterFunction<ServerResponse> resources(Function<ServerRequest,Optional<cn.taketoday.core.io.Resource>> lookupFunction)
      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.
      参数:
      lookupFunction - the function to provide a Resource given the ServerRequest
      返回:
      a router function that routes to resources

    • changeParser

      public static <T extends ServerResponse> RouterFunction<T> changeParser(RouterFunction<T> routerFunction, PathPatternParser parser)
      Changes the PathPatternParser on the given router function. This method can be used to change the PathPatternParser properties from the defaults, for instance to change case sensitivity.
      类型参数:
      T - the type of response returned by the handler function
      参数:
      routerFunction - the router function to change the parser in
      parser - the parser to change to.
      返回:
      the change router function