public class RequestMappingHandlerMapping extends RequestMappingInfoHandlerMapping implements MatchableHandlerMapping, EmbeddedValueResolverAware
RequestMappingInfo
instances from type and method-level
@RequestMapping
annotations in
@Controller
classes.Modifier and Type | Field and Description |
---|---|
private RequestMappingInfo.BuilderConfiguration |
config |
private ContentNegotiationManager |
contentNegotiationManager |
private StringValueResolver |
embeddedValueResolver |
private java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> |
pathPrefixes |
private boolean |
useRegisteredSuffixPatternMatch |
private boolean |
useSuffixPatternMatch |
private boolean |
useTrailingSlashMatch |
logger
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
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor and Description |
---|
RequestMappingHandlerMapping() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Detects handler methods at initialization.
|
private RequestMappingInfo |
createRequestMappingInfo(java.lang.reflect.AnnotatedElement element)
Delegates to
createRequestMappingInfo(RequestMapping, RequestCondition) ,
supplying the appropriate custom RequestCondition depending on whether
the supplied annotatedElement is a class or method. |
protected RequestMappingInfo |
createRequestMappingInfo(RequestMapping requestMapping,
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. |
ContentNegotiationManager |
getContentNegotiationManager()
Return the configured
ContentNegotiationManager . |
protected RequestCondition<?> |
getCustomMethodCondition(java.lang.reflect.Method method)
Provide a custom method-level request condition.
|
protected RequestCondition<?> |
getCustomTypeCondition(java.lang.Class<?> handlerType)
Provide a custom type-level request condition.
|
java.util.List<java.lang.String> |
getFileExtensions()
Return the file extensions to use for suffix pattern matching.
|
protected RequestMappingInfo |
getMappingForMethod(java.lang.reflect.Method method,
java.lang.Class<?> handlerType)
Uses method and type-level @
RequestMapping annotations to create
the RequestMappingInfo. |
(package private) java.lang.String |
getPathPrefix(java.lang.Class<?> handlerType) |
java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> |
getPathPrefixes()
The configured path prefixes as a read-only, possibly empty map.
|
protected CorsConfiguration |
initCorsConfiguration(java.lang.Object handler,
java.lang.reflect.Method method,
RequestMappingInfo mappingInfo)
Extract and return the CORS configuration for the mapping.
|
protected boolean |
isHandler(java.lang.Class<?> beanType)
Whether the given type is a handler with handler methods.
|
RequestMatchResult |
match(HttpServletRequest request,
java.lang.String pattern)
Determine whether the given request matches the request criteria.
|
private java.lang.String |
resolveCorsAnnotationValue(java.lang.String value) |
protected java.lang.String[] |
resolveEmbeddedValuesInPatterns(java.lang.String[] patterns)
Resolve placeholder values in the given array of patterns.
|
void |
setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)
Set the
ContentNegotiationManager to use to determine requested media types. |
void |
setEmbeddedValueResolver(StringValueResolver resolver)
Set the StringValueResolver to use for resolving embedded definition values.
|
void |
setPathPrefixes(java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> prefixes)
Configure path prefixes to apply to controller methods.
|
void |
setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch)
Whether suffix pattern matching should work only against path extensions
explicitly registered with the
ContentNegotiationManager . |
void |
setUseSuffixPatternMatch(boolean useSuffixPatternMatch)
Whether to use suffix pattern match (".*") when matching patterns to
requests.
|
void |
setUseTrailingSlashMatch(boolean useTrailingSlashMatch)
Whether to match to URLs irrespective of the presence of a trailing slash.
|
private void |
updateCorsConfig(CorsConfiguration config,
CrossOrigin annotation) |
boolean |
useRegisteredSuffixPatternMatch()
Whether to use registered suffixes for pattern matching.
|
boolean |
useSuffixPatternMatch()
Whether to use suffix pattern matching.
|
boolean |
useTrailingSlashMatch()
Whether to match to URLs irrespective of the presence of a trailing slash.
|
getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch
createHandlerMethod, detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerInternal, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, hasCorsConfigurationSource, initHandlerMethods, lookupHandlerMethod, processCandidateBean, registerHandlerMethod, registerMapping, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, unregisterMapping
adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getUrlPathHelper, initApplicationContext, initInterceptors, setAlwaysUseFullPath, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getHandler
private boolean useSuffixPatternMatch
private boolean useRegisteredSuffixPatternMatch
private boolean useTrailingSlashMatch
private java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> pathPrefixes
private ContentNegotiationManager contentNegotiationManager
@Nullable private StringValueResolver embeddedValueResolver
private RequestMappingInfo.BuilderConfiguration config
public void setUseSuffixPatternMatch(boolean useSuffixPatternMatch)
The default value is true
.
Also see setUseRegisteredSuffixPatternMatch(boolean)
for
more fine-grained control over specific suffixes to allow.
public void setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch)
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".
public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch)
The default value is true
.
public void setPathPrefixes(java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> prefixes)
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 keypublic java.util.Map<java.lang.String,java.util.function.Predicate<java.lang.Class<?>>> getPathPrefixes()
public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)
ContentNegotiationManager
to use to determine requested media types.
If not set, the default constructor is used.public ContentNegotiationManager getContentNegotiationManager()
ContentNegotiationManager
.public void setEmbeddedValueResolver(StringValueResolver resolver)
EmbeddedValueResolverAware
setEmbeddedValueResolver
in interface EmbeddedValueResolverAware
public void afterPropertiesSet()
AbstractHandlerMethodMapping
afterPropertiesSet
in interface InitializingBean
afterPropertiesSet
in class AbstractHandlerMethodMapping<RequestMappingInfo>
AbstractHandlerMethodMapping.initHandlerMethods()
public boolean useSuffixPatternMatch()
public boolean useRegisteredSuffixPatternMatch()
public boolean useTrailingSlashMatch()
@Nullable public java.util.List<java.lang.String> getFileExtensions()
protected boolean isHandler(java.lang.Class<?> beanType)
Expects a handler to have either a type-level @Controller
annotation or a type-level @RequestMapping
annotation.
isHandler
in class AbstractHandlerMethodMapping<RequestMappingInfo>
beanType
- the type of the bean being checked@Nullable protected RequestMappingInfo getMappingForMethod(java.lang.reflect.Method method, java.lang.Class<?> handlerType)
RequestMapping
annotations to create
the RequestMappingInfo.getMappingForMethod
in class AbstractHandlerMethodMapping<RequestMappingInfo>
method
- the method to provide a mapping forhandlerType
- the handler type, possibly a sub-type of the method's
declaring classnull
if the method
does not have a @RequestMapping
annotation.getCustomMethodCondition(Method)
,
getCustomTypeCondition(Class)
@Nullable java.lang.String getPathPrefix(java.lang.Class<?> handlerType)
@Nullable private RequestMappingInfo createRequestMappingInfo(java.lang.reflect.AnnotatedElement element)
createRequestMappingInfo(RequestMapping, RequestCondition)
,
supplying the appropriate custom RequestCondition
depending on whether
the supplied annotatedElement
is a class or method.@Nullable protected RequestCondition<?> getCustomTypeCondition(java.lang.Class<?> handlerType)
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 conditionnull
@Nullable protected RequestCondition<?> getCustomMethodCondition(java.lang.reflect.Method method)
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 conditionnull
protected RequestMappingInfo createRequestMappingInfo(RequestMapping requestMapping, @Nullable RequestCondition<?> customCondition)
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.protected java.lang.String[] resolveEmbeddedValuesInPatterns(java.lang.String[] patterns)
public RequestMatchResult match(HttpServletRequest request, java.lang.String pattern)
MatchableHandlerMapping
match
in interface MatchableHandlerMapping
request
- the current requestpattern
- the pattern to matchnull
if noneprotected CorsConfiguration initCorsConfiguration(java.lang.Object handler, java.lang.reflect.Method method, RequestMappingInfo mappingInfo)
AbstractHandlerMethodMapping
initCorsConfiguration
in class AbstractHandlerMethodMapping<RequestMappingInfo>
private void updateCorsConfig(CorsConfiguration config, @Nullable CrossOrigin annotation)
private java.lang.String resolveCorsAnnotationValue(java.lang.String value)