类 AbstractHandlerMapping

构造器详细资料

• AbstractHandlerMapping

  public AbstractHandlerMapping()

方法详细资料

• setDefaultHandler

  public void setDefaultHandler​(@Nullable
                                Object defaultHandler)

  Set the default handler for this handler mapping. This handler will be returned if no specific mapping was found.

  Default is null, indicating no default handler.

• getDefaultHandler

  @Nullable
  public Object getDefaultHandler()

  Return the default handler for this handler mapping, or null if none.

• setAlwaysUseFullPath

  public void setAlwaysUseFullPath​(boolean alwaysUseFullPath)

  Shortcut to same property on underlying UrlPathHelper.

  另请参阅:

  UrlPathHelper.setAlwaysUseFullPath(boolean)

• setUrlDecode

  public void setUrlDecode​(boolean urlDecode)

  Shortcut to same property on underlying UrlPathHelper.

  另请参阅:

  UrlPathHelper.setUrlDecode(boolean)

• setRemoveSemicolonContent

  public void setRemoveSemicolonContent​(boolean removeSemicolonContent)

  Shortcut to same property on underlying UrlPathHelper.

  另请参阅:

  UrlPathHelper.setRemoveSemicolonContent(boolean)

• setUrlPathHelper

  public void setUrlPathHelper​(UrlPathHelper urlPathHelper)

  Set the UrlPathHelper to use for resolution of lookup paths.

  Use this to override the default UrlPathHelper with a custom subclass, or to share common UrlPathHelper settings across multiple HandlerMappings and MethodNameResolvers.

• getUrlPathHelper

  public UrlPathHelper getUrlPathHelper()

  Return the UrlPathHelper implementation to use for resolution of lookup paths.

• setPathMatcher

  public void setPathMatcher​(PathMatcher pathMatcher)

  Set the PathMatcher implementation to use for matching URL paths against registered URL patterns. Default is AntPathMatcher.

  另请参阅:

  AntPathMatcher

• getPathMatcher

  public PathMatcher getPathMatcher()

  Return the PathMatcher implementation to use for matching URL paths against registered URL patterns.

• setInterceptors

  public void setInterceptors​(Object... interceptors)

  Set the interceptors to apply for all handlers mapped by this handler mapping.

  Supported interceptor types are HandlerInterceptor, WebRequestInterceptor, and MappedInterceptor. Mapped interceptors apply only to request URLs that match its path patterns. Mapped interceptor beans are also detected by type during initialization.

  参数:

  interceptors - array of handler interceptors

  另请参阅:

  adaptInterceptor(java.lang.Object), HandlerInterceptor, WebRequestInterceptor

• setCorsConfigurations

  public void setCorsConfigurations​(Map<String,​CorsConfiguration> corsConfigurations)

  Set the "global" CORS configurations based on URL patterns. By default the first matching URL pattern is combined with the CORS configuration for the handler, if any.

  从以下版本开始:

  4.2

  另请参阅:

  setCorsConfigurationSource(CorsConfigurationSource)

• setCorsConfigurationSource

  public void setCorsConfigurationSource​(CorsConfigurationSource corsConfigurationSource)

  Set the "global" CORS configuration source. By default the first matching URL pattern is combined with the CORS configuration for the handler, if any.

  从以下版本开始:

  5.1

  另请参阅:

  setCorsConfigurations(Map)

• setCorsProcessor

  public void setCorsProcessor​(CorsProcessor corsProcessor)

  Configure a custom CorsProcessor to use to apply the matched CorsConfiguration for a request.

  By default DefaultCorsProcessor is used.

  从以下版本开始:

  4.2

• getCorsProcessor

  public CorsProcessor getCorsProcessor()

  Return the configured CorsProcessor.

• setOrder

  public void setOrder​(int order)

  Specify the order value for this HandlerMapping bean.

  The default value is Ordered.LOWEST_PRECEDENCE, meaning non-ordered.

  另请参阅:

  Ordered.getOrder()

• getOrder

  public int getOrder()

  从接口复制的说明: Ordered
  Get the order value of this object.

  Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

  Same order values will result in arbitrary sort positions for the affected objects.

  指定者:

  getOrder 在接口中 Ordered

  返回:

  the order value

  另请参阅:

  Ordered.HIGHEST_PRECEDENCE, Ordered.LOWEST_PRECEDENCE

• setBeanName

  public void setBeanName​(String name)

  从接口复制的说明: BeanNameAware
  Set the name of the bean in the bean factory that created this bean.

  Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

  指定者:

  setBeanName 在接口中 BeanNameAware

  参数:

  name - the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String) method to extract the original bean name (without suffix), if desired.

• formatMappingName

  protected String formatMappingName()

• initApplicationContext

  protected void initApplicationContext()
                                 throws BeansException

  Initializes the interceptors.

  覆盖:

  initApplicationContext 在类中 ApplicationObjectSupport

  抛出:

  ApplicationContextException - in case of initialization errors

  BeansException - if thrown by ApplicationContext methods

  另请参阅:

  extendInterceptors(java.util.List), initInterceptors()

• extendInterceptors

  protected void extendInterceptors​(List<Object> interceptors)

  Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see setInterceptors(java.lang.Object...)).

  Will be invoked before initInterceptors() adapts the specified interceptors into HandlerInterceptor instances.

  The default implementation is empty.

  参数:

  interceptors - the configured interceptor List (never null), allowing to add further interceptors before as well as after the existing interceptors

• detectMappedInterceptors

  protected void detectMappedInterceptors​(List<HandlerInterceptor> mappedInterceptors)

  Detect beans of type MappedInterceptor and add them to the list of mapped interceptors.

  This is called in addition to any MappedInterceptors that may have been provided via setInterceptors(java.lang.Object...), by default adding all beans of type MappedInterceptor from the current context and its ancestors. Subclasses can override and refine this policy.

  参数:

  mappedInterceptors - an empty list to add to

• initInterceptors

  protected void initInterceptors()

  Initialize the specified interceptors adapting WebRequestInterceptors to HandlerInterceptor.

  另请参阅:

  setInterceptors(java.lang.Object...), adaptInterceptor(java.lang.Object)

• adaptInterceptor

  protected HandlerInterceptor adaptInterceptor​(Object interceptor)

  Adapt the given interceptor object to HandlerInterceptor.

  By default, the supported interceptor types are HandlerInterceptor and WebRequestInterceptor. Each given WebRequestInterceptor is wrapped with WebRequestHandlerInterceptorAdapter.

  参数:

  interceptor - the interceptor

  返回:

  the interceptor downcast or adapted to HandlerInterceptor

  另请参阅:

  HandlerInterceptor, WebRequestInterceptor, WebRequestHandlerInterceptorAdapter

• getAdaptedInterceptors

  @Nullable
  protected final HandlerInterceptor[] getAdaptedInterceptors()

  Return the adapted interceptors as HandlerInterceptor array.

  返回:

  the array of HandlerInterceptors, or null if none

• getMappedInterceptors

  @Nullable
  protected final MappedInterceptor[] getMappedInterceptors()

  Return all configured MappedInterceptors as an array.

  返回:

  the array of MappedInterceptors, or null if none

• getHandler

  @Nullable
  public final HandlerExecutionChain getHandler​(HttpServletRequest request)
                                         throws Exception

  Look up a handler for the given request, falling back to the default handler if no specific one is found.

  指定者:

  getHandler 在接口中 HandlerMapping

  参数:

  request - current HTTP request

  返回:

  the corresponding handler instance, or the default handler

  抛出:

  Exception - if there is an internal error

  另请参阅:

  getHandlerInternal(javax.servlet.http.HttpServletRequest)

• getHandlerInternal

  @Nullable
  protected abstract Object getHandlerInternal​(HttpServletRequest request)
                                        throws Exception

  Look up a handler for the given request, returning null if no specific one is found. This method is called by getHandler(javax.servlet.http.HttpServletRequest); a null return value will lead to the default handler, if one is set.

  On CORS pre-flight requests this method should return a match not for the pre-flight request but for the expected actual request based on the URL path, the HTTP methods from the "Access-Control-Request-Method" header, and the headers from the "Access-Control-Request-Headers" header thus allowing the CORS configuration to be obtained via getCorsConfiguration(Object, HttpServletRequest),

  Note: This method may also return a pre-built HandlerExecutionChain, combining a handler object with dynamically determined interceptors. Statically specified interceptors will get merged into such an existing chain.

  参数:

  request - current HTTP request

  返回:

  the corresponding handler instance, or null if none found

  抛出:

  Exception - if there is an internal error

• getHandlerExecutionChain

  protected HandlerExecutionChain getHandlerExecutionChain​(Object handler,
                                                           HttpServletRequest request)

  Build a HandlerExecutionChain for the given handler, including applicable interceptors.

  The default implementation builds a standard HandlerExecutionChain with the given handler, the common interceptors of the handler mapping, and any MappedInterceptors matching to the current request URL. Interceptors are added in the order they were registered. Subclasses may override this in order to extend/rearrange the list of interceptors.

  NOTE: The passed-in handler object may be a raw handler or a pre-built HandlerExecutionChain. This method should handle those two cases explicitly, either building a new HandlerExecutionChain or extending the existing chain.

  For simply adding an interceptor in a custom subclass, consider calling super.getHandlerExecutionChain(handler, request) and invoking HandlerExecutionChain.addInterceptor(org.springframework.web.servlet.HandlerInterceptor) on the returned chain object.

  参数:

  handler - the resolved handler instance (never null)

  request - current HTTP request

  返回:

  the HandlerExecutionChain (never null)

  另请参阅:

  getAdaptedInterceptors()

• hasCorsConfigurationSource

  protected boolean hasCorsConfigurationSource​(Object handler)

  Return true if there is a CorsConfigurationSource for this handler.

  从以下版本开始:

  5.2

• getCorsConfiguration

  @Nullable
  protected CorsConfiguration getCorsConfiguration​(Object handler,
                                                   HttpServletRequest request)

  Retrieve the CORS configuration for the given handler.

  参数:

  handler - the handler to check (never null).

  request - the current request.

  返回:

  the CORS configuration for the handler, or null if none

  从以下版本开始:

  4.2

• getCorsHandlerExecutionChain

  protected HandlerExecutionChain getCorsHandlerExecutionChain​(HttpServletRequest request,
                                                               HandlerExecutionChain chain,
                                                               @Nullable
                                                               CorsConfiguration config)

  Update the HandlerExecutionChain for CORS-related handling.

  For pre-flight requests, the default implementation replaces the selected handler with a simple HttpRequestHandler that invokes the configured setCorsProcessor(org.springframework.web.cors.CorsProcessor).

  For actual requests, the default implementation inserts a HandlerInterceptor that makes CORS-related checks and adds CORS headers.

  参数:

  request - the current request

  chain - the handler chain

  config - the applicable CORS configuration (possibly null)

  从以下版本开始:

  4.2