2. 程式人生 > >自己手寫一個SpringMVC框架

自己手寫一個SpringMVC框架

阿新 • • 發佈：2019-02-04

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的九大元件

protectedvoidinitStrategies(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專案，在pom.xml中匯入以下依賴：

<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>
  	<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>javax.servlet</groupId> 
		   <artifactId>javax.servlet-api</artifactId> 
		   <version>3.0.1</version> 
		   <scope>provided</scope>
		</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註解，它只能標註在類上面：

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();
 
 private List<String> classNames = new ArrayList<>();
 
 private Map<String, Object> ioc = new HashMap<>();
 
 private Map<String, Method> handlerMapping = new  HashMap<>();
 
 private Map<String, Object> 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<String, String[]> parameterMap = req.getParameterMap();
   
   //儲存引數值
   Object [] paramValues= new Object[parameterTypes.length];
   
   //方法的引數列表
       for (int i = 0; i<parameterTypes.length; i++){  
           //根據引數名稱，做某些處理  
           String requestParam = parameterTypes[i].getSimpleName();  
           
           
           if (requestParam.equals("HttpServletRequest")){  
               //引數型別已明確，這邊強轉型別  
             paramValues[i]=req;
               continue;  
           }  
           if (requestParam.equals("HttpServletResponse")){  
             paramValues[i]=resp;
               continue;  
           }
           if(requestParam.equals("String")){
             for (Entry<String, String[]> 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<String, Object> 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();
       }
   }
}

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


訪問一個不存在的試試：


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

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

轉自：https://mp.weixin.qq.com/s/y0YCNfK2YYlCtUt2RBBGrQ

相關推薦

springmvc流程圖 轉載 自己手寫一個SpringMVC框架

轉載 https://blog.csdn.net/lang_programmer/article/details/71598042 轉載 https://www.cnblogs.com/java1024/p/8556519.html 轉載 https://www.cnblogs.com

自己手寫一個springmvc框架，理解ioc容器

首先我們在手寫springmvc這個框架之前，我們首先要回顧一下springmvc的原理： 2．1、Spring Web MVC是什麼 Spring Web MVC是一種基於Java的實現了Web MVC設計模式的請求驅動型別的輕量級Web框架，即使用了MVC架構

自己手寫一個SpringMVC框架

Spring框架對於Java後端程式設計師來說再熟悉不過了，以前只知道它用的反射實現的，但瞭解之後才知道有很多巧妙的設計在裡面。如果不看Spring的原始碼，你將會失去一次和大師學習的機會：它的程式碼規範，設計思想很值得學習。我們程式設計師大部分人都是野路子，不懂什麼叫程式碼

看年薪50W的架構師如何手寫一個SpringMVC框架（文末附視訊）

前言 做 Java Web 開發的你，一定聽說過SpringMVC的大名，作為現在運用最廣泛的Java框架，它到目前為止依然保持著強大的活力和廣泛的使用者群。 本文介紹如何用eclipse一步一步搭建SpringMVC的最小系統，所謂最小系統，就是足以使專案在SpringMVC框架下成功

400行程式碼手寫一個SpringMVC框架-咕泡學院VIP視訊下載,百度網盤

  400行程式碼手寫一個SpringMVC框架 https://pan.baidu.com/s/1SAKk2etjQ_1M4cNBXBjk2Q  密碼：f2zv  咕泡學院Java架構師每日錄播視訊索取加QQ群：788692365 咕泡學院Java架構師

自己手寫一個springmvc

但是原文中有個問題，就是DispatcherServlet類中，doPost方法有一句 ： SpringmvcController controller = (SpringmvcControlle

IDEA 中手寫 一個SpringMVC框架

不說了直接上程式碼吧（裡面也有相應的說明）程式碼地址 https://github.com/dongfucai/handerMVC自己自己java 。如果有幫助，可以點贊，點星。有問題可以提出，一起學習改正。後面是設計思路梳理SpringMVC的設計思路       本文只實

手寫簡易springmvc框架

程式碼：https://github.com/JZWen/writeSpringMvc 回顧一遍： 準備工作：先寫兩個註解類 controller層的類 並寫上註解 自己寫dispatcherServlet  寫的也不是很完善 在裡面完成 init()&n

利用netty自己手寫一個tomcat

基於javaee基礎上執行的一個web容器 http  伺服器 socktet上支援 TCP/IP HTTP FTP 接受客戶端的一個http url請求，對應後臺有一個servlet netty屬於協議層，底層框架。 request  response 4.0版本 pu

自己手寫一個 VB 的 DateAdd 函式(VB/C 雙語言版本)

         可能有些朋友覺得這是多餘的事情，既然 VB 有了 DateAdd 函式來進行日期運算，幹嘛還要自己手寫一個？ 其實這一點也不多餘，因為有些時候我們的開發環境不一定就在 VB 裡，而那些個開發環境不一定就有那麼多現成的函式可以使用，那麼這個時候要做個日期運算那

手寫一個Spring框架（不含AOP）

spring 手寫分三個階段： 1.配置階段： web.xml配置 servlet初始化 2.初始化階段： 載入配置檔案 ioc容器初始化 掃描相關的類 類例項化，並注入ioc容器 將url路徑和相關method進行對映關聯 3執行階段 dopost作為入

Spring系列之手寫一個SpringMVC

目錄 Spring系列之IOC的原理及手動實現 Spring系列之DI的原理及手動實現 Spring系列之AOP的原理及手動實現 Spring系列之手寫註解與配置檔案的解析 引言 在前面的幾個章節中我們已經簡單的完成了一個簡易版的spring，已經包括容器，依賴注入，AOP和配置檔

Redux自己手寫一個簡化版全面的redux

import React from 'react' //播放器 const renderScreen = (screen)=>{ console.log("=============>renderScreen"); //獲取頁面元素 c

PHP MVC框架基礎小白（自己動手寫一個PHP框架示例）

一個示例專案，具體展示了PHP，MVC模式框架開發的全過程本人小白一個，希望各位大神多多指教，由於教程文字過多而且不易解釋我直接將示例專案打包，下面附上鍊接各位對PHP框架學習可以借鑑專案內帶有其他方法和註釋，希望能對大家有所幫助

手寫迷你SpringMVC框架

前言 學習如何使用Spring，SpringMVC是很快的，但是在往後使用的過程中難免會想探究一下框架背後的原理是什麼，本文將通過講解如何手寫一個簡單版的springMVC框架，直接從程式碼上看框架中請求分發，控制反轉和依賴注入是如何實現的。 建議配合示例原始碼閱讀，github地址如下： https://g

手寫一個HTTP框架：兩個類實現基本的IoC功能

> [jsoncat](https://github.com/Snailclimb/jsoncat)： 仿 Spring Boot 但不同於 Spring Boot 的一個輕量級的 HTTP 框架 國慶節的時候，我就已經把 jsoncat 的 IoC 功能給寫了，具體可以看這篇文章《手寫“Spring

淺析MyBatis（二）：手寫一個自己的MyBatis簡單框架

在[

帶你手寫一個簡單的ORM框架領悟mybatis,hibernate,jpa物件關係對映的祕密

1、ORM介紹     物件關係對映     解決了一個問題： 物件模型和關係模型之間阻抗。     物件模型                     關係模型     物件名稱 Student             表           t_student     物件

從 0 開始手寫一個 Spring MVC 框架，向高手進階

Spring框架對於Java後端程式設計師來說再熟悉不過了，以前只知道它用的反射實現的，但瞭解之後才知道有很多巧妙的設計在裡面。如果不看Spring的原始碼，你將會失去一次和大師學習的機會：它的程式碼規範，設計思想很值得學習。 我們程式設計師大部分人都是野路子，不懂什麼

帶著萌新看springboot原始碼13（手寫一個自己的starter）

　　springboot的最強大的就是那些xxxAutoconfiguration，但是這些xxxAutoConfiguration又依賴那些starter，只有匯入了這些場景啟動器（starter），我們很多自動配置類才能有用，並且還會新增一些功能， 　　這次就來一起寫個簡單的starter，來看看內部到底