Spring框架對於Java後端程式設計師來說再熟悉不過了，以前只知道它用的反射實現的，但瞭解之後才知道有很多巧妙的設計在裡面。如果不看Spring的原始碼，你將會失去一次和大師學習的機會：它的程式碼規範，設計思想很值得學習。我們程式設計師大部分人都是野路子，不懂什麼叫程式碼規範。寫了一個月的程式碼，最後還得其他老司機花3天時間重構，相信大部分老司機都很頭疼看新手的程式碼。
廢話不多說，我們進入今天的正題，在Web應用程式設計中，MVC模式已經被廣泛使用。SpringMVC以DispatcherServlet為核心，負責協調和組織不同元件以完成請求處理並返回響應的工作，實現了MVC模式。想要實現自己的SpringMVC框架，需要從以下幾點入手：

   一、瞭解SpringMVC執行流程及九大元件

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

   三、實現自己的SpringMVC框架

一、瞭解SpringMVC執行流程及九大元件

1、SpringMVC的執行流程

image.png

   ⑴ 使用者傳送請求至前端控制器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：）

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、讀取配置

image.png

從圖中可以看出，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框架

工程檔案及目錄：

image.png

首先，新建一個maven專案，在pom.xml中匯入以下依賴：


  4.0.0
  com.liugh
  liughMVC
  0.0.1-SNAPSHOT
  war

    
        UTF-8
        1.8
        1.8
        1.8
    

    
         
           javax.servlet 
           javax.servlet-api 
           3.0.1 
           provided

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


    
        MySpringMVC
        com.liugh.servlet.MyDispatcherServlet
        
            contextConfigLocation
            application.properties
        
        1
    
    
        MySpringMVC
        /*

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)
@Documented
public @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)
@Documented
public @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)
@Documented
public @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();    private List classNames = new ArrayList();    private Map ioc = new HashMap();    private Map handlerMapping = new  HashMap();    private Map controllerMap  =new HashMap();    @Override
    public void init(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();

    }    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {        this.doPost(req,resp);
    }    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {        try {            //處理請求
            doDispatch(req,resp);
        } catch (Exception e) {
            resp.getWriter().write("500!! Server Exception");
        }

    }    private void doDispatch(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!");            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();
        }
    }    private void  doLoadConfig(String location){        //把web.xml中的contextConfigLocation對應value值的檔案載入到流裡面
        InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(location);        try {            //用Properties檔案載入檔案裡的內容
            properties.load(resourceAsStream);
        } catch (IOException e) {
            e.printStackTrace();
        }finally {            //關流
            if(null!=resourceAsStream){                try {
                    resourceAsStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

    }    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);
            }
        }
    }    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;
            }
        }
    }    private void initHandlerMapping(){        if(ioc.isEmpty()){            return;
        }        try {            for (Entry entry: ioc.entrySet()) {
                Class extends Object> 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();
        }

    }    /**
     * 把字串的首字母小寫
     * @param name
     * @return
     */
    private String toLowerFirstWord(String name){        char[] charArray = name.toCharArray();
        charArray[0] += 32;        return String.valueOf(charArray);
    }

}

這裡我們就開發完了自己的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,
            @MyRequestParam("param") String param){
        System.out.println(param);        try {
            response.getWriter().write( "doTest method success! param:"+param);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }     @MyRequestMapping("/doTest2")    public void test2(HttpServletRequest request, HttpServletResponse response){        try {
            response.getWriter().println("doTest2 method success!");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

訪問如下：

image

訪問一個不存在的試試：

image

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

我是個普通的程式猿，水平有限，文章難免有錯誤，歡迎犧牲自己寶貴時間的讀者，就本文內容直抒己見，我的目的僅僅是希望對讀者有所幫助。原始碼地址：https://github.com/qq53182347/liughMVC

作者：我叫劉半仙_liugh
連結：

自己手寫一個SpringMVC框架(簡化)

一、瞭解SpringMVC執行流程及九大元件

1、SpringMVC的執行流程

2、SpringMVC的九大元件（ref：）

二、梳理SpringMVC的設計思路

1、讀取配置

2、初始化階段

3、執行階段

三、實現自己的SpringMVC框架

相關文章