类 RequestMappingHandlerMapping

构造器详细资料

• RequestMappingHandlerMapping

  public RequestMappingHandlerMapping()

方法详细资料

• setUseSuffixPatternMatch

  @Deprecated
  public void setUseSuffixPatternMatch​(boolean useSuffixPatternMatch)

  已过时。

  as of 5.2.4. See class level comment about deprecation of path extension config options. As there is no replacement for this method, for the time being it's necessary to set it to false. In 5.3 when false becomes the default, use of this property will no longer be necessary.
  Whether to use suffix pattern match (".*") when matching patterns to requests. If enabled a method mapped to "/users" also matches to "/users.*".

  The default value is true.

  Also see setUseRegisteredSuffixPatternMatch(boolean) for more fine-grained control over specific suffixes to allow.

• setUseRegisteredSuffixPatternMatch

  @Deprecated
  public void setUseRegisteredSuffixPatternMatch​(boolean useRegisteredSuffixPatternMatch)

  已过时。

  as of 5.2.4. See class level comment about deprecation of path extension config options.
  Whether suffix pattern matching should work only against path extensions explicitly registered with the ContentNegotiationManager. This is generally recommended to reduce ambiguity and to avoid issues such as when a "." appears in the path for other reasons.

  By default this is set to "false".

• setUseTrailingSlashMatch

  public void setUseTrailingSlashMatch​(boolean useTrailingSlashMatch)

  Whether to match to URLs irrespective of the presence of a trailing slash. If enabled a method mapped to "/users" also matches to "/users/".

  The default value is true.

• setPathPrefixes

  public void setPathPrefixes​(Map<String,​Predicate<Class<?>>> prefixes)

  Configure path prefixes to apply to controller methods.

  Prefixes are used to enrich the mappings of every @RequestMapping method whose controller type is matched by the corresponding Predicate. The prefix for the first matching predicate is used.

  Consider using HandlerTypePredicate to group controllers.

  参数:

  prefixes - a map with path prefixes as key

  从以下版本开始:

  5.1

• getPathPrefixes

  public Map<String,​Predicate<Class<?>>> getPathPrefixes()

  The configured path prefixes as a read-only, possibly empty map.

  从以下版本开始:

  5.1

• setContentNegotiationManager

  public void setContentNegotiationManager​(ContentNegotiationManager contentNegotiationManager)

  Set the ContentNegotiationManager to use to determine requested media types. If not set, the default constructor is used.

• getContentNegotiationManager

  public ContentNegotiationManager getContentNegotiationManager()

  Return the configured ContentNegotiationManager.

• setEmbeddedValueResolver

  public void setEmbeddedValueResolver​(StringValueResolver resolver)

  从接口复制的说明: EmbeddedValueResolverAware
  Set the StringValueResolver to use for resolving embedded definition values.

  指定者:

  setEmbeddedValueResolver 在接口中 EmbeddedValueResolverAware

• afterPropertiesSet

  public void afterPropertiesSet()

  从类复制的说明: AbstractHandlerMethodMapping
  Detects handler methods at initialization.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

  覆盖:

  afterPropertiesSet 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

  另请参阅:

  AbstractHandlerMethodMapping.initHandlerMethods()

• useSuffixPatternMatch

  @Deprecated
  public boolean useSuffixPatternMatch()

  已过时。

  as of 5.2.4. See class-level note on the deprecation of path extension config options.
  Whether to use registered suffixes for pattern matching.

• useRegisteredSuffixPatternMatch

  @Deprecated
  public boolean useRegisteredSuffixPatternMatch()

  已过时。

  as of 5.2.4. See class-level note on the deprecation of path extension config options.
  Whether to use registered suffixes for pattern matching.

• useTrailingSlashMatch

  public boolean useTrailingSlashMatch()

  Whether to match to URLs irrespective of the presence of a trailing slash.

• getFileExtensions

  @Nullable
  @Deprecated
  public List<String> getFileExtensions()

  已过时。

  as of 5.2.4. See class-level note on the deprecation of path extension config options.
  Return the file extensions to use for suffix pattern matching.

• isHandler

  protected boolean isHandler​(Class<?> beanType)

  Whether the given type is a handler with handler methods.

  Expects a handler to have either a type-level @Controller annotation or a type-level @RequestMapping annotation.

  指定者:

  isHandler 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

  参数:

  beanType - the type of the bean being checked

  返回:

  "true" if this a handler type, "false" otherwise.

• getMappingForMethod

  @Nullable
  protected RequestMappingInfo getMappingForMethod​(Method method,
                                                   Class<?> handlerType)

  Uses method and type-level @RequestMapping annotations to create the RequestMappingInfo.

  指定者:

  getMappingForMethod 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

  参数:

  method - the method to provide a mapping for

  handlerType - the handler type, possibly a sub-type of the method's declaring class

  返回:

  the created RequestMappingInfo, or null if the method does not have a @RequestMapping annotation.

  另请参阅:

  getCustomMethodCondition(Method), getCustomTypeCondition(Class)

• getCustomTypeCondition

  @Nullable
  protected RequestCondition<?> getCustomTypeCondition​(Class<?> handlerType)

  Provide a custom type-level request condition. The custom RequestCondition can be of any type so long as the same condition type is returned from all calls to this method in order to ensure custom request conditions can be combined and compared.

  Consider extending AbstractRequestCondition for custom condition types and using CompositeRequestCondition to provide multiple custom conditions.

  参数:

  handlerType - the handler type for which to create the condition

  返回:

  the condition, or null

• getCustomMethodCondition

  @Nullable
  protected RequestCondition<?> getCustomMethodCondition​(Method method)

  Provide a custom method-level request condition. The custom RequestCondition can be of any type so long as the same condition type is returned from all calls to this method in order to ensure custom request conditions can be combined and compared.

  Consider extending AbstractRequestCondition for custom condition types and using CompositeRequestCondition to provide multiple custom conditions.

  参数:

  method - the handler method for which to create the condition

  返回:

  the condition, or null

• createRequestMappingInfo

  protected RequestMappingInfo createRequestMappingInfo​(RequestMapping requestMapping,
                                                        @Nullable
                                                        RequestCondition<?> customCondition)

  Create a RequestMappingInfo from the supplied @RequestMapping annotation, which is either a directly declared annotation, a meta-annotation, or the synthesized result of merging annotation attributes within an annotation hierarchy.

• resolveEmbeddedValuesInPatterns

  protected String[] resolveEmbeddedValuesInPatterns​(String[] patterns)

  Resolve placeholder values in the given array of patterns.

  返回:

  a new array with updated patterns

• registerMapping

  public void registerMapping​(RequestMappingInfo mapping,
                              Object handler,
                              Method method)

  从类复制的说明: AbstractHandlerMethodMapping
  Register the given mapping.

  This method may be invoked at runtime after initialization has completed.

  覆盖:

  registerMapping 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

  参数:

  mapping - the mapping for the handler method

  handler - the handler

  method - the method

• registerHandlerMethod

  protected void registerHandlerMethod​(Object handler,
                                       Method method,
                                       RequestMappingInfo mapping)

  从类复制的说明: AbstractHandlerMethodMapping
  Register a handler method and its unique mapping. Invoked at startup for each detected handler method.

  覆盖:

  registerHandlerMethod 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

  参数:

  handler - the bean name of the handler or the handler instance

  method - the method to register

  mapping - the mapping conditions associated with the handler method

• match

  public RequestMatchResult match​(HttpServletRequest request,
                                  String pattern)

  从接口复制的说明: MatchableHandlerMapping
  Determine whether the given request matches the request criteria.

  指定者:

  match 在接口中 MatchableHandlerMapping

  参数:

  request - the current request

  pattern - the pattern to match

  返回:

  the result from request matching, or null if none

• initCorsConfiguration

  protected CorsConfiguration initCorsConfiguration​(Object handler,
                                                    Method method,
                                                    RequestMappingInfo mappingInfo)

  从类复制的说明: AbstractHandlerMethodMapping
  Extract and return the CORS configuration for the mapping.

  覆盖:

  initCorsConfiguration 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>