我的架构梦：（八）手写SpringMVC框架
手写SpringMVC框架
- 一、SpringMVC的请求处理流程
- 二、Spring MVC 高级技术
- 三、手写 SpringMVC 框架
- 四、代码仓库
手写SpringMVC框架之前呢，我觉得有必要先了解SpringMVC的请求处理流程以及高级特性。
一、SpringMVC的请求处理流程
1、请求处理流程
流程说明：
第一步：用户发送请求至前端控制器DispatcherServlet。
第二步：DispatcherServlet收到请求调用HandlerMapping处理器映射器。
第三步：处理器映射器根据请求Url找到具体的Handler(后端控制器)，生成处理器对象及处理器拦截器(如果有则生成)一并返回DispatcherServlet。
第四步：DispatcherServlet调用HandlerAdapter处理器适配器去调用Handler。
第五步：处理器适配器执行Handler。
第六步：Handler执行完成给处理器适配器返回ModelAndView。
第七步：处理器适配器向前端控制器返回 ModelAndView，ModelAndView 是SpringMVC 框架的一个 底层对 象，包括 Model 和 View。
第八步：前端控制器请求视图解析器去进行视图解析，根据逻辑视图名来解析真正的视图。
第九步：视图解析器向前端控制器返回View。
第十步：前端控制器进行视图渲染，就是将模型数据(在 ModelAndView 对象中)填充到 request 域。
第十一步：前端控制器向用户响应结果。
2、Spring MVC 九大组件
-
HandlerMapping(处理器映射器)
HandlerMapping是用来查找Handler的，也就是处理器，具体的表现形式可以是类，也可以是方法。比如，标注了@RequestMapping的每个方法都可以看成是一个Handler。Handler负责具体实际的请求处理，在请求到达后，HandlerMapping的作用便是找到请求相应的处理器Handler和Interceptor。 -
HandlerAdapter(处理器适配器)
HandlerAdapter是一个适配器。因为Spring MVC中Handler可以是任意形式的，只要能处理请求即可。但是把请求交给Servlet的时候，由于Servlet的方法结构都是doService(HttpServletRequest req,HttpServletResponse resp)形式的，要让固定的Servlet处理方法调用Handler来进行处理，便是HandlerAdapter的职责。 -
HandlerExceptionResolver
HandlerExceptionResolver用于处理Handler产生的异常情况。它的作用是根据异常设置
ModelAndView，之后交给渲染方法进行渲染，渲染方法会将ModelAndView渲染成⻚面。 -
ViewResolver
ViewResolver即视图解析器，用于将String类型的视图名和Locale解析为View类型的视图，只有一 个resolveViewName()方法。从方法的定义可以看出，Controller层返回的String类型视图名viewName最终会在这里被解析成为View。View是用来渲染⻚面的，也就是说，它会将程序返回的参数和数据填入模板中，生成html文件。ViewResolver在这个过程主要完成两件事情:ViewResolver找到渲染所用的模板(第一件大事)和所用的技术(第二件大事，其实也就是找到视图的类型，如JSP)并填入参数。默认情况下，Spring MVC会自动为我们配置一个InternalResourceViewResolver，是针对JSP类型视图的。 -
RequestToViewNameTranslator
RequestToViewNameTranslator组件的作用是从请求中获取ViewName，因为ViewResolver根据ViewName查找View，但有的Handler处理完成之后，没有设置View，也没有设置ViewName， 便要通过这个组件从请求中查找ViewName。 -
LocaleResolver
ViewResolver组件的resolveViewName方法需要两个参数，一个是视图名，一个是Locale。LocaleResolver用于从请求中解析出Locale，比如中国Locale是zh-CN，用来表示一个区域。这 个组件也是i18n的基础。 -
ThemeResolver
ThemeResolver组件是用来解析主题的。主题是样式、图片及它们所形成的显示效果的集合。Spring MVC中一套主题对应一个properties文件，里面存放着与当前主题相关的所有资源，如图片、CSS样式等。创建主题非常简单，只需准备好资源，然后新建一个“主题名.properties”并将资源设置进去，放在classpath下，之后便可以在⻚面中使用了。SpringMVC中与主题相关的类有ThemeResolver、ThemeSource和Theme。ThemeResolver负责从请求中解析出主题名，ThemeSource根据主题名找到具体的主题，其抽象也就是Theme，可以通过Theme来获取主题和具体的资源。 -
MultipartResolver
MultipartResolver用于上传请求，通过将普通的请求包装成MultipartHttpServletRequest来实现。MultipartHttpServletRequest可以通过getFile()方法 直接获得文件。如果上传多个文件，还可以调用getFileMap()方法得到Map这样的结构，MultipartResolver的作用就是封装普通的请求，使其拥有文件上传的功能。 -
FlashMapManager
FlashMap用于重定向时的参数传递，比如在处理用户订单时候，为了避免重复提交，可以处理完post请求之后重定向到一个get请求，这个get请求可以用来显示订单详情之类的信息。这样做虽然可以规避用户重新提交订单的问题，但是在这个⻚面上要显示订单的信息，这些数据从哪里来获得呢？因为重定向时么有传递参数这一功能的，如果不想把参数写进URL(不推荐)，那么就可以通过FlashMap来传递。只需要在重定向之前将要传递的数据写入请求(可以通过
ServletRequestAttributes.getRequest()方法获得)的属性OUTPUT_FLASH_MAP_ATTRIBUTE中，这样在重定向之后的Handler中Spring就会自动将其设置到Model中，在显示订单信息的⻚面 上就可以直接从Model中获取数据。FlashMapManager就是用来管理FalshMap的。
二、Spring MVC 高级技术
监听器、过滤器和拦截器对比
-
Servlet：处理Request请求和Response响应。 -
过滤器(Filter)：对Request请求起到过滤的作用，作用在Servlet之前，如果配置为/*可以对所有的资源访问(servlet、js/css静态资源等)进行过滤处理。 -
监听器(Listener)：实现了javax.servlet.ServletContextListener接口的服务器端组件，它随Web应用的启动而启动，只初始化一次，然后会一直运行监视，随Web应用的停止而销毁。作用一：做一些初始化工作，
web应用中spring容器启动ContextLoaderListener。
作用二：监听web中的特定事件，比如HttpSession，ServletRequest的创建和销毁；变量的创建、 销毁和修改等。可以在某些动作前后增加处理，实现监控，比如统计在线人数，利用HttpSessionLisener等。 -
拦截器(Interceptor)：是SpringMVC、Struts等表现层框架自己的，不会拦截jsp/html/css/image的访问等，只会拦截访问的控制器方法(Handler)。从配置的⻆度也能够总结发现：
serlvet、filter、listener是配置在web.xml中的，而interceptor是配置在表现层框架自己的配置文件中的。在
Handler业务逻辑执行之前拦截一次
在Handler逻辑执行完毕但未跳转⻚面之前拦截一次
在跳转⻚面之后拦截一次
关于它们更详细的区别，可以看下这篇博文： SpringBoot项目中自定义Filter过滤器、Listener监听器、Interceptor拦截器和Servlet容器
三、手写 SpringMVC 框架
好了，回顾完请求处理流程与一些高级特性后，我们开始来手写 SpringMVC 框架了。
我们来梳理下流程，为了更加清晰手写 SpringMVC 框架的思路，我画了下面这张图：
1、自定义注解类
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Controller {
String value() default "";
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Service {
String value() default "";
}
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestMapping {
String value() default "";
}
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Autowired {
String value() default "";
}
2、DispatcherServlet 最核心的类
public class DispatcherServlet extends HttpServlet {
private Properties properties = new Properties();
private List<String> classNames = Lists.newArrayList(); // 缓存扫描
private Map<String, Object> ioc = Maps.newHashMap(); // ioc容器
// handlerMapping
// private Map handlerMapping = Maps.newHashMap(); // 存储url和method之间的映射关系
private List<Handler> handlerMapping = Lists.newArrayList();
@Override
public void init(ServletConfig servletConfig) throws ServletException {
// 1.加载配置文件 springmvc.properties
String contextConfigLocation = servletConfig.getInitParameter("contextConfigLocation");
doLoadConfig(contextConfigLocation);
// 2.扫描相关的类，扫描注解。
doScan(properties.getProperty("scanPackage"));
// 3.初始化bean对象（实现ioc容器，基于注解）
doInstance();
// 4.实现依赖注入
doAutowired();
// 5.构造一个HandlerMapping处理器映射器，将配置好的url和Method建立映射关系
initHandlerMapping();
System.out.println("riemann mvc init success...");
// 6.等待请求进入，处理请求。
}
/**
* 构造一个HandlerMapping处理器映射器
* 最关键的步骤
* 目的：将url和method建立关联
*/
private void initHandlerMapping() {
if (ioc.isEmpty()) return;
for (Map.Entry<String, Object> entry : ioc.entrySet()) {
// 获取ioc容器中当前遍历的对象的class类型
Class<?> clazz = entry.getValue().getClass();
if (!clazz.isAnnotationPresent(Controller.class)) continue;
String baseUrl = "";
if (clazz.isAnnotationPresent(RequestMapping.class)) {
RequestMapping annotation = clazz.getAnnotation(RequestMapping.class);
baseUrl = annotation.value(); // 等同于 /riemann
}
// 获取方法
Method[] methods = clazz.getMethods();
for (int i = 0; i < methods.length; i++) {
Method method = methods[i];
// 方法没有标识RequestMapping，就不处理
if (!method.isAnnotationPresent(RequestMapping.class)) continue;
// 如果标识则处理
RequestMapping annotation = method.getAnnotation(RequestMapping.class);
String methodUrl = annotation.value(); // 等同于 /query
String url = baseUrl + methodUrl; // 计算出来的url /riemann/query
// 把method所有信息及url封装为一个Handler
Handler handler = new Handler(entry.getValue(), method, Pattern.compile(url));
// 计算方法的参数位置信息 // query(HttpServletRequest request, HttpServletResponse response, String name)
Parameter[] parameters = method.getParameters();
for (int j = 0; j < parameters.length; j++) {
Parameter parameter = parameters[j];
if (parameter.getType() == HttpServletRequest.class || parameter.getType() == HttpServletResponse.class) {
// 如果是request和response对象，那么参数名称写HttpServletRequest和HttpServletResponse
handler.getParamIndexMapping().put(parameter.getType().getSimpleName(), j);
} else {
handler.getParamIndexMapping().put(parameter.getName(), j); // 3、pojo类Handler
/**
* 封装handler方法相关的信息
*/
@Data
public class Handler {
private Object controller; // method.invoke(obj,);
private Method method;
private Pattern pattern; // spring中url是支持正则的
private Map<String, Integer> paramIndexMapping; // 参数的顺序，是为了进行参数绑定。key是参数名，value是第几个参数
public Handler(Object controller, Method method, Pattern pattern) {
this.controller = controller;
this.method = method;
this.pattern = pattern;
paramIndexMapping = Maps.newHashMap();
}
}
4、web.xml配置
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<servlet>
<servlet-name>riemannmvc</servlet-name>
<servlet-class>com.riemann.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>springmvc.properties</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>riemannmvc</servlet-name>
<url-pattern>/*
5、RiemannController.java
@Controller
@RequestMapping("/riemann")
public class RiemannController {
@Autowired
private RiemannService riemannService;
/**
* URL: /riemann/query
* @param request
* @param response
* @param name
* @return
*/
@RequestMapping("/query")
public String query(HttpServletRequest request, HttpServletResponse response, String name) {
return riemannService.get(name);
}
}
6、测试结果
浏览器输入：http://localhost:8888/riemann/query?name=riemann
riemann mvc init success...
RiemannService 实现类中的name参数：riemann
ok，测试成功，这样就完成了手写SpringMVC框架的简易版了。
四、代码仓库
https://github.com/riemannChow/perseverance/tree/master/handwriting-framework/springmvc