类 AbstractHandlerMethodMapping<T>

构造器详细资料

• AbstractHandlerMethodMapping

  public AbstractHandlerMethodMapping()

方法详细资料

• setDetectHandlerMethodsInAncestorContexts

  public void setDetectHandlerMethodsInAncestorContexts​(boolean detectHandlerMethodsInAncestorContexts)

  Whether to detect handler methods in beans in ancestor ApplicationContexts.

  Default is "false": Only beans in the current ApplicationContext are considered, i.e. only in the context that this HandlerMapping itself is defined in (typically the current DispatcherServlet's context).

  Switch this flag on to detect handler beans in ancestor contexts (typically the Spring root WebApplicationContext) as well.

  另请参阅:

  getCandidateBeanNames()

• setHandlerMethodMappingNamingStrategy

  public void setHandlerMethodMappingNamingStrategy​(HandlerMethodMappingNamingStrategy<T> namingStrategy)

  Configure the naming strategy to use for assigning a default name to every mapped handler method.

  The default naming strategy is based on the capital letters of the class name followed by "#" and then the method name, e.g. "TC#getFoo" for a class named TestController with method getFoo.

• getNamingStrategy

  @Nullable
  public HandlerMethodMappingNamingStrategy<T> getNamingStrategy()

  Return the configured naming strategy or null.

• getHandlerMethods

  public Map<T,​HandlerMethod> getHandlerMethods()

  Return a (read-only) map with all mappings and HandlerMethod's.

• getHandlerMethodsForMappingName

  @Nullable
  public List<HandlerMethod> getHandlerMethodsForMappingName​(String mappingName)

  Return the handler methods for the given mapping name.

  参数:

  mappingName - the mapping name

  返回:

  a list of matching HandlerMethod's or null; the returned list will never be modified and is safe to iterate.

  另请参阅:

  setHandlerMethodMappingNamingStrategy(org.springframework.web.servlet.handler.HandlerMethodMappingNamingStrategy<T>)

• registerMapping

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

  Register the given mapping.

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

  参数:

  mapping - the mapping for the handler method

  handler - the handler

  method - the method

• unregisterMapping

  public void unregisterMapping​(T mapping)

  Un-register the given mapping.

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

  参数:

  mapping - the mapping to unregister

• afterPropertiesSet

  public void afterPropertiesSet()

  Detects handler methods at initialization.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

  另请参阅:

  initHandlerMethods()

• initHandlerMethods

  protected void initHandlerMethods()

  Scan beans in the ApplicationContext, detect and register handler methods.

  另请参阅:

  getCandidateBeanNames(), processCandidateBean(java.lang.String), handlerMethodsInitialized(java.util.Map<T, org.springframework.web.method.HandlerMethod>)

• getCandidateBeanNames

  protected String[] getCandidateBeanNames()

  Determine the names of candidate beans in the application context.

  从以下版本开始:

  5.1

  另请参阅:

  setDetectHandlerMethodsInAncestorContexts(boolean), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(org.springframework.beans.factory.ListableBeanFactory, org.springframework.core.ResolvableType)

• processCandidateBean

  protected void processCandidateBean​(String beanName)

  Determine the type of the specified candidate bean and call detectHandlerMethods(java.lang.Object) if identified as a handler type.

  This implementation avoids bean creation through checking BeanFactory.getType(java.lang.String) and calling detectHandlerMethods(java.lang.Object) with the bean name.

  参数:

  beanName - the name of the candidate bean

  从以下版本开始:

  5.1

  另请参阅:

  isHandler(java.lang.Class<?>), detectHandlerMethods(java.lang.Object)

• detectHandlerMethods

  protected void detectHandlerMethods​(Object handler)

  Look for handler methods in the specified handler bean.

  参数:

  handler - either a bean name or an actual handler instance

  另请参阅:

  getMappingForMethod(java.lang.reflect.Method, java.lang.Class<?>)

• registerHandlerMethod

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

  Register a handler method and its unique mapping. Invoked at startup for each detected handler method.

  参数:

  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

  抛出:

  IllegalStateException - if another method was already registered under the same mapping

• createHandlerMethod

  protected HandlerMethod createHandlerMethod​(Object handler,
                                              Method method)

  Create the HandlerMethod instance.

  参数:

  handler - either a bean name or an actual handler instance

  method - the target method

  返回:

  the created HandlerMethod

• initCorsConfiguration

  @Nullable
  protected CorsConfiguration initCorsConfiguration​(Object handler,
                                                    Method method,
                                                    T mapping)

  Extract and return the CORS configuration for the mapping.

• handlerMethodsInitialized

  protected void handlerMethodsInitialized​(Map<T,​HandlerMethod> handlerMethods)

  Invoked after all handler methods have been detected.

  参数:

  handlerMethods - a read-only map with handler methods and mappings.

• getHandlerInternal

  protected HandlerMethod getHandlerInternal​(HttpServletRequest request)
                                      throws Exception

  Look up a handler method for the given request.

  指定者:

  getHandlerInternal 在类中 AbstractHandlerMapping

  参数:

  request - current HTTP request

  返回:

  the corresponding handler instance, or null if none found

  抛出:

  Exception - if there is an internal error

• lookupHandlerMethod

  @Nullable
  protected HandlerMethod lookupHandlerMethod​(String lookupPath,
                                              HttpServletRequest request)
                                       throws Exception

  Look up the best-matching handler method for the current request. If multiple matches are found, the best match is selected.

  参数:

  lookupPath - mapping lookup path within the current servlet mapping

  request - the current request

  返回:

  the best-matching handler method, or null if no match

  抛出:

  Exception

  另请参阅:

  handleMatch(Object, String, HttpServletRequest), handleNoMatch(Set, String, HttpServletRequest)

• handleMatch

  protected void handleMatch​(T mapping,
                             String lookupPath,
                             HttpServletRequest request)

  Invoked when a matching mapping is found.

  参数:

  mapping - the matching mapping

  lookupPath - mapping lookup path within the current servlet mapping

  request - the current request

• handleNoMatch

  @Nullable
  protected HandlerMethod handleNoMatch​(Set<T> mappings,
                                        String lookupPath,
                                        HttpServletRequest request)
                                 throws Exception

  Invoked when no matching mapping is not found.

  参数:

  mappings - all registered mappings

  lookupPath - mapping lookup path within the current servlet mapping

  request - the current request

  抛出:

  ServletException - in case of errors

  Exception

• hasCorsConfigurationSource

  protected boolean hasCorsConfigurationSource​(Object handler)

  从类复制的说明: AbstractHandlerMapping
  Return true if there is a CorsConfigurationSource for this handler.

  覆盖:

  hasCorsConfigurationSource 在类中 AbstractHandlerMapping

• getCorsConfiguration

  protected CorsConfiguration getCorsConfiguration​(Object handler,
                                                   HttpServletRequest request)

  从类复制的说明: AbstractHandlerMapping
  Retrieve the CORS configuration for the given handler.

  覆盖:

  getCorsConfiguration 在类中 AbstractHandlerMapping

  参数:

  handler - the handler to check (never null).

  request - the current request.

  返回:

  the CORS configuration for the handler, or null if none

• isHandler

  protected abstract boolean isHandler​(Class<?> beanType)

  Whether the given type is a handler with handler methods.

  参数:

  beanType - the type of the bean being checked

  返回:

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

• getMappingForMethod

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

  Provide the mapping for a handler method. A method for which no mapping can be provided is not a handler method.

  参数:

  method - the method to provide a mapping for

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

  返回:

  the mapping, or null if the method is not mapped

• getMappingPathPatterns

  protected abstract Set<String> getMappingPathPatterns​(T mapping)

  Extract and return the URL paths contained in the supplied mapping.

• getMatchingMapping

  @Nullable
  protected abstract T getMatchingMapping​(T mapping,
                                          HttpServletRequest request)

  Check if a mapping matches the current request and return a (potentially new) mapping with conditions relevant to the current request.

  参数:

  mapping - the mapping to get a match for

  request - the current HTTP servlet request

  返回:

  the match, or null if the mapping doesn't match

• getMappingComparator

  protected abstract Comparator<T> getMappingComparator​(HttpServletRequest request)

  Return a comparator for sorting matching mappings. The returned comparator should sort 'better' matches higher.

  参数:

  request - the current request

  返回:

  the comparator (never null)