手写Spring MVC
思路
把requestMapping路径 和 方法 作为一个Key Value 注册到容器中
spring mvc是基于servlet实现的 是单多例的
servlet是线程不安全的!
SpringMVC的运行流程
⑴ 用户发送请求至前端控制器DispatcherServlet
⑵ DispatcherServlet收到请求调用HandlerMapping处理器映射器。
⑶ 处理器映射器根据请求url找到具体的处理器,生成处理器对象及处理器拦截器(如果有则生成)一并返回给DispatcherServlet。
⑷ DispatcherServlet通过HandlerAdapter处理器适配器调用处理器
⑸ 执行处理器(Controller,也叫后端控制器)。
⑹ Controller执行完成返回ModelAndView
⑺ HandlerAdapter将controller执行结果ModelAndView返回给DispatcherServlet
⑻ DispatcherServlet将ModelAndView传给ViewReslover视图解析器
⑼ ViewReslover解析后返回具体View
⑽ DispatcherServlet对View进行渲染视图(即将模型数据填充至视图中)。
⑾ DispatcherServlet响应用户。
回顾Servet知识
什么是Servlet
Java Servlet 是运行在 Web 服务器或应用服务器上的程序,它是作为来自 Web 浏览器或其他 HTTP 客户端的请求和 HTTP 服务器上的数据库或应用程序之间的中间层。
使用 Servlet,您可以收集来自网页表单的用户输入,呈现来自数据库或者其他源的记录,还可以动态创建网页。
Java Servlet 通常情况下与使用 CGI(Common Gateway Interface,公共网关接口)实现的程序可以达到异曲同工的效果。但是相比于 CGI,Servlet 有以下几点优势:
性能明显更好。
Servlet 在 Web 服务器的地址空间内执行。这样它就没有必要再创建一个单独的进程来处理每个客户端请求。
Servlet 是独立于平台的,因为它们是用 Java 编写的。
服务器上的 Java 安全管理器执行了一系列限制,以保护服务器计算机上的资源。因此,Servlet 是可信的。
Java 类库的全部功能对 Servlet 来说都是可用的。它可以通过 sockets 和 RMI 机制与 applets、数据库或其他软件进行交互。
什么是Servlet生命周期
Servlet 生命周期:
Servlet 加载—>实例化—>服务—>销毁。
init():
在Servlet的生命周期中,仅执行一次init()方法。它是在服务器装入Servlet时执行的,负责初始化Servlet对象。可以配置服务器,以在启动服务器或客户机首次访问Servlet时装入Servlet。无论有多少客户机访问Servlet,都不会重复执行init()。
service():
它是Servlet的核心,负责响应客户的请求。每当一个客户请求一个HttpServlet对象,该对象的Service()方法就要调用,而且传递给这个方法一个“请求”(ServletRequest)对象和一个“响应”(ServletResponse)对象作为参数。在HttpServlet中已存在Service()方法。默认的服务功能是调用与HTTP请求的方法相应的do功能。
destroy():
仅执行一次,在服务器端停止且卸载Servlet时执行该方法。当Servlet对象退出生命周期时,负责释放占用的资源。一个Servlet在运行service()方法时可能会产生其他的线程,因此需要确认在调用destroy()方法时,这些线程已经终止或完成。
手写SpringMVC思路
1.web.xml加载
为了读取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基本实现
通过DispatchServlet做请求的分发
通过它加载spring mvc配置文件 加载完了
通过 servlet-mapping 拦截所有请求 所有请求都交个dispatchServlet
servlet是到单例的 访问完毕不会销毁他的 关闭tomcat就销毁了
spring mvc是基于servlet实现的
首先 tomcat读取web.xml 进行解析 加载servlet容器 加载到DispatchServlet,然后进行基本的生命周期 初始化 doServvice 销毁 等等
任何请求过来交给dispatchServlet (前端你设计模式,做请求分发),然后调用处理器映射器找到处理器(URL与请求方法做个关联映射)。相当于客户端的请求地址对应找到Java方法
进行处理器拦截
然后进行适配器模式,判断到底是干嘛用的类型。然后具体类型,如果是Contrller,然后回去找请求方法
实现思路:
手写前端控制器servlet 拦截所有请求
初始化操作 从谢Servlet init
将扫包范围所有的类 注入到springmvc容器中,存放map集合中 key为默认为类名小写 value为对象(实例化对象)
将url映射和方法关联
判断类上是否有注解(RequestMapping) 使用Java反射机制循环遍历方法 判断方法是否存在注解(RequestMapping)进行封装url和方法对应存入集合中
处理请求 重写get或者post方法
获取请求url ,从集合中获取实例对象 ,获取成功实例对象后, 继续获取方法名称,然后使用反射机制执行
goGet: 从请求中获取URL
根据URL去获取容器中 Bean对象(Controller) 如果对象为null 则返回404
不为空 然后继续获取方法名称 如果为null 则返返回 not found method
祖红通过Java反射嗲用方法
web.xml:
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" version="2.4"> <!-- Spring MVC 核心控制器 DispatcherServlet 配置 --> <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>com.itmayiedu.ext.springmvc.servlet.ExtDispatcherServlet </servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcher</servlet-name> <!-- 拦截所有/* 的请求,交给DispatcherServlet处理,性能最好 --> <url-pattern>/</url-pattern> </servlet-mapping> </web-app>
servlet:
import java.io.IOException; import java.lang.reflect.Method; import java.util.List; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.commons.lang.StringUtils; import com.itmayiedu.extspringmvc.extannotation.ExtController; import com.itmayiedu.extspringmvc.extannotation.ExtRequestMapping; import com.itmayiedu.utils.ClassUtil; /** * 自定义前端控制器<br> * 手写springmvc 原理分析<br> * 1.创建一个前端控制器()ExtDispatcherServlet 拦截所有请求(springmvc 基于servlet实现)<br> * ####2.初始化操作 重写servlet init 方法<br> * #######2.1 将扫包范围所有的类,注入到springmvc容器里面,存放在Map集合中 key为默认类名小写,value 对象<br> * #######2.2 将url映射和方法进行关联 <br> * ##########2.2.1 判断类上是否有注解,使用java反射机制循环遍历方法 ,判断方法上是否存在注解,进行封装url和方法对应存入集合中<br> * ####3.处理请求 重写Get或者是Post方法 <br> * ##########3.1 * 获取请求url,从urlBeans集合获取实例对象,获取成功实例对象后,调用urlMethods集合获取方法名称,使用反射机制执行 2. 作者: * 每特教育-余胜军<br> * 联系方式:QQ644064779|WWW.itmayiedu.com<br> * 作者: 每特教育-余胜军<br> * 联系方式:QQ644064779|WWW.itmayiedu.com<br> */ public class ExtDispatcherServlet extends HttpServlet { // springmvc 容器对象 key:类名id ,value 对象 private ConcurrentHashMap<String, Object> springmvcBeans = new ConcurrentHashMap<String, Object>(); // springmvc 容器对象 keya:请求地址 ,vlue类 private ConcurrentHashMap<String, Object> urlBeans = new ConcurrentHashMap<String, Object>(); // springmvc 容器对象 key:请求地址 ,value 方法名称 private ConcurrentHashMap<String, String> urlMethods = new ConcurrentHashMap<String, String>(); @Override public void init() throws ServletException { // 1.获取当前包下的所有的类 List<Class<?>> classes = ClassUtil.getClasses("com.itmayiedu.controller"); // 2.将扫包范围所有的类,注入到springmvc容器里面,存放在Map集合中 key为默认类名小写,value 对象 try { findClassMVCAnnotation(classes); } catch (Exception e) { // TODO: handle exception } // 3.将url映射和方法进行关联 handlerMapping(); } @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { doPost(req, resp); } @Override protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { // #################处理请求#################### // 1.获取请求url地址 String requestURI = req.getRequestURI(); if (StringUtils.isEmpty(requestURI)) { return; } // 2.从Map集合中获取控制对象 Object object = urlBeans.get(requestURI); if (object == null) { resp.getWriter().println(" not found 404 url"); return; } // 3.使用url地址获取方法 String methodName = urlMethods.get(requestURI); if (StringUtils.isEmpty(methodName)) { resp.getWriter().println(" not found method"); } // 4.使用java的反射机制调用方法 String resultPage = (String) methodInvoke(object, methodName); // 5.调用视图转换器渲染给页面展示 extResourceViewResolver(resultPage, req, resp); } private void extResourceViewResolver(String pageName, HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException { // 根路径 String prefix = "/"; String suffix = ".jsp"; req.getRequestDispatcher(prefix + pageName + suffix).forward(req, res); } // 手写springboot 手写springcloud -----手写分布式配置中心 private Object methodInvoke(Object object, String methodName) { try { Class<? extends Object> classInfo = object.getClass(); Method method = classInfo.getMethod(methodName); Object result = method.invoke(object); return result; } catch (Exception e) { return null; } } // 2.将扫包范围所有的类,注入到springmvc容器里面,存放在Map集合中 key为默认类名小写,value 对象 public void findClassMVCAnnotation(List<Class<?>> classes) throws ClassNotFoundException, InstantiationException, IllegalAccessException { for (Class<?> classInfo : classes) { // 判断类上是否有加上注解 ExtController extController = classInfo.getDeclaredAnnotation(ExtController.class); if (extController != null) { // 默认类名是小写 String beanId = ClassUtil.toLowerCaseFirstOne(classInfo.getSimpleName()); // 实例化对象 Object object = ClassUtil.newInstance(classInfo); springmvcBeans.put(beanId, object); } } } // 3.将url映射和方法进行关联 public void handlerMapping() { // 1.遍历springmvc bean容器 判断类上属否有url映射注解 for (Map.Entry<String, Object> mvcBean : springmvcBeans.entrySet()) { // 2.遍历所有的方法上是否有url映射注解 // 获取bean的对象 Object object = mvcBean.getValue(); // 3.判断类上是否有加url映射注解 Class<? extends Object> classInfo = object.getClass(); ExtRequestMapping declaredAnnotation = classInfo.getDeclaredAnnotation(ExtRequestMapping.class); String baseUrl = ""; if (declaredAnnotation != null) { // 获取类上的url映射地址 baseUrl = declaredAnnotation.value(); } // 4.判断方法上是否有加url映射地址 Method[] declaredMethods = classInfo.getDeclaredMethods(); for (Method method : declaredMethods) { // 判断方法上是否有加url映射注解 ExtRequestMapping methodExtRequestMapping = method.getDeclaredAnnotation(ExtRequestMapping.class); if (methodExtRequestMapping != null) { String methodUrl = baseUrl + methodExtRequestMapping.value(); // springmvc 容器对象 keya:请求地址 ,vlue类 urlBeans.put(methodUrl, object); // springmvc 容器对象 key:请求地址 ,value 方法名称 urlMethods.put(methodUrl, method.getName()); } } } } }
controller:
@ExtController @ExtRequestMapping("/ext") public class ExtIndexController { //ext/test/?name=122&age=6440654 @ExtRequestMapping("/test") public String test(String name,Integer age) { System.out.println("手写springmvc框架..."); return "index"; } }
Controller注解:
@Target({ ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) public @interface ExtController { }
RequestMapping注解:
@Target({ ElementType.METHOD, ElementType.TYPE }) @Retention(RetentionPolicy.RUNTIME) public @interface ExtRequestMapping { String value() default ""; }
Util方法:
public class ClassUtil { /** * 取得某个接口下所有实现这个接口的类 */ public static List<Class> getAllClassByInterface(Class c) { List<Class> returnClassList = null; if (c.isInterface()) { // 获取当前的包名 String packageName = c.getPackage().getName(); // 获取当前包下以及子包下所以的类 List<Class<?>> allClass = getClasses(packageName); if (allClass != null) { returnClassList = new ArrayList<Class>(); for (Class classes : allClass) { // 判断是否是同一个接口 if (c.isAssignableFrom(classes)) { // 本身不加入进去 if (!c.equals(classes)) { returnClassList.add(classes); } } } } } return returnClassList; } /* * 取得某一类所在包的所有类名 不含迭代 */ public static String[] getPackageAllClassName(String classLocation, String packageName) { // 将packageName分解 String[] packagePathSplit = packageName.split("[.]"); String realClassLocation = classLocation; int packageLength = packagePathSplit.length; for (int i = 0; i < packageLength; i++) { realClassLocation = realClassLocation + File.separator + packagePathSplit[i]; } File packeageDir = new File(realClassLocation); if (packeageDir.isDirectory()) { String[] allClassName = packeageDir.list(); return allClassName; } return null; } /** * 从包package中获取所有的Class * * @param pack * @return */ public static List<Class<?>> getClasses(String packageName) { // 第一个class类的集合 List<Class<?>> classes = new ArrayList<Class<?>>(); // 是否循环迭代 boolean recursive = true; // 获取包的名字 并进行替换 String packageDirName = packageName.replace('.', '/'); // 定义一个枚举的集合 并进行循环来处理这个目录下的things Enumeration<URL> dirs; try { dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName); // 循环迭代下去 while (dirs.hasMoreElements()) { // 获取下一个元素 URL url = dirs.nextElement(); // 得到协议的名称 String protocol = url.getProtocol(); // 如果是以文件的形式保存在服务器上 if ("file".equals(protocol)) { // 获取包的物理路径 String filePath = URLDecoder.decode(url.getFile(), "UTF-8"); // 以文件的方式扫描整个包下的文件 并添加到集合中 findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes); } else if ("jar".equals(protocol)) { // 如果是jar包文件 // 定义一个JarFile JarFile jar; try { // 获取jar jar = ((JarURLConnection) url.openConnection()).getJarFile(); // 从此jar包 得到一个枚举类 Enumeration<JarEntry> entries = jar.entries(); // 同样的进行循环迭代 while (entries.hasMoreElements()) { // 获取jar里的一个实体 可以是目录 和一些jar包里的其他文件 如META-INF等文件 JarEntry entry = entries.nextElement(); String name = entry.getName(); // 如果是以/开头的 if (name.charAt(0) == '/') { // 获取后面的字符串 name = name.substring(1); } // 如果前半部分和定义的包名相同 if (name.startsWith(packageDirName)) { int idx = name.lastIndexOf('/'); // 如果以"/"结尾 是一个包 if (idx != -1) { // 获取包名 把"/"替换成"." packageName = name.substring(0, idx).replace('/', '.'); } // 如果可以迭代下去 并且是一个包 if ((idx != -1) || recursive) { // 如果是一个.class文件 而且不是目录 if (name.endsWith(".class") && !entry.isDirectory()) { // 去掉后面的".class" 获取真正的类名 String className = name.substring(packageName.length() + 1, name.length() - 6); try { // 添加到classes classes.add(Class.forName(packageName + '.' + className)); } catch (ClassNotFoundException e) { e.printStackTrace(); } } } } } } catch (IOException e) { e.printStackTrace(); } } } } catch (IOException e) { e.printStackTrace(); } return classes; } /** * 以文件的形式来获取包下的所有Class * * @param packageName * @param packagePath * @param recursive * @param classes */ public static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive, List<Class<?>> classes) { // 获取此包的目录 建立一个File File dir = new File(packagePath); // 如果不存在或者 也不是目录就直接返回 if (!dir.exists() || !dir.isDirectory()) { return; } // 如果存在 就获取包下的所有文件 包括目录 File[] dirfiles = dir.listFiles(new FileFilter() { // 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件) public boolean accept(File file) { return (recursive && file.isDirectory()) || (file.getName().endsWith(".class")); } }); // 循环所有文件 for (File file : dirfiles) { // 如果是目录 则继续扫描 if (file.isDirectory()) { findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive, classes); } else { // 如果是java类文件 去掉后面的.class 只留下类名 String className = file.getName().substring(0, file.getName().length() - 6); try { // 添加到集合中去 classes.add(Class.forName(packageName + '.' + className)); } catch (ClassNotFoundException e) { e.printStackTrace(); } } } } // 首字母转小写 public static String toLowerCaseFirstOne(String s) { if (Character.isLowerCase(s.charAt(0))) return s; else return (new StringBuilder()).append(Character.toLowerCase(s.charAt(0))).append(s.substring(1)).toString(); } // 初始化对象 public static Object newInstance(Class<?> classInfo) throws ClassNotFoundException, InstantiationException, IllegalAccessException { return classInfo.newInstance(); } }
JSP:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Insert title here</title> </head> <body> <h1>写springmvc.....视图</h1> </body> </html>
执行流程:
1、 用户向服务器发送请求,请求被 Spring 前端控制 Servelt DispatcherServlet 捕获(捕获)
2、 DispatcherServlet对请求 URL进行解析,得到请求资源标识符(URI)。然后根据该 URI,调用 HandlerMapping获得该Handler配置的所有相关的对象(包括 Handler对象以及 Handler对象对应的拦截器),最后以 HandlerExecutionChain对象的形式返回;(查找 handler)
3、 DispatcherServlet 根据获得的 Handler,选择一个合适的 HandlerAdapter。 提取Request 中的模型数据,填充 Handler 入参,开始执行 Handler(Controller), Handler执行完成后,向 DispatcherServlet 返回一个 ModelAndView 对象(执行 handler)
4、DispatcherServlet 根据返回的 ModelAndView,选择一个适合的ViewResolver(必须是已经注册到 Spring 容器中的 ViewResolver) (选择 ViewResolver)
5、通过 ViewResolver 结合 Model 和 View,来渲染视图,DispatcherServlet 将渲染结果返回给客户端。(渲染返回)
快速记忆技巧:
核心控制器捕获请求、查找Handler、执行Handler、选择ViewResolver,通过ViewResolver渲染视图并返回