程序包 cn.taketoday.web.handler.method

类 RequestMappingHandlerMapping

java.lang.Object

cn.taketoday.context.support.ApplicationObjectSupport

cn.taketoday.web.handler.AbstractHandlerMapping

cn.taketoday.web.handler.method.AbstractHandlerMethodMapping<RequestMappingInfo>

cn.taketoday.web.handler.method.RequestMappingInfoHandlerMapping

cn.taketoday.web.handler.method.RequestMappingHandlerMapping

所有已实现的接口:

cn.taketoday.beans.factory.Aware, cn.taketoday.beans.factory.BeanNameAware, cn.taketoday.beans.factory.InitializingBean, cn.taketoday.context.ApplicationContextAware, cn.taketoday.context.expression.EmbeddedValueResolverAware, cn.taketoday.core.Ordered, HandlerMapping

public class RequestMappingHandlerMapping
extends RequestMappingInfoHandlerMapping

Creates RequestMappingInfo instances from type and method-level @RequestMapping annotations in @Controller classes.

从以下版本开始:

4.0 2022/4/1 22:38

作者:

Arjen Poutsma, Rossen Stoyanchev, Sam Brannen, Harry Yang

嵌套类概要

从类继承的嵌套类/接口 cn.taketoday.web.handler.method.AbstractHandlerMethodMapping

AbstractHandlerMethodMapping.MappingRegistration<T>, AbstractHandlerMethodMapping.MappingRegistry, AbstractHandlerMethodMapping.Match<T>

字段概要

字段

修饰符和类型	字段	说明
private final RequestMappingInfo.BuilderConfiguration	config
private ContentNegotiationManager	contentNegotiationManager
private static final HttpMethod[]	EMPTY_REQUEST_METHOD_ARRAY
private ResolvableParameterFactory	parameterFactory
private cn.taketoday.core.ParameterNameDiscoverer	parameterNameDiscoverer
private Map<String,Predicate<Class<?>>>	pathPrefixes
private ParameterResolvingRegistry	resolvingRegistry

从类继承的字段 cn.taketoday.web.handler.method.AbstractHandlerMethodMapping

mappingRegistry

从类继承的字段 cn.taketoday.web.handler.AbstractHandlerMapping

embeddedValueResolver, mappingsLogger

从类继承的字段 cn.taketoday.context.support.ApplicationObjectSupport

applicationContext, log, messageSourceAccessor

从接口继承的字段 cn.taketoday.web.HandlerMapping

HANDLER_MAPPING_BEAN_NAME

从接口继承的字段 cn.taketoday.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器	说明
RequestMappingHandlerMapping()

方法概要

修饰符和类型	方法	说明
void	afterPropertiesSet()	Detects handler methods at initialization.
protected HandlerMethod	createHandlerMethod(Object handler, Method method)	Create the HandlerMethod instance.
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.
protected RequestMappingInfo	createRequestMappingInfo(HttpExchange httpExchange, RequestCondition<?> customCondition)	Create a RequestMappingInfo from the supplied @HttpExchange annotation, or meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.
private RequestMappingInfo	createRequestMappingInfo(AnnotatedElement element)	Delegates to createRequestMappingInfo(RequestMapping, RequestCondition), supplying the appropriate custom RequestCondition depending on whether the supplied annotatedElement is a class or method.
RequestMappingInfo.BuilderConfiguration	getBuilderConfiguration()	Obtain a RequestMappingInfo.BuilderConfiguration that can reflects the internal configuration of this HandlerMapping and can be used to set RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration).
ContentNegotiationManager	getContentNegotiationManager()	Return the configured ContentNegotiationManager.
protected RequestCondition<?>	getCustomCondition(AnnotatedElement element)	Provide a custom method-level or type-level request condition.
protected RequestMappingInfo	getMappingForMethod(Method method, Class<?> handlerType)	Uses method and type-level @RequestMapping annotations to create the RequestMappingInfo.
(专用程序包) String	getPathPrefix(Class<?> handlerType)
Map<String,Predicate<Class<?>>>	getPathPrefixes()	The configured path prefixes as a read-only, possibly empty map.
protected CorsConfiguration	initCorsConfiguration(Object handler, HandlerMethod handlerMethod, Method method, RequestMappingInfo mappingInfo)	Extract and return the CORS configuration for the mapping.
protected boolean	isHandler(Class<?> beanType)	Whether the given type is a handler with handler methods.
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.
private String	resolveCorsAnnotationValue(String value)
protected String[]	resolveEmbeddedValuesInPatterns(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	setParameterNameDiscoverer(cn.taketoday.core.ParameterNameDiscoverer parameterNameDiscoverer)	Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. for default attribute names).
void	setPathPrefixes(Map<String,Predicate<Class<?>>> prefixes)	Configure path prefixes to apply to controller methods.
void	setResolvingRegistry(ParameterResolvingRegistry resolvingRegistry)
private static HttpMethod[]	toMethodArray(String method)
private static String[]	toStringArray(String value)
private void	updateConsumesCondition(RequestMappingInfo info, Method method)
private void	updateCorsConfig(CorsConfiguration config, CrossOrigin annotation)

从类继承的方法 cn.taketoday.web.handler.method.RequestMappingInfoHandlerMapping

getDirectPaths, getMappingComparator, getMatchingMapping, handleMatch, handleNoMatch

从类继承的方法 cn.taketoday.web.handler.method.AbstractHandlerMethodMapping

detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerInterceptors, getHandlerInternal, getHandlerMethods, getHandlerMethodsForMappingName, getInterceptors, getNamingStrategy, handlerMethodsInitialized, hasCorsConfigurationSource, initHandlerMethods, lookupHandlerMethod, processCandidateBean, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, setUseInheritedInterceptor, unregisterMapping

从类继承的方法 cn.taketoday.web.handler.AbstractHandlerMapping

detectMappedInterceptors, extendInterceptors, formatMappingName, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getOrder, getPatternParser, initApplicationContext, resolveEmbeddedVariables, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setEmbeddedValueResolver, setInterceptors, setOrder, setUseCaseSensitiveMatch, setUseTrailingSlashMatch

从类继承的方法 cn.taketoday.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, isContextRequired, obtainApplicationContext, requiredContextClass, setApplicationContext, unwrapContext, unwrapFactory

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

EMPTY_REQUEST_METHOD_ARRAY

private static final HttpMethod[] EMPTY_REQUEST_METHOD_ARRAY

pathPrefixes

private Map<String,Predicate<Class<?>>> pathPrefixes

contentNegotiationManager

private ContentNegotiationManager contentNegotiationManager

config

private final RequestMappingInfo.BuilderConfiguration config

resolvingRegistry

@Nullable
private ParameterResolvingRegistry resolvingRegistry

parameterFactory

private ResolvableParameterFactory parameterFactory

parameterNameDiscoverer

private cn.taketoday.core.ParameterNameDiscoverer parameterNameDiscoverer

构造器详细资料

RequestMappingHandlerMapping

public RequestMappingHandlerMapping()

方法详细资料

setPathPrefixes

public void setPathPrefixes(Map<String,Predicate<Class<?>>> prefixes)

Configure path prefixes to apply to controller methods.

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 key

getPathPrefixes

public Map<String,Predicate<Class<?>>> getPathPrefixes()

The configured path prefixes as a read-only, possibly empty map.

setContentNegotiationManager

public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)

Set the ContentNegotiationManager to use to determine requested media types. If not set, the default constructor is used.

getContentNegotiationManager

public ContentNegotiationManager getContentNegotiationManager()

Return the configured ContentNegotiationManager.

setParameterNameDiscoverer

public void setParameterNameDiscoverer(cn.taketoday.core.ParameterNameDiscoverer parameterNameDiscoverer)

Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. for default attribute names).

Default is a DefaultParameterNameDiscoverer.

setResolvingRegistry

public void setResolvingRegistry(@Nullable
 ParameterResolvingRegistry resolvingRegistry)

afterPropertiesSet

public void afterPropertiesSet()

从类复制的说明: AbstractHandlerMethodMapping

Detects handler methods at initialization.

指定者:

afterPropertiesSet 在接口中 cn.taketoday.beans.factory.InitializingBean

覆盖:

afterPropertiesSet 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

另请参阅:

• AbstractHandlerMethodMapping.initHandlerMethods()

getBuilderConfiguration

public RequestMappingInfo.BuilderConfiguration getBuilderConfiguration()

Obtain a RequestMappingInfo.BuilderConfiguration that can reflects the internal configuration of this HandlerMapping and can be used to set RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration).

This is useful for programmatic registration of request mappings via registerHandlerMethod(Object, Method, RequestMappingInfo).

返回:

the builder configuration that reflects the internal state

isHandler

protected boolean isHandler(Class<?> beanType)

Whether the given type is a handler with handler methods.

Expects a handler to have either a type-level @Controller annotation or a type-level @RequestMapping annotation.

指定者:

isHandler 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

参数:

beanType - the type of the bean being checked

返回:

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

createHandlerMethod

protected HandlerMethod createHandlerMethod(Object handler,
 Method method)

从类复制的说明: AbstractHandlerMethodMapping

Create the HandlerMethod instance.

覆盖:

createHandlerMethod 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

参数:

handler - either a bean name or an actual handler instance

method - the target method

返回:

the created HandlerMethod

getMappingForMethod

@Nullable
protected RequestMappingInfo getMappingForMethod(Method method,
 Class<?> handlerType)

Uses method and type-level @RequestMapping annotations to create the RequestMappingInfo.

指定者:

getMappingForMethod 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

参数:

method - the method to provide a mapping for

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

返回:

the created RequestMappingInfo, or null if the method does not have a @RequestMapping annotation.

另请参阅:

• getCustomCondition(AnnotatedElement)

getPathPrefix

@Nullable
String getPathPrefix(Class<?> handlerType)

createRequestMappingInfo

@Nullable
private RequestMappingInfo createRequestMappingInfo(AnnotatedElement element)

Delegates to createRequestMappingInfo(RequestMapping, RequestCondition), supplying the appropriate custom RequestCondition depending on whether the supplied annotatedElement is a class or method.

另请参阅:

• getCustomCondition(AnnotatedElement)

getCustomCondition

@Nullable
protected RequestCondition<?> getCustomCondition(AnnotatedElement element)

Provide a custom method-level or type-level request condition. The custom 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.

参数:

element - the handler method or handler type for which to create the condition

返回:

the condition, or null

createRequestMappingInfo

protected RequestMappingInfo createRequestMappingInfo(RequestMapping requestMapping,
 @Nullable
 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.

createRequestMappingInfo

protected RequestMappingInfo createRequestMappingInfo(HttpExchange httpExchange,
 @Nullable
 RequestCondition<?> customCondition)

Create a RequestMappingInfo from the supplied @HttpExchange annotation, or meta-annotation, or synthesized result of merging annotation attributes within an annotation hierarchy.

toStringArray

private static String[] toStringArray(String value)

toMethodArray

private static HttpMethod[] toMethodArray(String method)

resolveEmbeddedValuesInPatterns

protected String[] resolveEmbeddedValuesInPatterns(String[] patterns)

Resolve placeholder values in the given array of patterns.

返回:

a new array with updated patterns

registerMapping

public void registerMapping(RequestMappingInfo mapping,
 Object handler,
 Method method)

从类复制的说明: AbstractHandlerMethodMapping

Register the given mapping.

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

覆盖:

registerMapping 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

参数:

mapping - the mapping for the handler method

handler - the handler

method - the method

registerHandlerMethod

protected void registerHandlerMethod(Object handler,
 Method method,
 RequestMappingInfo mapping)

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

Note: To create the RequestMappingInfo, please use getBuilderConfiguration() and set the options on RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration) to match how this HandlerMapping is configured. This is important for example to ensure use of PathPattern or PathMatcher based matching.

覆盖:

registerHandlerMethod 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

参数:

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

updateConsumesCondition

private void updateConsumesCondition(RequestMappingInfo info,
 Method method)

initCorsConfiguration

protected CorsConfiguration initCorsConfiguration(Object handler,
 HandlerMethod handlerMethod,
 Method method,
 RequestMappingInfo mappingInfo)

从类复制的说明: AbstractHandlerMethodMapping

Extract and return the CORS configuration for the mapping.

覆盖:

initCorsConfiguration 在类中 AbstractHandlerMethodMapping<RequestMappingInfo>

updateCorsConfig

private void updateCorsConfig(CorsConfiguration config,
 @Nullable
 CrossOrigin annotation)

resolveCorsAnnotationValue

private String resolveCorsAnnotationValue(String value)