废话不多说,我们进入今天的正题,在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) {
//用于处理上传请求。处理方法是将普通的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容器不做过多讲解(有兴趣同学可以看看大佬的另一篇文章:向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框架
工程文件及目录:

3.1 创建配置文件
首先,新建一个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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.jp</groupId>
<artifactId>jpMVC</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起的别名 -->
<servlet>
<servlet-name>MySpringMVC</servlet-name>
<servlet-class>com.jp.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>
<!-- 为名为MySpringMVC的servlet配置要拦截的url -->
<servlet-mapping>
<servlet-name>MySpringMVC</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
application.properties文件中只是配置要扫描的包到SpringMVC容器中。
scanPackage=com.jp.core
3.2 创建自己的注解
关于java注解以及怎么自定义注解参考:https://www.cnblogs.com/be-forward-to-help-others/p/6846821.html
注解的几点说明:
1)Annotation其实是代码里的特殊标记,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。程序开发人员可以在不改变原有逻辑的情况下,在源文件嵌入一些补充信息。
2)Annotation提供了一条为程序元素设置元数据的方法,从某些方面来看,Annotation就像修饰符一样被使用,可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明,这些信息被存储在Annotation的“name=value”对中。
3)Annotation能被用来为程序元素(类、方法、成员变量等)设置元数据。值得指出的是:Annotation不能影响程序代码的执行,无论增加、删除Annotation,代码都始终如一地执行。如果希望让程序中的Annotation能在运行时起一定的作用,只有通过某种配套的工具对Annotation中的信息进行访问的处理(说明注解就只是个标记),访问和处理Annotation的工具统称APT(Annotation Processing Tool)
创建自己的Controller注解,它只能标注在类上面:
1 package com.jp.annotation;
2
3 import java.lang.annotation.Documented;
4 import java.lang.annotation.ElementType;
5 import java.lang.annotation.Retention;
6 import java.lang.annotation.RetentionPolicy;
7 import java.lang.annotation.Target;
8
9 //@Target注解指定注解能修饰的目标(这里表示只能标注在类及接口)
10 //@Retention用于指定该Annotation可以保留多长时间(RetentionPolicy.RUNTIME: 编译器将把注释记录在class文件中。当运行Java程序时,JVM也会保留注释,程序可以通过反射获取该注释。)
11 //@Documented用于指定该元Annotation修饰的Annotation类将被javadoc工具提取成文档
12 @Target(ElementType.TYPE)
13 @Retention(RetentionPolicy.RUNTIME)
14 @Documented
15 public @interface MyController {
16 /**
17 * 表示给controller注册别名
18 * @return
19 */
20 String value() default "";
21
22 }
RequestMapping注解,可以在类和方法上:
1 package com.jp.annotation;
2
3 import java.lang.annotation.Documented;
4 import java.lang.annotation.ElementType;
5 import java.lang.annotation.Retention;
6 import java.lang.annotation.RetentionPolicy;
7 import java.lang.annotation.Target;
8
9 @Target({ElementType.TYPE,ElementType.METHOD})
10 @Retention(RetentionPolicy.RUNTIME)
11 @Documented
12 public @interface MyRequestMapping {
13 /**
14 * 表示访问该方法的url
15 * @return
16 */
17 String value() default "";
18
19 }
RequestParam注解,只能注解在参数上
1 package com.jp.annotation;
2
3 import java.lang.annotation.Documented;
4 import java.lang.annotation.ElementType;
5 import java.lang.annotation.Retention;
6 import java.lang.annotation.RetentionPolicy;
7 import java.lang.annotation.Target;
8
9 @Target(ElementType.PARAMETER)
10 @Retention(RetentionPolicy.RUNTIME)
11 @Documented
12 public @interface MyRequestParam {
13 /**
14 * 表示参数的别名,必填
15 * @return
16 */
17 String value();
18
19 }
3.3创建MyDispatcherServlet这个类
去继承HttpServlet,重写init方法、doGet、doPost方法,以及加上我们第二步分析时要实现的功能:
1 package com.jp.servlet;
2
3 import java.io.File;
4 import java.io.IOException;
5 import java.io.InputStream;
6 import java.lang.reflect.Method;
7 import java.net.URL;
8 import java.util.ArrayList;
9 import java.util.Arrays;
10 import java.util.HashMap;
11 import java.util.List;
12 import java.util.Map;
13 import java.util.Map.Entry;
14 import java.util.Properties;
15
16 import javax.servlet.ServletConfig;
17 import javax.servlet.ServletException;
18 import javax.servlet.http.HttpServlet;
19 import javax.servlet.http.HttpServletRequest;
20 import javax.servlet.http.HttpServletResponse;
21
22 import com.jp.annotation.MyController;
23 import com.jp.annotation.MyRequestMapping;
24
25 public class MyDispatcherServlet extends HttpServlet {
26 private Properties properties = new Properties();
27 private List<String> classNames = new ArrayList<>();
28 private Map<String, Object> ioc = new HashMap<>();
29 private Map<String, Method> handlerMapping = new HashMap<>();
30 private Map<String, Object> controllerMap = new HashMap<>();
31
32 /**
33 * 初始化阶段
34 */
35 @Override
36 public void init(ServletConfig config) throws ServletException {
37
38 // 1.加载配置文件
39 doLoadConfig(config.getInitParameter("contextConfigLocation"));
40
41 // 2.初始化所有相关联的类,扫描用户设定的包下面所有的类
42 doScanner(properties.getProperty("scanPackage"));
43
44 // 3.拿到扫描到的类,通过反射机制,实例化,并且放到ioc容器中(k-v beanName-bean) beanName默认是首字母小写
45 doInstance();
46
47 // 4.初始化HandlerMapping(将url和method对应上)
48 initHandlerMapping();
49
50 }
51
52 /**
53 * 运行阶段
54 * 每一次请求将会调用doGet或doPost方法,所以统一运行阶段都放在doDispatch方法里处理
55 */
56 @Override
57 protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
58 this.doPost(req, resp);
59 }
60
61 @Override
62 protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
63 try {
64 // 处理请求
65 doDispatch(req, resp);
66 } catch (Exception e) {
67 resp.getWriter().write("500!! Server Exception");
68 }
69
70 }
71
72 //每次请求都来这里
73 private void doDispatch(HttpServletRequest req, HttpServletResponse resp) throws Exception {
74 //handlerMapping这个hashmap中存放的是 url 和 method 的键值对(即哪个url对应哪个方法),如果为空表示没有方法来处理请求
75 if (handlerMapping.isEmpty()) {
76 return;
77 }
78
79 //获得请求的url和上下文,把url中的上下文去掉
80 String url = req.getRequestURI();
81 System.out.println("请求中的url参数: " + url);
82 String contextPath = req.getContextPath();
83 System.out.println("请求中的contextPath上下文参数: " + contextPath);
84 url = url.replace(contextPath, "").replaceAll("/+", "/");
85 System.out.println("把url中的上下文去掉得到新的url即为我们程序中标识方法的路径: " + url);
86
87 if (!this.handlerMapping.containsKey(url)) {
88 resp.getWriter().write("404 NOT FOUND!");
89 return;
90 }
91
92 //根据url请求去HandlerMapping中匹配到对应的Method
93 Method method = this.handlerMapping.get(url);
94
95 // 获取方法的参数列表
96 Class<?>[] parameterTypes = method.getParameterTypes();
97
98 // 获取请求的参数
99 Map<String, String[]> parameterMap = req.getParameterMap();
100
101 // 保存参数值
102 Object[] paramValues = new Object[parameterTypes.length];
103
104 // 方法的参数列表
105 for (int i = 0; i < parameterTypes.length; i++) {
106 // 根据参数名称,做某些处理
107 String requestParam = parameterTypes[i].getSimpleName();
108
109 if (requestParam.equals("HttpServletRequest")) {
110 // 参数类型已明确,这边强转类型
111 paramValues[i] = req;
112 continue;
113 }
114 if (requestParam.equals("HttpServletResponse")) {
115 paramValues[i] = resp;
116 continue;
117 }
118 if (requestParam.equals("String")) {
119 for (Entry<String, String[]> param : parameterMap.entrySet()) {
120 String value = Arrays.toString(param.getValue()).replaceAll("\\[|\\]", "").replaceAll(",\\s", ",");
121 paramValues[i] = value;
122 }
123 }
124 }
125 // 利用反射机制来调用
126 try {
127 method.invoke(this.controllerMap.get(url), paramValues);// 第一个参数是method所对应的实例
128 // 在ioc容器中
129 } catch (Exception e) {
130 e.printStackTrace();
131 }
132 }
133
134
135
136 // 1.加载配置文件
137 private void doLoadConfig(String location) {
138 // 把web.xml中的contextConfigLocation对应value值的文件加载到流里面
139 InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(location);
140 try {
141 // 用Properties文件加载文件里的内容
142 properties.load(resourceAsStream);
143 } catch (IOException e) {
144 e.printStackTrace();
145 } finally {
146 // 关流
147 if (null != resourceAsStream) {
148 try {
149 resourceAsStream.close();
150 } catch (IOException e) {
151 e.printStackTrace();
152 }
153 }
154 }
155
156 }
157
158 // 2.初始化所有相关联的类,扫描用户设定的包下面所有的类
159 private void doScanner(String packageName) {
160 // 把所有的.替换成/
161 URL url = this.getClass().getClassLoader().getResource("/" + packageName.replaceAll("\\.", "/"));
162 File dir = new File(url.getFile());
163 for (File file : dir.listFiles()) {
164 if (file.isDirectory()) {
165 // 递归读取包
166 doScanner(packageName + "." + file.getName());
167 } else {
168 String className = packageName + "." + file.getName().replace(".class", "");
169 classNames.add(className);
170 }
171 }
172 }
173
174 // 3.拿到扫描到的类,通过反射机制,实例化,并且放到ioc容器中(k-v beanName-bean) beanName默认是首字母小写
175 private void doInstance() {
176 if (classNames.isEmpty()) {
177 return;
178 }
179 for (String className : classNames) {
180 try {
181 // 把类搞出来,反射来实例化(只有加@MyController需要实例化)
182 Class<?> clazz = Class.forName(className);
183 if (clazz.isAnnotationPresent(MyController.class)) {
184 ioc.put(toLowerFirstWord(clazz.getSimpleName()), clazz.newInstance());
185 } else {
186 continue;
187 }
188
189 } catch (Exception e) {
190 e.printStackTrace();
191 continue;
192 }
193 }
194 }
195
196 // 4.初始化HandlerMapping(将url和method对应上)
197 private void initHandlerMapping() {
198 if (ioc.isEmpty()) {
199 return;
200 }
201 try {
202 for (Entry<String, Object> entry : ioc.entrySet()) {
203 Class<? extends Object> clazz = entry.getValue().getClass();
204 if (!clazz.isAnnotationPresent(MyController.class)) {
205 continue;
206 }
207
208 // 拼url时,是controller头的url拼上方法上的url
209 String baseUrl = "";
210 if (clazz.isAnnotationPresent(MyRequestMapping.class)) {
211 MyRequestMapping annotation = clazz.getAnnotation(MyRequestMapping.class);
212 baseUrl = annotation.value();
213 }
214 Method[] methods = clazz.getMethods();
215 for (Method method : methods) {
216 if (!method.isAnnotationPresent(MyRequestMapping.class)) {
217 continue;
218 }
219 MyRequestMapping annotation = method.getAnnotation(MyRequestMapping.class);
220 String url = annotation.value();
221
222 url = (baseUrl + "/" + url).replaceAll("/+", "/");
223 handlerMapping.put(url, method);
224 controllerMap.put(url, clazz.newInstance());
225 System.out.println(url + "," + method);
226 }
227
228 }
229
230 } catch (Exception e) {
231 e.printStackTrace();
232 }
233
234 }
235
236 /**
237 * 把字符串的首字母小写
238 *
239 * @param name
240 * @return
241 */
242 private String toLowerFirstWord(String name) {
243 char[] charArray = name.toCharArray();
244 charArray[0] += 32;
245 return String.valueOf(charArray);
246 }
247
248 }
这里我们就开发完了自己的SpringMVC
3.4 现在我们测试一下
package com.jp.core.controller;
import java.io.IOException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.jp.annotation.MyController;
import com.jp.annotation.MyRequestMapping;
import com.jp.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/jpMVC/test/doTest?param=wjp121

访问不存在的

说明:
1)对于请求url对应我们controller中的方法,我们自定义servlet中会把请求来的url去除上下文(该程序tomcat中xebapp目录下的文件夹),就得到了对应方法的标识路径,具体看上面代码。当然这个找是在hashmap中找。

2)对SpringMVC更深入的了解了。有两个地方觉得需要修改下。
第一个:在doLoadConfig方法里对location参数进行处理了下,如下:
if(location.startsWith("classpath:")){
location = location.replace("classpath:","");
}else if(location.contains("/")){
int lastSplitIndex = location.lastIndexOf('/');
location = location.substring(lastSplitIndex+1,location.length());
}
第二个地方:在initHandlerMapping方法里可能存在重复构造Controller,因为ioc变量里可能已经存放了相应的实例了,做了如下更改:
Object tmpValue = null;
String ctlName = toLowerFirstWord(clazz.getSimpleName());
if(ioc.containsKey(ctlName)){
tmpValue = ioc.get(ctlName);
}else{
tmpValue = clazz.newInstance();
}
controllerMap.put(url, tmpValue);
3)springmvc中controller为什么单例
https://blog.csdn.net/qq_27026603/article/details/67953879
https://my.oschina.net/liughDevelop/blog/1622646