Spring MVC中RequestMapping处理机制解析
在使用Spring MVC开发Web应用时,开发者通常通过@Controller与@RequestMapping注解来定义请求映射。例如:
@Controller
@RequestMapping("/test")
public class TestController {
@RequestMapping(value = "/show")
public String showPage() {
return "/jsp/index";
}
}
上述代码将/test/show路径映射到showPage方法上。虽然语法简洁,但其背后涉及了复杂的初始化和请求分发流程。本文基于spring-webmvc-4.3.7.RELEASE版本源码,深入剖析该机制的实现原理。
核心组件:HandlerMapping体系
Spring MVC的请求路由依赖于HandlerMapping接口,它负责根据HTTP请求查找对应的处理器(Handler)。其中,RequestMappingHandlerMapping是专门用于处理@RequestMapping注解的核心类。
启动阶段:自动注册映射处理器
启用注解驱动功能需在XML配置中声明:
<mvc:annotation-driven />
该标签属于自定义命名空间,其解析由NamespaceHandlerSupport完成。具体流程如下:
- 解析器识别
mvc命名空间,并定位到AnnotationDrivenBeanDefinitionParser。 - 该解析器创建一个类型为
RequestMappingHandlerMapping的RootBeanDefinition。 - 将其注册进容器,bean名称为
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping。
同时,还会注册RequestMappingHandlerAdapter等配套组件,构成完整的MVC基础设施。
初始化流程:构建请求映射关系
当Spring容器实例化RequestMappingHandlerMapping时,会触发以下关键行为:
- 实现ApplicationContextAware:注入当前应用上下文引用。
- 实现InitializingBean:在属性设置完成后调用
afterPropertiesSet()方法。
最终执行父类中的initHandlerMethods()方法,完成控制器方法扫描:
protected void initHandlerMethods() {
String[] beanNames = getApplicationContext().getBeanNamesForType(Object.class);
for (String beanName : beanNames) {
if (!isScopedTarget(beanName)) {
Class<?> type = getApplicationContext().getType(beanName);
if (type != null && isHandler(type)) {
detectHandlerMethods(beanName);
}
}
}
}
其中isHandler()判断类是否标注了@Controller或@RequestMapping:
protected boolean isHandler(Class<?> beanType) {
return AnnotatedElementUtils.hasAnnotation(beanType, Controller.class) ||
AnnotatedElementUtils.hasAnnotation(beanType, RequestMapping.class);
}
若符合条件,则进入detectHandlerMethods()进行方法级解析:
- 遍历目标类及其接口的所有公共方法。
- 检查每个方法是否有
@RequestMapping注解。 - 若有,则调用
getMappingForMethod()生成RequestMappingInfo对象,封装URL、HTTP方法、参数条件等元数据。 - 最终通过
registerHandlerMethod()将映射信息存入内部注册表mappingRegistry。
整个过程构建了一个从请求特征到具体Java方法的完整映射索引。
运行时:请求分发与处理
MVC容器初始化完成后,在FrameworkServlet.onRefresh()中调用initStrategies()加载所有HandlerMapping实例:
private void initHandlerMappings(ApplicationContext context) {
Map<String, HandlerMapping> matchingBeans =
BeanFactoryUtils.beansOfTypeIncludingAncestors(context, HandlerMapping.class, true, false);
this.handlerMappings = new ArrayList<>(matchingBeans.values());
AnnotationAwareOrderComparator.sort(this.handlerMappings);
}
所有请求由DispatcherServlet.service()接收,最终交由doDispatch()统一调度:
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HandlerExecutionChain handler = getHandler(request);
if (handler == null) {
response.sendError(HttpServletResponse.SC_NOT_FOUND);
return;
}
// 获取适配器并执行
HandlerAdapter ha = getHandlerAdapter(handler.getHandler());
ModelAndView mv = ha.handle(request, response, handler.getHandler());
// 视图渲染...
}
获取处理器的关键在于getHandler()方法:
protected HandlerExecutionChain getHandler(HttpServletRequest request) {
for (HandlerMapping hm : this.handlerMappings) {
HandlerExecutionChain handler = hm.getHandler(request);
if (handler != null) {
return handler;
}
}
return null;
}
以RequestMappingHandlerMapping为例,其getHandlerInternal()会从mappingRegistry中根据请求路径查找匹配的HandlerMethod:
protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) {
List<T> matches = mappingRegistry.getMappingsByUrl(lookupPath);
// 匹配最佳候选
...
}
一旦找到合适的处理器链,便交由对应的HandlerAdapter执行实际业务逻辑。
父子容器与组件扫描建议
值得注意的是,RequestMappingHandlerMapping仅扫描当前应用上下文中的bean,不会查找父容器。因此,若将带有@Controller的类定义在根容器(如Spring主配置)中,MVC子容器无法感知这些控制器,导致404错误。
推荐做法是分离配置:
- spring-mvc.xml:仅扫描控制器层
<context:component-scan base-package="com.example.controller" use-default-filters="false">
<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
- spring.xml:扫描其余组件,排除控制器
<context:component-scan base-package="com.example">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
此举避免重复注册,确保职责清晰。