SpringMVC原理分析（如何实现一个自己的SpringMVC）
SpringMVC简介
Spring Web MVC是一种基于Java的实现了Web MVC设计模式的请求驱动类型的轻量级Web框架，即使用了MVC架构模式的思想，将web层进行职责解耦，基于请求驱动指的就是使用请求-响应模型，框架的目的就是帮助我们简化开发，Spring Web MVC也是要简化我们日常Web开发的。
SpringMVC的优势
1、清晰的角色划分：前端控制器（DispatcherServlet）、请求到处理器映射（HandlerMapping）、处理器适配器（HandlerAdapter）、视图解析器（ViewResolver）、处理器或页面控制器（Controller）、验证器（ Validator）、命令对象（Command 请求参数绑定到的对象就叫命令对象）、表单对象（Form Object 提供给表单展示和提交到的对象就叫表单对象）。
2、分工明确，而且扩展点相当灵活，可以很容易扩展，虽然几乎不需要；
3、由于命令对象就是一个POJO，无需继承框架特定API，可以使用命令对象直接作为业务对象；
4、和Spring 其他框架无缝集成，是其它Web框架所不具备的；
5、可适配，通过HandlerAdapter可以支持任意的类作为处理器；
6、可定制性，HandlerMapping、ViewResolver等能够非常简单的定制；
7、功能强大的数据验证、格式化、绑定机制；
8、利用Spring提供的Mock对象能够非常简单的进行Web层单元测试；
9、本地化、主题的解析的支持，使我们更容易进行国际化和主题的切换。
10、强大的JSP标签库，使JSP编写更容易。
………………
还有比如RESTful风格的支持、简单的文件上传、约定大于配置的契约式编程支持、基于注解的零配置支持等等。
SpringMVC原理和运行流程
废话不多说，我们进入今天的正题，在Web应用程序设计中，MVC模式已经被广泛使用。SpringMVC以DispatcherServlet为核心，负责协调和组织不同组件以完成请求处理并返回响应的工作，实现了MVC模式。想要实现自己的SpringMVC框架，需要从以下几点入手：
一、了解SpringMVC运行流程及九大组件
二、梳理自己的SpringMVC的设计思路
三、实现自己的SpringMVC框架
1、SpringMVC的运行流程
我们用一个图来描述整个流程：
2、SpringMVC的9大组件（【SpringMVC】9大组件概览）
protected void initStrategies(ApplicationContext context) {
//用于处理上传请求。处理方法是将普通的request包装成MultipartHttpServletRequest，后者可以直接调用getFile方法获取File.
initMultipartResolver(context);
//SpringMVC主要有两个地方用到了Locale：一是ViewResolver视图解析的时候；二是用到国际化资源或者主题的时候。
initLocaleResolver(context);
//用于解析主题。SpringMVC中一个主题对应一个properties文件，里面存放着跟当前主题相关的所有资源、
//如图片、css样式等。SpringMVC的主题也支持国际化，
initThemeResolver(context);
//用来查找Handler的。
initHandlerMappings(context);
//从名字上看，它就是一个适配器。Servlet需要的处理方法的结构却是固定的，都是以request和response为参数的方法。
//如何让固定的Servlet处理方法调用灵活的Handler来进行处理呢？这就是HandlerAdapter要做的事情
initHandlerAdapters(context);
//其它组件都是用来干活的。在干活的过程中难免会出现问题，出问题后怎么办呢？
//这就需要有一个专门的角色对异常情况进行处理，在SpringMVC中就是HandlerExceptionResolver。
initHandlerExceptionResolvers(context);
//有的Handler处理完后并没有设置View也没有设置ViewName，这时就需要从request获取ViewName了，
//如何从request中获取ViewName就是RequestToViewNameTranslator要做的事情了。
initRequestToViewNameTranslator(context);
//ViewResolver用来将String类型的视图名和Locale解析为View类型的视图。
//View是用来渲染页面的，也就是将程序返回的参数填入模板里，生成html（也可能是其它类型）文件。
initViewResolvers(context);
//用来管理FlashMap的，FlashMap主要用在redirect重定向中传递参数。
initFlashMapManager(context);
}SpringMVC的设计思路
本文只实现自己的@Controller、@RequestMapping、@RequestParam注解起作用，其余SpringMVC功能读者可以尝试自己实现。
1、读取配置
从图中可以看出，SpringMVC本质上是一个Servlet,这个 Servlet 继承自 HttpServlet。FrameworkServlet负责初始化SpringMVC的容器，并将Spring容器设置为父容器。因为本文只是实现SpringMVC，对于Spring容器不做过多讲解。
为了读取web.xml中的配置，我们用到ServletConfig这个类，它代表当前Servlet在web.xml中的配置信息。通过web.xml中加载我们自己写的MyDispatcherServlet和读取配置文件。
2、初始化阶段
在前面我们提到DispatcherServlet的initStrategies方法会初始化9大组件，但是这里将实现一些SpringMVC的最基本的组件而不是全部，按顺序包括：
加载配置文件
扫描用户配置包下面所有的类
拿到扫描到的类，通过反射机制，实例化。并且放到ioc容器中(Map的键值对 beanName-bean) beanName默认是首字母小写
初始化HandlerMapping，这里其实就是把url和method对应起来放在一个k-v的Map中,在运行阶段取出
3、运行阶段
每一次请求将会调用doGet或doPost方法，所以统一运行阶段都放在doDispatch方法里处理，它会根据url请求去HandlerMapping中匹配到对应的Method，然后利用反射机制调用Controller中的url对应的方法，并得到结果返回。按顺序包括以下功能：
异常的拦截获取请求传入的参数并处理参数
通过初始化好的handlerMapping中拿出url对应的方法名，反射调用。
实现自己的SpringMVC框架
工程以及目录结果:
maven的配置文件如下，不包含任何springMVC的东西，只有servlet的jar。
4.0.0
com.rocky.study
springMVC
0.0.1-SNAPSHOT
war
UTF-8
1.7
1.7
1.7
javax.servlet
javax.servlet-api
3.0.1
provided
然后我们在WEB-INF\web.xml中加入如下配置：
MySpringMVC
com.study.framework.servlet.MyDispatcherServlet
contextConfigLocation
application.properties
1
MySpringMVC
/*
application.properties文件中只是配置要扫描的包注入到SpringMVC的容器中。
scanPackage=com.study.web创建自定义注解：这里只简单的包含了Controller, requestMapping,RequestParam注解，如果要自定义Serivce,Autowired等，需要自己另外实现。
package com.study.framework.annotation;
import java.lang.annotation.*;
/**
* com.study.framework.annotation
*
* @author zhangpeng32
* Created on 2018/6/1 上午11:05
* @Description:
*/
@Target(ElementType.TYPE) //注解在类上
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyController {
/**
* 表示给controller注册别名
* @return
*/
String value() default "";
}
import java.lang.annotation.*;
/**
* com.study.framework.annotation
* springMVC的requestMapping注解
* @author zhangpeng32
* Created on 2018/6/1 上午11:08
* @Description:
*/
@Target({ElementType.TYPE,ElementType.METHOD}) //注解可以在类或者方法上
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyRequestMapping {
/**
* 表示访问的url
* @return
*/
String value() default "";
}package com.study.framework.annotation;
import java.lang.annotation.*;
/**
* com.study.framework.annotation
* springMvc的RequestParam注解，参数注解
* @author zhangpeng32
* Created on 2018/6/1 上午11:10
* @Description:
*/
@Target(ElementType.PARAMETER) //参数的注解
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyRequestParam {
/**
* 表示参数的别名，必填
* @return
*/
String value();
}
最关键的一步就是创建MyDispatcherServlet这个类，继承HttpServlet，重写init方法、doGet、doPost方法，以及加上我们上面分析时要实现的功能（如果使用idea开发工具，在继承HttpServlet后使用快捷键CTRL+O，会弹出窗口让选择某个方法）
package com.study.framework.servlet;
import com.study.framework.annotation.MyController;
import com.study.framework.annotation.MyRequestMapping;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.*;
import java.util.Map.Entry;
/**
* com.study.framework.servlet
*
* @author zhangpeng32
* Created on 2018/6/1 上午10:59
* @Description:
*/
public class MyDispatcherServlet extends HttpServlet {
//spring配置文件里的对象
private Properties properties = new Properties();
// handlerMapping对象，存储url和方法的映射关系
private Map handlerMapping = new HashMap<>();
//扫描路径下的类名列表
private List classNames = new ArrayList<>();
//IOC容器对象,保存注入的实例对象
private Map ioc = new HashMap<>();
//保存url和注入的bean
private Map controllerMap =new HashMap<>();
//重写父类doGet方法
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
this.doPost(req,resp);
}
//重写父类doGet方法
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
try {
//处理请求
doDispatch(req,resp);
} catch (Exception e) {
resp.getWriter().write("500!! Server Exception");
}
}
//重写父类doGet方法
@Override
public void init(ServletConfig config) throws ServletException {
//1、加载spring的配置文件
doLoadConfig(config.getInitParameter("contextConfigLocation"));
//2、初始化所有相关联的类,扫描用户设定的包下面所有的类
doScanner(properties.getProperty("scanPackage"));
//3.拿到扫描到的类,通过反射机制,实例化,并且放到ioc容器中(k-v beanName-bean) beanName默认是首字母小写
doInstance();
//4.初始化HandlerMapping(将url和method对应上)
initHandlerMapping();
System.out.println("------------------spring servlet容器init success -------");
}
private void initHandlerMapping() {
if(ioc.isEmpty()){
return;
}
try {
for (Entry entry: ioc.entrySet()) {
//获取ioc中注入的bean
Class clazz = entry.getValue().getClass();
if(!clazz.isAnnotationPresent(MyController.class)){
continue;
}
//拼url时,是controller头的url拼上方法上的url
String baseUrl ="";
if(clazz.isAnnotationPresent(MyRequestMapping.class)){
MyRequestMapping annotation = clazz.getAnnotation(MyRequestMapping.class);
baseUrl=annotation.value();
}
Method[] methods = clazz.getMethods();
for (Method method : methods) {
if(!method.isAnnotationPresent(MyRequestMapping.class)){
continue;
}
MyRequestMapping annotation = method.getAnnotation(MyRequestMapping.class);
String url = annotation.value();
url =(baseUrl+"/"+url).replaceAll("/+", "/");
handlerMapping.put(url,method);
controllerMap.put(url,clazz.newInstance());
System.out.println(url+","+method);
}
}
} catch (Exception e) {
e.printStackTrace();
}
System.out.println("------------------初始化 HandlerMapping success -------");
}
private void doInstance() {
if (classNames.isEmpty()) {
return;
}
for (String className : classNames) {
try {
//把类搞出来,反射来实例化(只有加@MyController需要实例化)
Class clazz =Class.forName(className);
if(clazz.isAnnotationPresent(MyController.class)){
ioc.put(toLowerFirstWord(clazz.getSimpleName()),clazz.newInstance());
}else{
continue;
}
} catch (Exception e) {
e.printStackTrace();
continue;
}
}
System.out.println("------------------反射完成对象的实例化并且注入到IOC容器中 success -------");
}
/**
* 把字符串的首字母小写
* @param name
* @return
*/
private String toLowerFirstWord(String name){
char[] charArray = name.toCharArray();
charArray[0] += 32; //大小写正好间隔32的字节
return String.valueOf(charArray);
}
private void doScanner(String packageName) {
//把所有的.替换成/
URL url =this.getClass().getClassLoader().getResource("/"+packageName.replaceAll("\\.", "/"));
File dir = new File(url.getFile());
for (File file : dir.listFiles()) {
if(file.isDirectory()){
//递归读取包
doScanner(packageName+"."+file.getName());
}else{
String className =packageName +"." +file.getName().replace(".class", "");
classNames.add(className);
}
}
System.out.println("------------------扫描spring指定路径的类完成--------------");
}
private void doLoadConfig(String contextConfigLocation) {
//把web.xml中的contextConfigLocation对应value值的文件加载到流里面
InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(contextConfigLocation);
try {
//用Properties文件加载文件里的内容
properties.load(resourceAsStream);
} catch (IOException e) {
e.printStackTrace();
}finally {
//关流
if(null!=resourceAsStream){
try {
resourceAsStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
System.out.println("------------------spring contextConfigLocation 配置文件加载完成--------------");
}
private void doDispatch(HttpServletRequest req, HttpServletResponse resp) throws Exception{
if(handlerMapping.isEmpty()){
return;
}
String url =req.getRequestURI(); //获取请求的uRL
String contextPath = req.getContextPath();
//去除URL中多余的"/"
url=url.replace(contextPath, "").replaceAll("/+", "/");
//如果访问的URL不存在，则直接返回404错误
if(!this.handlerMapping.containsKey(url)){
resp.getWriter().write("404 NOT FOUND!");
return;
}
Method method =this.handlerMapping.get(url);
//获取方法的参数列表
Class[] parameterTypes = method.getParameterTypes();
//获取请求的参数
Map parameterMap = req.getParameterMap();
//保存参数值
Object [] paramValues= new Object[parameterTypes.length];
//方法的参数列表
for (int i = 0; i param : parameterMap.entrySet()) {
String value =Arrays.toString(param.getValue()).replaceAll("\\[|\\]", "").replaceAll(",\\s", ",");
paramValues[i]=value;
}
}
}
//利用反射机制来调用
try {
method.invoke(this.controllerMap.get(url), paramValues);//第一个参数是method所对应的实例 在ioc容器中
} catch (Exception e) {
e.printStackTrace();
}
}
} 到这里，我们就开发完成了自己的SpringMVC的框架。
下面写一个controller测试一下：
package com.study.web.controller;
import com.study.framework.annotation.MyController;
import com.study.framework.annotation.MyRequestMapping;
import com.study.framework.annotation.MyRequestParam;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* com.study.web.controller
*
* @author zhangpeng32
* Created on 2018/6/1 上午11:03
* @Description:
*/
@MyController
@MyRequestMapping("/test")
public class FirstController {
@MyRequestMapping("/doTest")
public void test1(HttpServletRequest request, HttpServletResponse response,
@MyRequestParam("name") String name){
System.out.println(name);
try {
response.getWriter().write( "doTest method success! param:"+name);
} catch (IOException e) {
e.printStackTrace();
}
}
@MyRequestMapping("/doTest1")
public void test2(HttpServletRequest request, HttpServletResponse response){
try {
response.getWriter().println("doTest1 method success!");
} catch (IOException e) {
e.printStackTrace();
}
}
}FirstController.java完成后我们来启动一下，可以看到控制台的输出：
信息: Server startup in 156 ms
Connected to server
[2018-06-01 05:20:45,525] Artifact springdemo:war exploded: Artifact is being deployed, please wait...
六月 01, 2018 5:20:45 下午 org.apache.catalina.deploy.WebXml setVersion
警告: Unknown version string [4.0]. Default version will be used.
六月 01, 2018 5:20:46 下午 org.apache.catalina.startup.TldConfig execute
信息: At least one JAR was scanned for TLDs yet contained no TLDs. Enable debug logging for this logger for a complete list of JARs that were scanned but no TLDs were found in them. Skipping unneeded JARs during scanning can improve startup time and JSP compilation time.
------------------spring contextConfigLocation 配置文件加载完成--------------
------------------扫描spring指定路径的类完成--------------
------------------扫描spring指定路径的类完成--------------
------------------反射完成对象的实例化并且注入到IOC容器中 success -------
/test/doTest1,public void com.study.web.controller.FirstController.test2(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
/test/doTest,public void com.study.web.controller.FirstController.test1(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.String)
------------------初始化 HandlerMapping success -------
------------------spring servlet容器init success -------
[2018-06-01 05:20:46,367] Artifact springdemo:war exploded: Artifact is deployed successfully
[2018-06-01 05:20:46,367] Artifact springdemo:war exploded: Deploy took 842 milliseconds可以看到，FirstController中定义的两个requestMapping被扫描到，并映射到了Controller对应的方法上面。
在浏览器中输入:http://localhost:8080/test/doTest?name=hello，运行成功！
输入一个不存在的url：http://localhost:8080/test/doTest111111?name=hello，则会包404 NOT FOUND，错误。
到这里，就大功告成了~
总结
本文介绍了SpringMVC实现的核心思想，大家可以很清楚的发现最重要的就是DispatcherServlet，巧妙的利用发射机制实现对象的实例化的动态的注入。仅仅作为一个学习的参考，更多的细节可以参考spring的源码和官方文档。