Class RequestMappingHandlerMapping
- All Implemented Interfaces:
Aware
,BeanNameAware
,InitializingBean
,ApplicationContextAware
,EmbeddedValueResolverAware
,Ordered
,ServletContextAware
,MatchableHandlerMapping
,HandlerMapping
RequestMappingInfo
instances from type-level and method-level
@RequestMapping
and @HttpExchange
annotations in @Controller
classes.
Deprecation Note:
In 5.2.4,useSuffixPatternMatch
and
useRegisteredSuffixPatternMatch
were deprecated in order to discourage use of path extensions for request
mapping and for content negotiation (with similar deprecations in
ContentNegotiationManagerFactoryBean
). For further context, please read issue
#24179.- Since:
- 3.1
- Author:
- Arjen Poutsma, Rossen Stoyanchev, Sam Brannen, Olga Maciaszek-Sharma
-
Field Summary
Fields inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping
mappingsLogger
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
logger
Fields inherited from interface org.springframework.web.servlet.HandlerMapping
BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Detects handler methods at initialization.protected RequestMappingInfo
createRequestMappingInfo
(RequestMapping requestMapping, RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@RequestMapping
annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.protected RequestMappingInfo
createRequestMappingInfo
(HttpExchange httpExchange, RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@HttpExchange
annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.Obtain aRequestMappingInfo.BuilderConfiguration
that reflects the internal configuration of thisHandlerMapping
and can be used to setRequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration)
.Return the configuredContentNegotiationManager
.protected RequestCondition<?>
getCustomMethodCondition
(Method method) Provide a custom method-level request condition.protected RequestCondition<?>
getCustomTypeCondition
(Class<?> handlerType) Provide a custom type-level request condition.Deprecated.as of 5.2.4.protected RequestMappingInfo
getMappingForMethod
(Method method, Class<?> handlerType) Uses type-level and method-level@RequestMapping
and@HttpExchange
annotations to create theRequestMappingInfo
.The configured path prefixes as a read-only, possibly empty map.protected CorsConfiguration
initCorsConfiguration
(Object handler, Method method, RequestMappingInfo mappingInfo) Extract and return the CORS configuration for the mapping.protected boolean
Whether the given type is a handler with handler methods.match
(HttpServletRequest request, String pattern) Determine whether the request matches the given pattern.protected void
registerHandlerMethod
(Object handler, Method method, RequestMappingInfo mapping) Register a handler method and its unique mapping.void
registerMapping
(RequestMappingInfo mapping, Object handler, Method method) Register the given mapping.protected String[]
resolveEmbeddedValuesInPatterns
(String[] patterns) Resolve placeholder values in the given array of patterns.void
setContentNegotiationManager
(ContentNegotiationManager contentNegotiationManager) Set theContentNegotiationManager
to use to determine requested media types.void
setEmbeddedValueResolver
(StringValueResolver resolver) Set the StringValueResolver to use for resolving embedded definition values.void
setPathPrefixes
(Map<String, Predicate<Class<?>>> prefixes) Configure path prefixes to apply to controller methods.void
setPatternParser
(PathPatternParser patternParser) Set thePathPatternParser
to parsepatterns
with for URL path matching.void
setUseRegisteredSuffixPatternMatch
(boolean useRegisteredSuffixPatternMatch) Deprecated.as of 5.2.4.void
setUseSuffixPatternMatch
(boolean useSuffixPatternMatch) Deprecated.as of 5.2.4.void
setUseTrailingSlashMatch
(boolean useTrailingSlashMatch) Deprecated.as of 6.0, seePathPatternParser.setMatchOptionalTrailingSeparator(boolean)
boolean
Deprecated.as of 5.2.4.boolean
Deprecated.as of 5.2.4.boolean
Whether to match to URLs irrespective of the presence of a trailing slash.Methods inherited from class org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping
getDirectPaths, getHandlerInternal, getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch
Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMethodMapping
createHandlerMethod, detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, hasCorsConfigurationSource, initHandlerMethods, lookupHandlerMethod, processCandidateBean, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, unregisterMapping
Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping
adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, initApplicationContext, initInterceptors, initLookupPath, setAlwaysUseFullPath, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.web.servlet.HandlerMapping
getHandler, usesPathPatterns
Methods inherited from interface org.springframework.web.servlet.handler.MatchableHandlerMapping
getPatternParser
-
Constructor Details
-
RequestMappingHandlerMapping
public RequestMappingHandlerMapping()
-
-
Method Details
-
setPatternParser
Description copied from class:AbstractHandlerMapping
Set thePathPatternParser
to parsepatterns
with for URL path matching. Parsed patterns provide a more modern and efficient alternative to String path matching viaAntPathMatcher
.Note: This property is mutually exclusive with the below properties, all of which are not necessary for parsed patterns and are ignored when a
PathPatternParser
is available:AbstractHandlerMapping.setAlwaysUseFullPath(boolean)
-- parsed patterns always use the full path and consider the servletPath only when a Servlet is mapped by path prefix.AbstractHandlerMapping.setRemoveSemicolonContent(boolean)
-- parsed patterns always ignore semicolon content for path matching purposes, but path parameters remain available for use in controllers via@MatrixVariable
.AbstractHandlerMapping.setUrlDecode(boolean)
-- parsed patterns match one decoded path segment at a time and therefore don't need to decode the full path.AbstractHandlerMapping.setUrlPathHelper(org.springframework.web.util.UrlPathHelper)
-- for parsed patterns, the request path is parsed once inDispatcherServlet
or inServletRequestPathFilter
usingServletRequestPathUtils
and cached in a request attribute.AbstractHandlerMapping.setPathMatcher(org.springframework.util.PathMatcher)
-- a parsed patterns encapsulates the logic for path matching and does need aPathMatcher
.
By default, as of 6.0, this is set to a
PathPatternParser
instance with default settings and therefore use of parsed patterns is enabled. Set this tonull
to switch to String path matching viaAntPathMatcher
instead.- Overrides:
setPatternParser
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
patternParser
- the parser to use
-
setUseSuffixPatternMatch
Deprecated.as of 5.2.4. See class level note on the deprecation of path extension config options. As there is no replacement for this method, in 5.2.x it is necessary to set it tofalse
. In 5.3 the default changes tofalse
and use of this property becomes unnecessary.Whether to use suffix pattern match (".*") when matching patterns to requests. If enabled a method mapped to "/users" also matches to "/users.*".By default value this is set to
false
.Also see
setUseRegisteredSuffixPatternMatch(boolean)
for more fine-grained control over specific suffixes to allow.Note: This property is ignored when
setPatternParser(PathPatternParser)
is configured. -
setUseRegisteredSuffixPatternMatch
Deprecated.as of 5.2.4. See class level note on the deprecation of path extension config options.Whether suffix pattern matching should work only against path extensions explicitly registered with theContentNegotiationManager
. 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".
Note: This property is ignored when
setPatternParser(PathPatternParser)
is configured. -
setUseTrailingSlashMatch
Deprecated.as of 6.0, seePathPatternParser.setMatchOptionalTrailingSeparator(boolean)
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 was changed in 6.0 from
true
tofalse
in order to support the deprecation of the property. -
setPathPrefixes
Configure path prefixes to apply to controller methods.Prefixes are used to enrich the mappings of every
@RequestMapping
method and@HttpExchange
method whose controller type is matched by a correspondingPredicate
in the map. The prefix for the first matching predicate is used, assuming the input map has predictable order.Consider using
HandlerTypePredicate
to group controllers.- Parameters:
prefixes
- a map with path prefixes as key- Since:
- 5.1
-
getPathPrefixes
The configured path prefixes as a read-only, possibly empty map.- Since:
- 5.1
-
setContentNegotiationManager
Set theContentNegotiationManager
to use to determine requested media types. If not set, the default constructor is used. -
getContentNegotiationManager
Return the configuredContentNegotiationManager
. -
setEmbeddedValueResolver
Description copied from interface:EmbeddedValueResolverAware
Set the StringValueResolver to use for resolving embedded definition values.- Specified by:
setEmbeddedValueResolver
in interfaceEmbeddedValueResolverAware
-
afterPropertiesSet
public void afterPropertiesSet()Description copied from class:AbstractHandlerMethodMapping
Detects handler methods at initialization.- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Overrides:
afterPropertiesSet
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- See Also:
-
useSuffixPatternMatch
Deprecated.as of 5.2.4. See deprecation notice onsetUseSuffixPatternMatch(boolean)
.Whether to use registered suffixes for pattern matching. -
useRegisteredSuffixPatternMatch
Deprecated.as of 5.2.4. See deprecation notice onsetUseRegisteredSuffixPatternMatch(boolean)
.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
Deprecated.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. -
getBuilderConfiguration
Obtain aRequestMappingInfo.BuilderConfiguration
that reflects the internal configuration of thisHandlerMapping
and can be used to setRequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration)
.This is useful for programmatic registration of request mappings via
registerHandlerMethod(Object, Method, RequestMappingInfo)
.- Returns:
- the builder configuration that reflects the internal state
- Since:
- 5.3.14
-
isHandler
Whether the given type is a handler with handler methods.Expects a handler to have a type-level @
Controller
annotation.- Specified by:
isHandler
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
beanType
- the type of the bean being checked- Returns:
- "true" if this a handler type, "false" otherwise.
-
getMappingForMethod
Uses type-level and method-level@RequestMapping
and@HttpExchange
annotations to create theRequestMappingInfo
.- Specified by:
getMappingForMethod
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
method
- the method to provide a mapping forhandlerType
- the handler type, possibly a subtype of the method's declaring class- Returns:
- the created
RequestMappingInfo
, ornull
if the method does not have a@RequestMapping
or@HttpExchange
annotation - See Also:
-
getCustomTypeCondition
Provide a custom type-level request condition. The customRequestCondition
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 usingCompositeRequestCondition
to provide multiple custom conditions.- Parameters:
handlerType
- the handler type for which to create the condition- Returns:
- the condition, or
null
-
getCustomMethodCondition
Provide a custom method-level request condition. The customRequestCondition
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 usingCompositeRequestCondition
to provide multiple custom conditions.- Parameters:
method
- the handler method for which to create the condition- Returns:
- the condition, or
null
-
createRequestMappingInfo
protected RequestMappingInfo createRequestMappingInfo(RequestMapping requestMapping, @Nullable RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@RequestMapping
annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy. -
createRequestMappingInfo
protected RequestMappingInfo createRequestMappingInfo(HttpExchange httpExchange, @Nullable RequestCondition<?> customCondition) Create aRequestMappingInfo
from the supplied@HttpExchange
annotation, meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.- Since:
- 6.1
-
resolveEmbeddedValuesInPatterns
Resolve placeholder values in the given array of patterns.- Returns:
- a new array with updated patterns
-
registerMapping
Description copied from class:AbstractHandlerMethodMapping
Register the given mapping.This method may be invoked at runtime after initialization has completed.
- Overrides:
registerMapping
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
mapping
- the mapping for the handler methodhandler
- the handlermethod
- the method
-
registerHandlerMethod
Register a handler method and its unique mapping. Invoked at startup for each detected handler method.Note: To create the
RequestMappingInfo
, please usegetBuilderConfiguration()
and set the options onRequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration)
to match how thisHandlerMapping
is configured. This is important for example to ensure use ofPathPattern
orPathMatcher
based matching.- Overrides:
registerHandlerMethod
in classAbstractHandlerMethodMapping<RequestMappingInfo>
- Parameters:
handler
- the bean name of the handler or the handler instancemethod
- the method to registermapping
- the mapping conditions associated with the handler method
-
match
Description copied from interface:MatchableHandlerMapping
Determine whether the request matches the given pattern. Use this method whenMatchableHandlerMapping.getPatternParser()
returnsnull
which means that theHandlerMapping
is using String pattern matching.- Specified by:
match
in interfaceMatchableHandlerMapping
- Parameters:
request
- the current requestpattern
- the pattern to match- Returns:
- the result from request matching, or
null
if none
-
initCorsConfiguration
protected CorsConfiguration initCorsConfiguration(Object handler, Method method, RequestMappingInfo mappingInfo) Description copied from class:AbstractHandlerMethodMapping
Extract and return the CORS configuration for the mapping.- Overrides:
initCorsConfiguration
in classAbstractHandlerMethodMapping<RequestMappingInfo>
-