类 AbstractHandlerMethodMapping<T>
- java.lang.Object
- org.springframework.context.support.ApplicationObjectSupport
- org.springframework.web.context.support.WebApplicationObjectSupport
- org.springframework.web.servlet.handler.AbstractHandlerMapping
- org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<T>
- 类型参数:
T
- The mapping for aHandlerMethod
containing the conditions needed to match the handler method to incoming request.
- 所有已实现的接口:
Aware
,InitializingBean
,ApplicationContextAware
,Ordered
,ServletContextAware
,HandlerMapping
public abstract class AbstractHandlerMethodMapping<T> extends AbstractHandlerMapping implements InitializingBean
Abstract base class forHandlerMapping
implementations that define a mapping between a request and aHandlerMethod
.For each registered handler method, a unique mapping is maintained with subclasses defining the details of the mapping type
<T>
.- 从以下版本开始:
- 3.1
- 作者:
- Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller
字段概要
从类继承的字段 org.springframework.context.support.ApplicationObjectSupport
logger
从接口继承的字段 org.springframework.web.servlet.HandlerMapping
BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE
从接口继承的字段 org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
构造器概要
构造器 构造器 说明 AbstractHandlerMethodMapping()
方法概要
所有方法 实例方法 抽象方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Detects handler methods at initialization.protected HandlerMethod
createHandlerMethod(Object handler, Method method)
Create the HandlerMethod instance.protected void
detectHandlerMethods(Object handler)
Look for handler methods in a handler.protected CorsConfiguration
getCorsConfiguration(Object handler, HttpServletRequest request)
Retrieve the CORS configuration for the given handler.protected HandlerMethod
getHandlerInternal(HttpServletRequest request)
Look up a handler method for the given request.Map<T,HandlerMethod>
getHandlerMethods()
Return a (read-only) map with all mappings and HandlerMethod's.List<HandlerMethod>
getHandlerMethodsForMappingName(String mappingName)
Return the handler methods for the given mapping name.protected abstract Comparator<T>
getMappingComparator(HttpServletRequest request)
Return a comparator for sorting matching mappings.protected abstract T
getMappingForMethod(Method method, Class<?> handlerType)
Provide the mapping for a handler method.protected abstract Set<String>
getMappingPathPatterns(T mapping)
Extract and return the URL paths contained in a mapping.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.HandlerMethodMappingNamingStrategy<T>
getNamingStrategy()
Return the configured naming strategy ornull
.protected void
handleMatch(T mapping, String lookupPath, HttpServletRequest request)
Invoked when a matching mapping is found.protected HandlerMethod
handleNoMatch(Set<T> mappings, String lookupPath, HttpServletRequest request)
Invoked when no matching mapping is not found.protected void
handlerMethodsInitialized(Map<T,HandlerMethod> handlerMethods)
Invoked after all handler methods have been detected.protected CorsConfiguration
initCorsConfiguration(Object handler, Method method, T mapping)
Extract and return the CORS configuration for the mapping.protected void
initHandlerMethods()
Scan beans in the ApplicationContext, detect and register handler methods.protected abstract boolean
isHandler(Class<?> beanType)
Whether the given type is a handler with handler methods.protected HandlerMethod
lookupHandlerMethod(String lookupPath, HttpServletRequest request)
Look up the best-matching handler method for the current request.protected void
registerHandlerMethod(Object handler, Method method, T mapping)
Register a handler method and its unique mapping.void
registerMapping(T mapping, Object handler, Method method)
Register the given mapping.void
setDetectHandlerMethodsInAncestorContexts(boolean detectHandlerMethodsInAncestorContexts)
Whether to detect handler methods in beans in ancestor ApplicationContexts.void
setHandlerMethodMappingNamingStrategy(HandlerMethodMappingNamingStrategy<T> namingStrategy)
Configure the naming strategy to use for assigning a default name to every mapped handler method.void
unregisterMapping(T mapping)
Un-register the given mapping.从类继承的方法 org.springframework.web.servlet.handler.AbstractHandlerMapping
adaptInterceptor, detectMappedInterceptors, extendInterceptors, getAdaptedInterceptors, getCorsConfigurations, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getUrlPathHelper, initApplicationContext, initInterceptors, setAlwaysUseFullPath, setCorsConfigurations, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper
从类继承的方法 org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
从类继承的方法 org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext
构造器详细资料
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.
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
public HandlerMethodMappingNamingStrategy<T> getNamingStrategy()
Return the configured naming strategy ornull
.
getHandlerMethods
public Map<T,HandlerMethod> getHandlerMethods()
Return a (read-only) map with all mappings and HandlerMethod's.
getHandlerMethodsForMappingName
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 methodhandler
- the handlermethod
- 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
protected void initHandlerMethods()
Scan beans in the ApplicationContext, detect and register handler methods.
detectHandlerMethods
protected void detectHandlerMethods(Object handler)
Look for handler methods in a handler.- 参数:
handler
- the bean name of a handler or a handler instance
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 instancemethod
- the method to registermapping
- 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 instancemethod
- the target method- 返回:
- the created HandlerMethod
initCorsConfiguration
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
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 mappingrequest
- 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 mappinglookupPath
- mapping lookup path within the current servlet mappingrequest
- the current request
handleNoMatch
protected HandlerMethod handleNoMatch(Set<T> mappings, String lookupPath, HttpServletRequest request) throws Exception
Invoked when no matching mapping is not found.- 参数:
mappings
- all registered mappingslookupPath
- mapping lookup path within the current servlet mappingrequest
- the current request- 抛出:
ServletException
- in case of errorsException
getCorsConfiguration
protected CorsConfiguration getCorsConfiguration(Object handler, HttpServletRequest request)
从类复制的说明:AbstractHandlerMapping
Retrieve the CORS configuration for the given handler.- 覆盖:
getCorsConfiguration
在类中AbstractHandlerMapping
- 参数:
handler
- the handler to check (nevernull
).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
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 forhandlerType
- 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 a mapping.
getMatchingMapping
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 forrequest
- 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
)