天天看點

手寫SpringMVC實戰,一切從Spring底層源碼分析開始

Spring架構對于Java後端程式員來說再熟悉不過了,以前隻知道它用的反射實作的,但了解之後才知道有很多巧妙的設計在裡面。如果不看Spring的源碼,你将會失去一次和大師學習的機會:它的代碼規範,設計思想很值得學習。

我們程式員大部分人都是野路子,不懂什麼叫代碼規範。寫了一個月的代碼,最後還得其他老司機花3天時間重構,相信大部分老司機都很頭疼看新手的代碼。

廢話不多說,我們進入今天的正題,在Web應用程式設計中,MVC模式已經被廣泛使用。SpringMVC以DispatcherServlet為核心,負責協調群組織不同元件以完成請求處理并傳回響應的工作,實作了MVC模式。點選這裡學習 Spring MVC 常用注解。

想要實作自己的SpringMVC架構,需要從以下幾點入手:

了解SpringMVC運作流程及九大元件

梳理自己的SpringMVC的設計思路

實作自己的SpringMVC架構

一、了解SpringMVC運作流程及九大元件

1、SpringMVC的運作流程

手寫SpringMVC實戰,一切從Spring底層源碼分析開始

⑴ 使用者發送請求至前端控制器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的九大元件

protectedvoidinitStrategies(ApplicationContextcontext) {

//用于處理上傳請求。處理方法是将普通的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實戰,一切從Spring底層源碼分析開始

從圖中可以看出,SpringMVC本質上是一個Servlet,這個 Servlet 繼承自 HttpServlet。FrameworkServlet負責初始化SpringMVC的容器,并将Spring容器設定為父容器。因為本文隻是實作SpringMVC,對于Spring容器不做過多講解。點選這裡學習 Spring MVC 常用注解。

為了讀取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架構

工程檔案及目錄:

手寫SpringMVC實戰,一切從Spring底層源碼分析開始

首先,建立一個maven項目,在pom.xml中導入以下依賴:

4.0.0

com.liugh

liughMVC

0.0.1-SNAPSHOT

war

UTF- 8

1.8

javax.servlet

javax.servlet-api

3.0.1

provided

接着,我們在WEB-INF下建立一個web.xml,如下配置:

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">

MySpringMVC

com.liugh.servlet.MyDispatcherServlet

contextConfigLocation

application.properties

1

/*

application.properties檔案中隻是配置要掃描的包到SpringMVC容器中。

scanPackage=com.liugh.core

建立自己的Controller注解,它隻能标注在類上面:

packagecom.liugh.annotation;

importjava.lang.annotation.Documented;

importjava.lang.annotation.ElementType;

importjava.lang.annotation.Retention;

importjava.lang.annotation.RetentionPolicy;

importjava.lang.annotation.Target;

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface MyController {

/**

* 表示給controller注冊别名

* @return

*/

Stringvalue()default"";

RequestMapping注解,可以在類和方法上:

RequestParam注解,隻能注解在參數上

@Target(ElementType.PARAMETER)

public @interface MyRequestParam {

* 表示參數的别名,必填

Stringvalue();

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

package com.liugh.servlet;

importjava.io.File;

importjava.io.IOException;

importjava.io.InputStream;

importjava.lang.reflect.Method;

importjava.net.URL;

importjava.util.ArrayList;

importjava.util.Arrays;

importjava.util.HashMap;

importjava.util.List;

importjava.util.Map;

importjava.util.Map.Entry;

importjava.util.Properties;

importjavax.servlet.ServletConfig;

importjavax.servlet.ServletException;

importjavax.servlet.http.HttpServlet;

importjavax.servlet.http.HttpServletRequest;

importjavax.servlet.http.HttpServletResponse;

importcom.liugh.annotation.MyController;

importcom.liugh.annotation.MyRequestMapping;

publicclassMyDispatcherServletextendsHttpServlet{

private Properties properties =newProperties();

private List classNames =newArrayList<>();

private Map ioc =newHashMap<>();

private Map handlerMapping =newHashMap<>();

private Map controllerMap =newHashMap<>();

@Override

publicvoidinit(ServletConfig config) throws ServletException {

//1.加載配置檔案

doLoadConfig(config.getInitParameter("contextConfigLocation"));

//2.初始化所有相關聯的類,掃描使用者設定的包下面所有的類

doScanner(properties.getProperty("scanPackage"));

//3.拿到掃描到的類,通過反射機制,執行個體化,并且放到ioc容器中(k-v beanName-bean) beanName預設是首字母小寫

doInstance();

//4.初始化HandlerMapping(将url和method對應上)

initHandlerMapping();

protectedvoiddoGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

this.doPost(req,resp);

protectedvoiddoPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

try{

//處理請求

doDispatch(req,resp);

}catch(Exception e) {

resp.getWriter().write("500!! Server Exception");

privatevoiddoDispatch(HttpServletRequest req, HttpServletResponse resp) throws Exception {

if(handlerMapping.isEmpty()){

return;

String url =req.getRequestURI();

String contextPath = req.getContextPath();

url=url.replace(contextPath, "").replaceAll("/+", "/");

if(!this.handlerMapping.containsKey(url)){

resp.getWriter().write("404 NOT FOUND!");

Method method =this.handlerMapping.get(url);

//擷取方法的參數清單

Class<?>[] parameterTypes = method.getParameterTypes();

//擷取請求的參數

Map<String, String[]> parameterMap = req.getParameterMap();

//儲存參數值

Object [] paramValues=newObject[parameterTypes.length];

//方法的參數清單

for(int i = 0; i

//根據參數名稱,做某些處理

String requestParam = parameterTypes[i].getSimpleName();

if(requestParam.equals("HttpServletRequest")){

//參數類型已明确,這邊強轉類型

paramValues[i]=req;

continue;

if(requestParam.equals("HttpServletResponse")){

paramValues[i]=resp;

if(requestParam.equals("String")){

for(Entry param : parameterMap.entrySet()) {

String value =Arrays.toString(param.getValue()).replaceAll("[|]", "").replaceAll(",s", ",");

paramValues[i]=value;

//利用反射機制來調用

method.invoke(this.controllerMap.get(url), paramValues);//第一個參數是method所對應的執行個體 在ioc容器中

e.printStackTrace();

privatevoiddoLoadConfig(String location){

//把web.xml中的contextConfigLocation對應value值的檔案加載到流裡面

InputStream resourceAsStream =this.getClass().getClassLoader().getResourceAsStream(location);

//用Properties檔案加載檔案裡的内容

properties.load(resourceAsStream);

}catch(IOException e) {

}finally{

//關流

if(null!=resourceAsStream){

resourceAsStream.close();

privatevoiddoScanner(String packageName) {

//把所有的.替換成/

URL url =this.getClass().getClassLoader().getResource("/"+packageName.replaceAll(".", "/"));

File dir =newFile(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);

privatevoiddoInstance() {

if(classNames.isEmpty()) {

for(String className : classNames) {

//把類搞出來,反射來執行個體化(隻有加@MyController需要執行個體化)

Class<?> clazz =Class.forName(className);

if(clazz.isAnnotationPresent(MyController.class)){

ioc.put(toLowerFirstWord(clazz.getSimpleName()),clazz.newInstance());

privatevoidinitHandlerMapping(){

if(ioc.isEmpty()){

for(Entry entry: ioc.entrySet()) {

Class clazz = entry.getValue().getClass();

if(!clazz.isAnnotationPresent(MyController.class)){

//拼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)){

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);

* 把字元串的首字母小寫

* @param name

private String toLowerFirstWord(String name){

char[] charArray = name.toCharArray();

charArray[0] += 32;

returnString.valueOf(charArray);

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

packagecom.liugh.core.controller;

importcom.liugh.annotation.MyRequestParam;

@MyController

@MyRequestMapping("/test")

publicclassTestController{

@MyRequestMapping("/doTest")

publicvoid test1(HttpServletRequest request, HttpServletResponse response,

@MyRequestParam("param") String param){

System.out.println(param);

response.getWriter().write( "doTest method success! param:"+param);

@MyRequestMapping("/doTest2")

publicvoid test2(HttpServletRequest request, HttpServletResponse response){

response.getWriter().println("doTest2 method success!");

通路

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

手寫SpringMVC實戰,一切從Spring底層源碼分析開始

通路一個不存在的試試:

手寫SpringMVC實戰,一切從Spring底層源碼分析開始

到這裡我們就大功告成了!水準有限,文章難免有錯誤,歡迎犧牲自己寶貴時間的讀者,就本文内容直抒己見,我的目的僅僅是希望對讀者有所幫助。

繼續閱讀