01.18 從0開始手寫一個 SpringMVC 框架，向高手進階！

Spring框架對於Java後端程序員來說再熟悉不過了，以前只知道它用的反射實現的，但瞭解之後才知道有很多巧妙的設計在裡面。如果不看Spring的源碼，你將會失去一次和大師學習的機會：它的代碼規範，設計思想很值得學習。我們程序員大部分人都是野路子，不懂什麼叫代碼規範。寫了一個月的代碼，最後還得其他老司機花3天時間重構，相信大部分老司機都很頭疼看新手的代碼。

廢話不多說，我們進入今天的正題，在Web應用程序設計中，MVC模式已經被廣泛使用。SpringMVC以DispatcherServlet為核心，負責協調和組織不同組件以完成請求處理並返回響應的工作，實現了MVC模式。想要實現自己的SpringMVC框架，需要從以下幾點入手：

一、瞭解SpringMVC運行流程及九大組件

二、梳理自己的SpringMVC的設計思路

三、實現自己的SpringMVC框架

一、瞭解SpringMVC運行流程及九大組件

1、SpringMVC的運行流程

⑴ 用戶發送請求至前端控制器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) {\t//用於處理上傳請求。處理方法是將普通的request包裝成MultipartHttpServletRequest，後者可以直接調用getFile方法獲取File. 

initMultipartResolver(context);\t//SpringMVC主要有兩個地方用到了Locale：一是ViewResolver視圖解析的時候；二是用到國際化資源或者主題的時候。
initLocaleResolver(context); 
//用於解析主題。SpringMVC中一個主題對應一個properties文件，裡面存放著跟當前主題相關的所有資源、
//如圖片、css樣式等。SpringMVC的主題也支持國際化， 
initThemeResolver(context);\t//用來查找Handler的。
initHandlerMappings(context);\t//從名字上看，它就是一個適配器。Servlet需要的處理方法的結構卻是固定的，都是以request和response為參數的方法。
//如何讓固定的Servlet處理方法調用靈活的Handler來進行處理呢？這就是HandlerAdapter要做的事情
initHandlerAdapters(context);\t//其它組件都是用來幹活的。在幹活的過程中難免會出現問題，出問題後怎麼辦呢？
//這就需要有一個專門的角色對異常情況進行處理，在SpringMVC中就是HandlerExceptionResolver。
initHandlerExceptionResolvers(context);\t//有的Handler處理完後並沒有設置View也沒有設置ViewName，這時就需要從request獲取ViewName了，
//如何從request中獲取ViewName就是RequestToViewNameTranslator要做的事情了。
initRequestToViewNameTranslator(context);\t//ViewResolver用來將String類型的視圖名和Locale解析為View類型的視圖。
//View是用來渲染頁面的，也就是將程序返回的參數填入模板裡，生成html（也可能是其它類型）文件。
initViewResolvers(context);\t//用來管理FlashMap的，FlashMap主要用在redirect重定向中傳遞參數。
initFlashMapManager(context);  

}

二、梳理SpringMVC的設計思路

本文只實現自己的@Controller、@RequestMapping、@RequestParam註解起作用，其餘SpringMVC功能讀者可以嘗試自己實現。

1、讀取配置

從圖中可以看出，SpringMVC本質上是一個Servlet,這個 Servlet 繼承自 HttpServlet。FrameworkServlet負責初始化SpringMVC的容器，並將Spring容器設置為父容器。因為本文只是實現SpringMVC，對於Spring容器不做過多講解（有興趣同學可以看看我另一篇文章：向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項目，在pom.xml中導入以下依賴：

<project>
 <modelversion>4.0.0/<modelversion>
 <groupid>com.liugh/<groupid>
 <artifactid>liughMVC/<artifactid>
 <version>0.0.1-SNAPSHOT/<version>
 <packaging>war/<packaging>
 
<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>
 \t <groupid>javax.servlet/<groupid> 
 <artifactid>javax.servlet-api/<artifactid> 
 <version>3.0.1/<version> 
 <scope>provided/<scope>
/<dependency>
 /<dependencies>/<project>

接著，我們在WEB-INF下創建一個web.xml，如下配置：

<web-app>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註解，它只能標註在類上面：

package com.liugh.annotation;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface MyController { /**
 * 表示給controller註冊別名
 * @return
 */
 String value() default "";
}

RequestMapping註解，可以在類和方法上：

package com.liugh.annotation;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface MyRequestMapping { /**
 * 表示訪問該方法的url
 * @return
 */
 String value() default "";
}

RequestParam註解,只能註解在參數上

package com.liugh.annotation;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Target(ElementType.PARAMETER)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface MyRequestParam { /**
 * 表示參數的別名，必填
 * @return
 */
 String value();
}

然後創建MyDispatcherServlet這個類，去繼承HttpServlet，重寫init方法、doGet、doPost方法，以及加上我們第二步分析時要實現的功能：

package com.liugh.servlet;import java.io.File;import java.io.IOException;import java.io.InputStream;import java.lang.reflect.Method;import java.net.URL;import java.util.ArrayList;import java.util.Arrays;import java.util.HashMap;import java.util.List;import java.util.Map;import java.util.Map.Entry;import java.util.Properties;import javax.servlet.ServletConfig;import javax.servlet.ServletException;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import com.liugh.annotation.MyController;import com.liugh.annotation.MyRequestMapping;public class MyDispatcherServlet extends HttpServlet{ 
private Properties properties = new Properties();\t
private List<string> classNames = new ArrayList<>();\t
private Map<string> ioc = new HashMap<>();\t
private Map<string> handlerMapping = new HashMap<>();\t
private Map<string> controllerMap =new HashMap<>();\t
@Override
public void init(ServletConfig config) throws ServletException {\t
//1.加載配置文件
doLoadConfig(config.getInitParameter("contextConfigLocation"));\t
//2.初始化所有相關聯的類,掃描用戶設定的包下面所有的類
doScanner(properties.getProperty("scanPackage"));\t
//3.拿到掃描到的類,通過反射機制,實例化,並且放到ioc容器中(k-v beanName-bean) beanName默認是首字母小寫
doInstance();\t
//4.初始化HandlerMapping(將url和method對應上)
initHandlerMapping();
}\t
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { this.doPost(req,resp);
}\t@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { try {\t//處理請求
doDispatch(req,resp);
} catch (Exception e) {
resp.getWriter().write("500!! Server Exception");
}
}\t
private void doDispatch(HttpServletRequest req, HttpServletResponse resp) throws Exception { if(handlerMapping.isEmpty()){\treturn;
}
String url =req.getRequestURI();
String contextPath = req.getContextPath();
url=url.replace(contextPath, "").replaceAll("/+", "/");\t
if(!this.handlerMapping.containsKey(url)){
resp.getWriter().write("404 NOT FOUND!");\treturn;
}
Method method =this.handlerMapping.get(url);\t
//獲取方法的參數列表
Class>[] parameterTypes = method.getParameterTypes();\t
//獲取請求的參數
Map<string> parameterMap = req.getParameterMap();\t
//保存參數值
Object [] paramValues= new Object[parameterTypes.length];\t 

//方法的參數列表
 for (int i = 0; i<parametertypes.length> //根據參數名稱，做某些處理 
 String requestParam = parameterTypes[i].getSimpleName(); 
 
 
 if (requestParam.equals("HttpServletRequest")){ 
 //參數類型已明確，這邊強轉類型 
 \tparamValues[i]=req; continue; 
 } 
 if (requestParam.equals("HttpServletResponse")){ 
 \tparamValues[i]=resp; continue; 
 } if(requestParam.equals("String")){ for (Entry<string> param : parameterMap.entrySet()) {
 \tString value =Arrays.toString(param.getValue()).replaceAll("\\\\[|\\\\]", "").replaceAll(",\\\\s", ",");
 \tparamValues[i]=value;
 \t}
 }
 } 
//利用反射機制來調用
try {
method.invoke(this.controllerMap.get(url), paramValues);//第一個參數是method所對應的實例 在ioc容器中
} catch (Exception e) {
e.printStackTrace();
}
}\tprivate void doLoadConfig(String location){\t//把web.xml中的contextConfigLocation對應value值的文件加載到流裡面
InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(location); try {\t//用Properties文件加載文件裡的內容
properties.load(resourceAsStream);
} catch (IOException e) {
e.printStackTrace();
}finally {\t//關流
if(null!=resourceAsStream){\ttry {
resourceAsStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
}\t
private void doScanner(String packageName) {\t//把所有的.替換成/
URL url =this.getClass().getClassLoader().getResource("/"+packageName.replaceAll("\\\\.", "/"));
File dir = new File(url.getFile());\tfor (File file : dir.listFiles()) { if(file.isDirectory()){\t//遞歸讀取包
doScanner(packageName+"."+file.getName()); 

}else{
String className =packageName +"." +file.getName().replace(".class", "");
classNames.add(className);
}
}
}\t
private void doInstance() {\tif (classNames.isEmpty()) {\treturn;
}\t
for (String className : classNames) {\ttry {\t//把類搞出來,反射來實例化(只有加@MyController需要實例化)
Class> clazz =Class.forName(className); if(clazz.isAnnotationPresent(MyController.class)){
ioc.put(toLowerFirstWord(clazz.getSimpleName()),clazz.newInstance());
}else{\tcontinue;
}
} catch (Exception e) {
e.printStackTrace();\tcontinue;
}
}
}\tprivate void initHandlerMapping(){\tif(ioc.isEmpty()){\treturn;
}\ttry {\tfor (Entry<string> entry: ioc.entrySet()) {
Class extends Object> clazz = entry.getValue().getClass(); if(!clazz.isAnnotationPresent(MyController.class)){\tcontinue;
}\t
//拼url時,是controller頭的url拼上方法上的url
String baseUrl ="";\tif(clazz.isAnnotationPresent(MyRequestMapping.class)){
MyRequestMapping annotation = clazz.getAnnotation(MyRequestMapping.class);
baseUrl=annotation.value();
}
Method[] methods = clazz.getMethods();\tfor (Method method : methods) { if(!method.isAnnotationPresent(MyRequestMapping.class)){\tcontinue;
}
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();
}
}\t/**
 * 把字符串的首字母小寫
 * @param name
 * @return
 */
private String toLowerFirstWord(String name){ char[] charArray = name.toCharArray();
charArray[0] += 32;\treturn String.valueOf(charArray); 

}
}
/<string>/<string>/<parametertypes.length>/<string>/<string>/<string>/<string>/<string>

這裡我們就開發完了自己的SpringMVC，現在我們測試一下：

package com.liugh.core.controller;import java.io.IOException;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import com.liugh.annotation.MyController;import com.liugh.annotation.MyRequestMapping;import com.liugh.annotation.MyRequestParam;@MyController@MyRequestMapping("/test")public class TestController { 
 @MyRequestMapping("/doTest") public void test1(HttpServletRequest request, HttpServletResponse response,
 \t@MyRequestParam("param") String param){
 \tSystem.out.println(param);\t try {
 response.getWriter().write( "doTest method success! param:"+param);
 } catch (IOException e) {
 e.printStackTrace();
 }
 }\t 
 
 @MyRequestMapping("/doTest2") public void test2(HttpServletRequest request, HttpServletResponse response){ try {
 response.getWriter().println("doTest2 method success!");
 } catch (IOException e) {
 e.printStackTrace();
 }
 }
}

訪問http://localhost:8080/liughMVC/test/doTest?param=liugh如下：

訪問一個不存在的試試：

到這裡我們就大功告成了！

我自己在騰訊課堂上也有講過一堂手寫springMVC的直播分享，有感興趣的可以來看看

https://pan.baidu.com/s/17v3syshIGQWjCHL0yi73Cg

1，3分鐘讀懂Spring核心源碼；

2，SpringMVC與Spring框架關係；

3，SpringMVC的所有註解定義實戰；

4，手寫SpringMVC框架實戰；

5，Tomcat加載進行測試實戰；

6，互動答疑。

如果感興趣的話可以來找我獲取其他的資料 想學習提升自己的私信我【JAVA架構】獲取往期Java高級架構資料、源碼、筆記、視頻。Dubbo、Redis、設計模式、Netty、zookeeper、Spring cloud、分佈式、高併發等架構技術 記得轉發下哦

來自同事James的一篇文章