org.springframework.web.servlet.mvc.annotation
Class DefaultAnnotationHandlerMapping
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.AbstractUrlHandlerMapping
org.springframework.web.servlet.handler.AbstractDetectingUrlHandlerMapping
org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping
- All Implemented Interfaces:
- ApplicationContextAware, Ordered, ServletContextAware, HandlerMapping
public class DefaultAnnotationHandlerMapping
- extends AbstractDetectingUrlHandlerMapping
Implementation of the HandlerMapping
interface that maps handlers based on HTTP paths expressed through the
RequestMapping
annotation at the type or method level.
Registered by default in DispatcherServlet
on Java 5+. NOTE: If you define custom HandlerMapping beans in your
DispatcherServlet context, you need to add a DefaultAnnotationHandlerMapping bean
explicitly, since custom HandlerMapping beans replace the default mapping strategies.
Defining a DefaultAnnotationHandlerMapping also allows for registering custom
interceptors:
<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">
<property name="interceptors">
...
</property>
</bean>
Annotated controllers are usually marked with the Controller
stereotype
at the type level. This is not strictly necessary when RequestMapping
is
applied at the type level (since such a handler usually implements the
Controller
interface). However,
Controller
is required for detecting RequestMapping
annotations
at the method level if RequestMapping
is not present at the type level.
NOTE: Method-level mappings are only allowed to narrow the mapping
expressed at the class level (if any). HTTP paths need to uniquely map onto
specific handler beans, with any given HTTP path only allowed to be mapped
onto one specific handler bean (not spread across multiple handler beans).
It is strongly recommended to co-locate related handler methods into the same bean.
The AnnotationMethodHandlerAdapter
is responsible for processing
annotated handler methods, as mapped by this HandlerMapping. For
RequestMapping
at the type level, specific HandlerAdapters such as
SimpleControllerHandlerAdapter
apply.
- Since:
- 2.5
- Author:
- Juergen Hoeller, Arjen Poutsma
- See Also:
RequestMapping
,
AnnotationMethodHandlerAdapter
Methods inherited from class org.springframework.web.servlet.handler.AbstractUrlHandlerMapping |
buildPathExposingHandler, exposePathWithinMapping, getHandlerInternal, getHandlerMap, getPathMatcher, getRootHandler, lookupHandler, registerHandler, registerHandler, setAlwaysUseFullPath, setLazyInitHandlers, setPathMatcher, setRootHandler, setUrlDecode, setUrlPathHelper |
Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping |
adaptInterceptor, extendInterceptors, getAdaptedInterceptors, getDefaultHandler, getHandler, getHandlerExecutionChain, getOrder, initInterceptors, setDefaultHandler, setInterceptors, setOrder |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DefaultAnnotationHandlerMapping
public DefaultAnnotationHandlerMapping()
setUseDefaultSuffixPattern
public void setUseDefaultSuffixPattern(boolean useDefaultSuffixPattern)
- Set whether to register paths using the default suffix pattern as well:
i.e. whether "/users" should be registered as "/users.*" too.
Default is "true". Turn this convention off if you intend to interpret
your @RequestMapping
paths strictly.
Note that paths which include a ".xxx" suffix already will not be
transformed using the default suffix pattern in any case.
determineUrlsForHandler
protected String[] determineUrlsForHandler(String beanName)
- Checks for presence of the
RequestMapping
annotation on the handler class and on any of its methods.
- Specified by:
determineUrlsForHandler
in class AbstractDetectingUrlHandlerMapping
- Parameters:
beanName
- the name of the candidate bean
- Returns:
- the URLs determined for the bean,
or
null
or an empty array if none
addUrlsForPath
protected void addUrlsForPath(Set<String> urls,
String path)
- Add URLs and/or URL patterns for the given path.
- Parameters:
urls
- the Set of URLs for the current beanpath
- the currently introspected path
Copyright © 2002-2007 The Spring Framework.