手寫Spring MVC框架（包含Java註解的實現）

阿新 • • 發佈：2019-01-29

主要從以下幾點入手：

一、瞭解SpringMVC執行流程及九大元件
二、梳理自己的SpringMVC的設計思路

三、實現自己的SpringMVC框架

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

執行流程：

1.使用者傳送請求->DispatcherServlet；使用者向服務端傳送請求，被Spring的前端控制器DispatcherServlet截獲。

2.DispatcherServlet->HandlerMapping；DispatcherServlet對請求URL（統一資源定位符）進行解析，得到URI（請求資源識別符號）。根據URI呼叫HandlerMapping（處理器對映器），它把請求對映為HandlerExecutionChain物件（包含一個Handler處理器物件和多個HandlerInterceptor攔截器物件）返回給DispatcherServlet。

3.DispatcherServlet->HandlerAdapter；（此步驟之前可以用HandlerInterceptor攔截呼叫preHandler方法）DispatcherServlet根據返回的Handler選擇合適的HandlerAdapter（方法引數有三個，分別為request，response和handler物件）處理，該介面卡呼叫對應Handler的實際處理請求的方法（例如login）。HandlerAdapter會被用於處理多種Handler，呼叫Handler實際處理請求的方法。

4.HandlerAdapter->處理器相應功能處理方法的呼叫。HandlerAdapter會根據適配的結果呼叫真正的處理器Handler(Controller)的功能處理方法（呼叫

HandlerMethod方法），完成功能處理，返回ModelAndView物件（包括模型和檢視名）（此步驟之後，可以用HandlerInterceptor攔截呼叫postHandler方法）

異常處理：前四個步驟可能會發生異常，使用HandlerExceptionResolver策略解決。

5.ModelAndView的邏輯檢視名->ViewResolver（檢視解析器），ViewResolver會把邏輯檢視名解析為具體的View，並返回給DispatcherServlet。通過這種策略模式，很容易更換其他檢視技術。

6.View->渲染；View會根據傳進來的Model模型資料進行渲染，並把View渲染結果返回給DispatcherServlet。此處的Model實際是一個Map資料結構，因此很容易支援其他檢視技術。

7.返回控制權給DispatcherServlet，由DispatcherServlet返回響應給使用者，到此一個流程結束。

九大元件：

點選開啟連結https://blog.csdn.net/hu_zhiting/article/details/73648939

DispatcherServlet初始化策略：

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註解起作用

1.掃描自定義路徑下的包，把這些包名讀取到list型別的classNames中。

2.根據這些包名，判斷哪些類加上了 Controller 註解，把這些類儲存到一個名為ioc的map中，key為類名， value為例項物件。

3.遍歷這些類中所有含有RequestMapping註解的方法，如有，那麼將這些資訊註冊到一個handlerMapping中，這是一個map，其中key為url，value為對應的method方法；然後再新建一個map：controllerMap，key為url，value為method所在類的物件例項。

4. 在掃描哪些加了Controller註解的類時，也可以遍歷其中的所有物件，通過反射獲取物件的所有屬性值（欄位）集合，然後遍歷屬性值集合，將屬性值含有指定註解的，通過Field的set方法為該屬性值賦值，這時就將物件注入了。（也就是往Controller中注入Service物件）

5.以上都是初始化的時候進行的操作，下面來看看處理請求的過程：

5.1. 根據HttpServletRequest得到這次請求的url，如果hadlerMapping中沒有這個url的記錄的話直接返回；如果有的話--> 5.2. 根據這個url取出相對應的method，然後就是反射的一些知識了，根據反射取出需要的引數列表。根據HttpServletRequest取出傳進來的引數，根據method.invoke(instance, value)來呼叫這個url對應的handler方法。

實現自己的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.hh.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.hh.core

建立自己的Controller註解，它只能標註在類上面：

package com.hh.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.hh.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.hh.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.hh.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.hh.annotation.MyController;
import com.hh.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)){//檢查方法是否標記為RequestMapping
						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);
	}
	
		
}

手寫Spring MVC框架（包含Java註解的實現）

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

執行流程：

九大元件：

梳理SpringMVC的設計思路

實現自己的SpringMVC框架

手寫Spring MVC框架（包含Java註解的實現）

IDEA搭建我的第一個Spring MVC應用（附使用註解實現）

手寫spring mvc框架

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

純手寫Spring IoC容器之自定義註解實現

Spring基礎學習（四 AOP 註解實現）

spring MVC框架（入門篇）-1

一個老程序員是如何手寫Spring MVC的

一個老程式設計師是如何手寫Spring MVC的？

分享我是如何手寫Spring MVC全過程

膜拜阿里架構師全程手寫Spring MVC

記錄一次阿里架構師全程手寫Spring MVC

一個老程式設計師是如何手寫Spring MVC的

搭建Spring MVC框架（一站式服務）

攜程系統架構師帶你手寫spring mvc，解讀spring核心原始碼！

手寫spring一:詳解EventListener java頂級監聽器

手寫Spring事務框架

手寫spring ioc框架

從零開始手寫 spring ioc 框架，深入學習 spring 原始碼

Java入門系列（七）Java 集合框架（JCF, Java Collections Framework）

手寫Spring MVC框架（包含Java註解的實現）

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

執行流程：

九大元件：

梳理SpringMVC的設計思路

實現自己的SpringMVC框架

相關推薦