查看: 1640|回复: 0

[PHP实例] 自己手写一个SpringMVC框架(简化)

发表于 2018-3-13 08:00:11

作者:liugh_develop,原文地址

摘要: 前端框架很多,但没有一个框架称霸,后端框架现在Spring已经完成大一统.所以学习Spring是java程序员的必修课.

Spring框架对于Java后端程序员来说再熟悉不过了,以前只知道它用的反射实现的,但了解之后才知道有很多巧妙的设计在里面。如果不看Spring的源码,你将会失去一次和大师学习的机会:它的代码规范,设计思想很值得学习。我们程序员大部分人都是野路子,不懂什么叫代码规范。写了一个月的代码,最后还得其他老司机花3天时间重构,相信大部分老司机都很头疼看新手的代码。

废话不多说,我们进入今天的正题,在Web应用程序设计中,MVC模式已经被广泛使用。SpringMVC以DispatcherServlet为核心,负责协调和组织不同组件以完成请求处理并返回响应的工作,实现了MVC模式。想要实现自己的SpringMVC框架,需要从以下几点入手:

一、了解SpringMVC运行流程及九大组件

二、梳理自己的SpringMVC的设计思路

三、实现自己的SpringMVC框架 一、了解SpringMVC运行流程及九大组件

1、SpringMVC的运行流程

图片描述

  1. ⑴ 用户发送请求至前端控制器DispatcherServlet
  2. ⑵ DispatcherServlet收到请求调用HandlerMapping处理器映射器。
  3. ⑶ 处理器映射器根据请求url找到具体的处理器,生成处理器对象及处理器拦截器(如果有则生成)一并返回给DispatcherServlet。
  4. ⑷ DispatcherServlet通过HandlerAdapter处理器适配器调用处理器
  5. ⑸ 执行处理器(Controller,也叫后端控制器)。
  6. ⑹ Controller执行完成返回ModelAndView
  7. ⑺ HandlerAdapter将controller执行结果ModelAndView返回给DispatcherServlet
  8. ⑻ DispatcherServlet将ModelAndView传给ViewReslover视图解析器
  9. ⑼ ViewReslover解析后返回具体View
  10. ⑽ DispatcherServlet对View进行渲染视图(即将模型数据填充至视图中)。
  11. ⑾ DispatcherServlet响应用户。
复制代码

从上面可以看出,DispatcherServlet有接收请求,响应结果,转发等作用。有了DispatcherServlet之后,可以减少组件之间的耦合度。

2、SpringMVC的九大组件(ref:【SpringMVC】9大组件概览)

  1. protected void initStrategies(ApplicationContext context) {
  2. //用于处理上传请求。处理方法是将普通的request包装成MultipartHttpServletRequest,后者可以直接调用getFile方法获取File.
  3. initMultipartResolver(context);
  4. //SpringMVC主要有两个地方用到了Locale:一是ViewResolver视图解析的时候;二是用到国际化资源或者主题的时候。
  5. initLocaleResolver(context);
  6. //用于解析主题。SpringMVC中一个主题对应一个properties文件,里面存放着跟当前主题相关的所有资源、
  7. //如图片、css样式等。SpringMVC的主题也支持国际化,
  8. initThemeResolver(context);
  9. //用来查找Handler的。
  10. initHandlerMappings(context);
  11. //从名字上看,它就是一个适配器。Servlet需要的处理方法的结构却是固定的,都是以request和response为参数的方法。
  12. //如何让固定的Servlet处理方法调用灵活的Handler来进行处理呢?这就是HandlerAdapter要做的事情
  13. initHandlerAdapters(context);
  14. //其它组件都是用来干活的。在干活的过程中难免会出现问题,出问题后怎么办呢?
  15. //这就需要有一个专门的角色对异常情况进行处理,在SpringMVC中就是HandlerExceptionResolver。
  16. initHandlerExceptionResolvers(context);
  17. //有的Handler处理完后并没有设置View也没有设置ViewName,这时就需要从request获取ViewName了,
  18. //如何从request中获取ViewName就是RequestToViewNameTranslator要做的事情了。
  19. initRequestToViewNameTranslator(context);
  20. //ViewResolver用来将String类型的视图名和Locale解析为View类型的视图。
  21. //View是用来渲染页面的,也就是将程序返回的参数填入模板里,生成html(也可能是其它类型)文件。
  22. initViewResolvers(context);
  23. //用来管理FlashMap的,FlashMap主要用在redirect重定向中传递参数。
  24. initFlashMapManager(context);
  25. }
复制代码
二、梳理SpringMVC的设计思路

本文只实现自己的@Controller、@RequestMapping、@RequestParam注解起作用,其余SpringMVC功能读者可以尝试自己实现。

1、读取配置

图片描述

  1. 从图中可以看出,SpringMVC本质上是一个Servlet,这个 Servlet 继承自 HttpServlet。FrameworkServlet负责初始化SpringMVC的容器,并将Spring容器设置为父容器。因为本文只是实现SpringMVC,对于Spring容器不做过多讲解(有兴趣同学可以看看我另一篇文章:向spring大佬低头--大量源码流出解析)。
  2. 为了读取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中导入以下依赖:

  1. <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">
  2. <modelVersion>4.0.0</modelVersion>
  3. <groupId>com.liugh</groupId>
  4. <artifactId>liughMVC</artifactId>
  5. <version>0.0.1-SNAPSHOT</version>
  6. <packaging>war</packaging>
  7. <properties>
  8. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  9. <maven.compiler.source>1.8</maven.compiler.source>
  10. <maven.compiler.target>1.8</maven.compiler.target>
  11. <java.version>1.8</java.version>
  12. </properties>
  13. <dependencies>
  14. <dependency>
  15. <groupId>javax.servlet</groupId>
  16. <artifactId>javax.servlet-api</artifactId>
  17. <version>3.0.1</version>
  18. <scope>provided</scope>
  19. </dependency>
  20. </dependencies>
  21. </project>
复制代码

接着,我们在WEB-INF下创建一个web.xml,如下配置:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  4. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
  5. version="3.0">
  6. <servlet>
  7. <servlet-name>MySpringMVC</servlet-name>
  8. <servlet-class>com.liugh.servlet.MyDispatcherServlet</servlet-class>
  9. <init-param>
  10. <param-name>contextConfigLocation</param-name>
  11. <param-value>application.properties</param-value>
  12. </init-param>
  13. <load-on-startup>1</load-on-startup>
  14. </servlet>
  15. <servlet-mapping>
  16. <servlet-name>MySpringMVC</servlet-name>
  17. <url-pattern>/*</url-pattern>
  18. </servlet-mapping>
  19. </web-app>
复制代码

application.properties文件中只是配置要扫描的包到SpringMVC容器中。

scanPackage=com.liugh.core

创建自己的Controller注解,它只能标注在类上面:

  1. package com.liugh.annotation;
  2. import java.lang.annotation.Documented;
  3. import java.lang.annotation.ElementType;
  4. import java.lang.annotation.Retention;
  5. import java.lang.annotation.RetentionPolicy;
  6. import java.lang.annotation.Target;
  7. @Target(ElementType.TYPE)
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Documented
  10. public @interface MyController {
  11. /**
  12. * 表示给controller注册别名
  13. * @return
  14. */
  15. String value() default "";
  16. }
复制代码

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

  1. package com.liugh.annotation;
  2. import java.lang.annotation.Documented;
  3. import java.lang.annotation.ElementType;
  4. import java.lang.annotation.Retention;
  5. import java.lang.annotation.RetentionPolicy;
  6. import java.lang.annotation.Target;
  7. @Target({ElementType.TYPE,ElementType.METHOD})
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Documented
  10. public @interface MyRequestMapping {
  11. /**
  12. * 表示访问该方法的url
  13. * @return
  14. */
  15. String value() default "";
  16. }
复制代码

RequestParam注解,只能注解在参数上

  1. package com.liugh.annotation;
  2. import java.lang.annotation.Documented;
  3. import java.lang.annotation.ElementType;
  4. import java.lang.annotation.Retention;
  5. import java.lang.annotation.RetentionPolicy;
  6. import java.lang.annotation.Target;
  7. @Target(ElementType.PARAMETER)
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Documented
  10. public @interface MyRequestParam {
  11. /**
  12. * 表示参数的别名,必填
  13. * @return
  14. */
  15. String value();
  16. }
复制代码

然后创建MyDispatcherServlet这个类,去继承HttpServlet,重写init方法、doGet、doPost方法,以及加上我们第二步分析时要实现的功能:

  1. package com.liugh.servlet;
  2. import java.io.File;
  3. import java.io.IOException;
  4. import java.io.InputStream;
  5. import java.lang.reflect.Method;
  6. import java.net.URL;
  7. import java.util.ArrayList;
  8. import java.util.Arrays;
  9. import java.util.HashMap;
  10. import java.util.List;
  11. import java.util.Map;
  12. import java.util.Map.Entry;
  13. import java.util.Properties;
  14. import javax.servlet.ServletConfig;
  15. import javax.servlet.ServletException;
  16. import javax.servlet.http.HttpServlet;
  17. import javax.servlet.http.HttpServletRequest;
  18. import javax.servlet.http.HttpServletResponse;
  19. import com.liugh.annotation.MyController;
  20. import com.liugh.annotation.MyRequestMapping;
  21. public class MyDispatcherServlet extends HttpServlet{
  22. private Properties properties = new Properties();
  23. private List<String> classNames = new ArrayList<>();
  24. private Map<String, Object> ioc = new HashMap<>();
  25. private Map<String, Method> handlerMapping = new HashMap<>();
  26. private Map<String, Object> controllerMap =new HashMap<>();
  27. @Override
  28. public void init(ServletConfig config) throws ServletException {
  29. //1.加载配置文件
  30. doLoadConfig(config.getInitParameter("contextConfigLocation"));
  31. //2.初始化所有相关联的类,扫描用户设定的包下面所有的类
  32. doScanner(properties.getProperty("scanPackage"));
  33. //3.拿到扫描到的类,通过反射机制,实例化,并且放到ioc容器中(k-v beanName-bean) beanName默认是首字母小写
  34. doInstance();
  35. //4.初始化HandlerMapping(将url和method对应上)
  36. initHandlerMapping();
  37. }
  38. @Override
  39. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  40. this.doPost(req,resp);
  41. }
  42. @Override
  43. protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  44. try {
  45. //处理请求
  46. doDispatch(req,resp);
  47. } catch (Exception e) {
  48. resp.getWriter().write("500!! Server Exception");
  49. }
  50. }
  51. private void doDispatch(HttpServletRequest req, HttpServletResponse resp) throws Exception {
  52. if(handlerMapping.isEmpty()){
  53. return;
  54. }
  55. String url =req.getRequestURI();
  56. String contextPath = req.getContextPath();
  57. url=url.replace(contextPath, "").replaceAll("/+", "/");
  58. if(!this.handlerMapping.containsKey(url)){
  59. resp.getWriter().write("404 NOT FOUND!");
  60. return;
  61. }
  62. Method method =this.handlerMapping.get(url);
  63. //获取方法的参数列表
  64. Class<?>[] parameterTypes = method.getParameterTypes();
  65. //获取请求的参数
  66. Map<String, String[]> parameterMap = req.getParameterMap();
  67. //保存参数值
  68. Object [] paramValues= new Object[parameterTypes.length];
  69. //方法的参数列表
  70. for (int i = 0; i<parameterTypes.length; i++){
  71. //根据参数名称,做某些处理
  72. String requestParam = parameterTypes[i].getSimpleName();
  73. if (requestParam.equals("HttpServletRequest")){
  74. //参数类型已明确,这边强转类型
  75. paramValues[i]=req;
  76. continue;
  77. }
  78. if (requestParam.equals("HttpServletResponse")){
  79. paramValues[i]=resp;
  80. continue;
  81. }
  82. if(requestParam.equals("String")){
  83. for (Entry<String, String[]> param : parameterMap.entrySet()) {
  84. String value =Arrays.toString(param.getValue()).replaceAll("\\[|\\]", "").replaceAll(",\\s", ",");
  85. paramValues[i]=value;
  86. }
  87. }
  88. }
  89. //利用反射机制来调用
  90. try {
  91. method.invoke(this.controllerMap.get(url), paramValues);//第一个参数是method所对应的实例 在ioc容器中
  92. } catch (Exception e) {
  93. e.printStackTrace();
  94. }
  95. }
  96. private void doLoadConfig(String location){
  97. //把web.xml中的contextConfigLocation对应value值的文件加载到流里面
  98. InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(location);
  99. try {
  100. //用Properties文件加载文件里的内容
  101. properties.load(resourceAsStream);
  102. } catch (IOException e) {
  103. e.printStackTrace();
  104. }finally {
  105. //关流
  106. if(null!=resourceAsStream){
  107. try {
  108. resourceAsStream.close();
  109. } catch (IOException e) {
  110. e.printStackTrace();
  111. }
  112. }
  113. }
  114. }
  115. private void doScanner(String packageName) {
  116. //把所有的.替换成/
  117. URL url =this.getClass().getClassLoader().getResource("/"+packageName.replaceAll("\\.", "/"));
  118. File dir = new File(url.getFile());
  119. for (File file : dir.listFiles()) {
  120. if(file.isDirectory()){
  121. //递归读取包
  122. doScanner(packageName+"."+file.getName());
  123. }else{
  124. String className =packageName +"." +file.getName().replace(".class", "");
  125. classNames.add(className);
  126. }
  127. }
  128. }
  129. private void doInstance() {
  130. if (classNames.isEmpty()) {
  131. return;
  132. }
  133. for (String className : classNames) {
  134. try {
  135. //把类搞出来,反射来实例化(只有加@MyController需要实例化)
  136. Class<?> clazz =Class.forName(className);
  137. if(clazz.isAnnotationPresent(MyController.class)){
  138. ioc.put(toLowerFirstWord(clazz.getSimpleName()),clazz.newInstance());
  139. }else{
  140. continue;
  141. }
  142. } catch (Exception e) {
  143. e.printStackTrace();
  144. continue;
  145. }
  146. }
  147. }
  148. private void initHandlerMapping(){
  149. if(ioc.isEmpty()){
  150. return;
  151. }
  152. try {
  153. for (Entry<String, Object> entry: ioc.entrySet()) {
  154. Class<? extends Object> clazz = entry.getValue().getClass();
  155. if(!clazz.isAnnotationPresent(MyController.class)){
  156. continue;
  157. }
  158. //拼url时,是controller头的url拼上方法上的url
  159. String baseUrl ="";
  160. if(clazz.isAnnotationPresent(MyRequestMapping.class)){
  161. MyRequestMapping annotation = clazz.getAnnotation(MyRequestMapping.class);
  162. baseUrl=annotation.value();
  163. }
  164. Method[] methods = clazz.getMethods();
  165. for (Method method : methods) {
  166. if(!method.isAnnotationPresent(MyRequestMapping.class)){
  167. continue;
  168. }
  169. MyRequestMapping annotation = method.getAnnotation(MyRequestMapping.class);
  170. String url = annotation.value();
  171. url =(baseUrl+"/"+url).replaceAll("/+", "/");
  172. handlerMapping.put(url,method);
  173. controllerMap.put(url,clazz.newInstance());
  174. System.out.println(url+","+method);
  175. }
  176. }
  177. } catch (Exception e) {
  178. e.printStackTrace();
  179. }
  180. }
  181. /**
  182. * 把字符串的首字母小写
  183. * @param name
  184. * @return
  185. */
  186. private String toLowerFirstWord(String name){
  187. char[] charArray = name.toCharArray();
  188. charArray[0] += 32;
  189. return String.valueOf(charArray);
  190. }
  191. }
复制代码

这里我们就开发完了自己的SpringMVC,现在我们测试一下:

  1. package com.liugh.core.controller;
  2. import java.io.IOException;
  3. import javax.servlet.http.HttpServletRequest;
  4. import javax.servlet.http.HttpServletResponse;
  5. import com.liugh.annotation.MyController;
  6. import com.liugh.annotation.MyRequestMapping;
  7. import com.liugh.annotation.MyRequestParam;
  8. @MyController
  9. @MyRequestMapping("/test")
  10. public class TestController {
  11. @MyRequestMapping("/doTest")
  12. public void test1(HttpServletRequest request, HttpServletResponse response,
  13. @MyRequestParam("param") String param){
  14. System.out.println(param);
  15. try {
  16. response.getWriter().write( "doTest method success! param:"+param);
  17. } catch (IOException e) {
  18. e.printStackTrace();
  19. }
  20. }
  21. @MyRequestMapping("/doTest2")
  22. public void test2(HttpServletRequest request, HttpServletResponse response){
  23. try {
  24. response.getWriter().println("doTest2 method success!");
  25. } catch (IOException e) {
  26. e.printStackTrace();
  27. }
  28. }
  29. }
复制代码

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

图片描述

访问一个不存在的试试:

图片描述

到这里我们就大功告成了!

我是个普通的程序猿,水平有限,文章难免有错误,欢迎牺牲自己宝贵时间的读者,就本文内容直抒己见,我的目的仅仅是希望对读者有所帮助。源码地址:https://github.com/qq53182347/liughMVC



回复

使用道具 举报