实现自己的SpringMVC
一.SpringMVC的工作原理
SpringMVC流程
1、 用户发送请求至前端控制器DispatcherServlet。
2、 DispatcherServlet收到请求调用HandlerMapping处理器映射器。
3、 处理器映射器找到具体的处理器(可以根据xml配置、注解进行查找)，生成处理器对象及处理器拦截器(如果有则生成)一并返回给DispatcherServlet。就是根据url找到handler
4、 DispatcherServlet调用HandlerAdapter处理器适配器。
5、 HandlerAdapter经过适配调用具体的处理器(Controller，也叫后端控制器)。
6、 Controller执行完成返回ModelAndView。
7、 HandlerAdapter将controller执行结果ModelAndView返回给DispatcherServlet。
8、 DispatcherServlet将ModelAndView传给ViewReslover视图解析器。
9、 ViewReslover解析后返回具体View。
10、DispatcherServlet根据View进行渲染视图（即将模型数据填充至视图中）。
11、 DispatcherServlet响应用户。
二.设计思路
实现@Controller、@RequestMapping、@RequestParam注解
SpringMVC本质上是一个Servlet,这个 Servlet 继承自 HttpServlet。
2.1 读取配置
为了读取web.xml中的配置，我们用到ServletConfig这个类，它代表当前Servlet在web.xml中的配置信息。通过web.xml中加载我们自己写的MyDispatcherServlet和读取配置文件。
2.2 初始化
- 加载配置文件
- 扫描所有相关联的类,扫描用户设定的包下面所有的类
- 将类放到ioc容器中：通过反射机制，进行实例化，放到ioc容器中。（就是一个map<beanName, new BeanName()>）
- 找到类下的方法：初始化HandlerMapping，就是把url和method对应起来放在一个k-v的Map中,在运行阶段取出
2.3 运行
每一次请求将会调用doGet或doPost方法，所以统一运行阶段都放在doDispatch方法里处理，它会根据url请求去HandlerMapping中匹配到对应的Method，然后利用反射机制调用Controller中的url对应的方法，并得到结果返回。按顺序包括以下功能：
-
异常的拦截
-
获取请求传入的参数并处理参数
-
通过初始化好的handlerMapping中拿出url对应的方法名，反射调用。
三.代码实现
3.1 工程目录
3.2 新建一个maven项目，选择webapp，在pom.xml加上servlet依赖：
<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.mlnk</groupId> <artifactId>mlnkMVC</artifactId> <packaging>war</packaging> <version>0.0.1-SNAPSHOT</version> <name>mlnkMVC Maven Webapp</name> <url>http://maven.apache.org</url> <dependencies> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>4.0.0</version> </dependency> </dependencies> <build> <finalName>mlnkMVC</finalName> </build> </project>
3.3 在WEB-INFO里写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-name>MySpringMVC</servlet-name> <servlet-class>com.mlnk.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>
3.4 application.properties文件中，配置要扫描的包到SpringMVC容器中。
scanPackage=com.mlnk
3.5 创建MyController注解，它只能标注在类上面：
package com.mlnk.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 { String value() default ""; }
创建MyRequestMapping注解：
package com.mlnk.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 { /** * 表示给controller注册别名 * @return */ String value() default ""; }
创建MyRequestParam注解，标注在参数上
package com.mlnk.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; //RequestParam注解,只能注解在参数上 @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface MyRequestParam { /** * 表示参数的别名，必填 * @return */ String value(); }
3.6 创建MyDispatcherServlet类，继承HttpServlet，重写init方法、doGet、doPost方法，以及加上我们第二步分析时要实现的功能：
package com.mlnk.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.mlnk.annotation.MyController; import com.mlnk.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值的文件加载到流里面 //就是读application.properties 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); System.out.println("扫描到className: " + classNames); } } } 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: " + url + ",method: " + 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); } }
开发完成，测试一下：
package com.mlnk.controller; import java.io.IOException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import com.mlnk.annotation.MyController; import com.mlnk.annotation.MyRequestMapping; import com.mlnk.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(); } } }
启动tomcat,打印的信息：
扫描到className: [com.mlnk.controller.TestController] url: /test/doTest2,method: public void com.mlnk.controller.TestController.test2(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse) url: /test/doTest,method: public void com.mlnk.controller.TestController.test1(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,java.lang.String)
输入地址：http://localhost:8080/mlnkMVC/test/doTest?param=mlnk
测试成功！
本文供自己整理笔记，参照着大神博客实现：
https://mp.weixin.qq.com/s/36F_fFbGKkRL20DJgX4ahg
https://www.cnblogs.com/xiaoxi/p/6164383.html
