自己手写一个 SpringMVC 框架

Spring 框架对于 Java 后端程序员来说再熟悉不过了，以前只知道它用的反射实现的，但了解之后才知道有很多巧妙的设计在里面。如果不看 Spring 的源码，你将会失去一次和大师学习的机会：它的代码规范，设计思想很值得学习。我们程序员大部分人都是野路子，不懂什么叫代码规范。写了一个月的代码，最后还得其他老司机花 3 天时间重构，相信大部分老司机都很头疼看新手的代码。

   废话不多说，我们进入今天的正题，在Web应用程序设计中，MVC模式已经被广泛使用。SpringMVC以DispatcherServlet为核心，负责协调和组织不同组件以完成请求处理并返回响应的工作，实现了MVC模式。想要实现自己的SpringMVC框架，需要从以下几点入手：

   一、了解SpringMVC运行流程及九大组件

   二、自己实现SpringMVC的功能分析

   三、手写SpringMVC框架

一、了解 SpringMVC 运行流程及九大组件

1、SpringMVC 的运行流程

         ![](https://user-gold-cdn.xitu.io/2018/2/22/161bd1acad3d04ac?imageView2/0/w/1280/h/960/format/webp/ignore-error/1)

• 用户发送请求至前端控制器 DispatcherServlet

• DispatcherServlet 收到请求调用 HandlerMapping 处理器映射器。

• 处理器映射器根据请求 url 找到具体的处理器，生成处理器对象及处理器拦截器(如果有则生成)一并返回给 DispatcherServlet。

• DispatcherServlet 通过 HandlerAdapter 处理器适配器调用处理器

• 执行处理器(Controller，也叫后端控制器)。

• Controller 执行完成返回 ModelAndView

• HandlerAdapter 将 controller 执行结果 ModelAndView 返回给 DispatcherServlet

• DispatcherServlet 将 ModelAndView 传给 ViewReslover 视图解析器

• ViewReslover 解析后返回具体 View

• DispatcherServlet 对 View 进行渲染视图（即将模型数据填充至视图中）。

• DispatcherServlet 响应用户。

  从上面可以看出，DispatcherServlet 有接受请求，响应结果，转发等作用。有了 DispatcherServlet 之后，可以减少组件之间的耦合度。

2、SpringMVC 的九大组件（ref：【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 功能分析

   本片文章只实现SpringMVC的配置加载、实例化扫描的包、HandlerMapping的url映射到对应的Controller的method上、异常的拦截和动态调用后返回结果输出给浏览器的功能。其余SpringMVC功能读者可以尝试自己实现。

1、读取配置

     ![](https://user-gold-cdn.xitu.io/2018/2/22/161bd1acad4d4487?imageView2/0/w/1280/h/960/format/webp/ignore-error/1)

从图中可以看出，SpringMVC本质上是一个Servlet,这个 Servlet 继承自 HttpServlet。FrameworkServlet负责初始化SpringMVC的容器，并将Spring容器设置为父容器。因为本文只是实现SpringMVC，对于Spring容器不做过多讲解（有兴趣同学可以看看博主另一篇文章：[向spring大佬低头--大量源码流出解析](https://link.juejin.im/?target=https%3A%2F%2Fmy.oschina.net%2FliughDevelop%2Fblog%2F1434547)）。

   为了读取web.xml中的配置，我们用到ServletConfig这个类，它代表当前Servlet在web.xml中的配置信息。通过web.xml中加载我们自己写的MyDispatcherServlet和读取配置文件。

2、初始化阶段

   在上文中，我们知道了DispatcherServlet的initStrategies方法会初始化9大组件，但是本文将实现一些SpringMVC的最基本的组件而不是全部，按顺序包括：

• 加载配置文件
• 初始化所有相关联的类，扫描用户设定的包下面所有的类
• 拿到扫描到的类，通过反射机制，实例化。并且放到 ioc 容器中(Map 的键值对 beanName-bean) beanName 默认是首字母小写
• 初始化 HandlerMapping，其实就是将一个 Map 的键值对 key 是 url，value 是所调用的方法 put 进去(将 url 和 method 对应上)

3、运行阶段

   每一次请求将会调用doGet或doPost方法，所以统一运行阶段都放在doDispatch方法里处理，它会根据url请求去HandlerMapping中匹配到对应的Method，然后利用反射机制调用Controller中的方法，并得到结果返回。按顺序包括以下功能：

• 异常的拦截
• 获取请求传入的参数并处理参数
• 通过初始化好的 handlerMapping 的 Map 容器中拿出 url 对应的方法名，反射调用

三、手写 SpringMVC 框架

   工程文件及目录：

                        ![](https://user-gold-cdn.xitu.io/2018/2/22/161bd1acb33bc8ab?imageView2/0/w/1280/h/960/format/webp/ignore-error/1)

首先，新建一个 maven 项目，在 pom.xml 中导入以下依赖。为了方便，博主直接导入了 Springboot 的 web 包，里面有我们需要的所有 web 开发的东西：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.liugh</groupId>
  <artifactId>liughMVC</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>

 <dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-dependencies</artifactId>
				<version>1.4.3.RELEASE</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>
	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
  		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>

接着，我们在 WEB-INF 下创建一个 web.xml，如下配置：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
	version="3.0">
	<servlet>
		<servlet-name>MySpringMVC</servlet-name>
		<servlet-class>com.liugh.servlet.MyDispatcherServlet</servlet-class>
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>application.properties</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>MySpringMVC</servlet-name>
		<url-pattern>/*</url-pattern>
	</servlet-mapping>

</web-app>

application.properties 文件中只是配置要扫描的包到 SpringMVC 容器中。

scanPackage=com.liugh.core

创建自己的 Controller 注解，它只能标注在类上面：

访问一个不存在的试试：

到这里我们就大功告成了！
   博主是个普通的程序猿，水平有限，文章难免有错误，欢迎牺牲自己宝贵时间的读者，就本文内容直抒己见，博主的目的仅仅是希望对读者有所帮助。源码地址：[github.com/qq53182347/…](https://link.juejin.im/?target=https%3A%2F%2Fgithub.com%2Fqq53182347%2FliughMVC)
   
   
   转载 https://juejin.im/entry/5a8e9e60f265da4e7e10c9b4?utm_source=gold_browser_extension