手写SpringMVC
- Spring Web MVC 是一个原生包含在Spring家族里的基于Servlet API的web框架。其正式名称“Spring Web MVC”来自其源模块Spring-webmvc的名称，但它更广为人知的名称是“Spring MVC”。
- Spring MVC 是一个模型 - 视图 - 控制器（MVC）的Web框架，核心是前端控制器DispatcherServlet，它负责发送每个请求到合适的处理程序，使用视图来最终返回响应结果。Spring MVC 是 Spring 产品组合的一部分，它享有 Spring IoC容器紧密结合Spring松耦合等特点，因此它有Spring的所有优点。
本文模拟SpringMVC的处理流程，实现一个mini班的前端控制器~
- 自定义注解
package com.zpc.annotation;
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)
public @interface MyController {
}
package com.zpc.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 自定义RequestMapping
*/
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface MyRequestMapping {
String value() default "";
}- 自定义前端控制器
package com.zpc.servlet;
import com.zpc.annotation.MyController;
import com.zpc.annotation.MyRequestMapping;
import com.zpc.utils.ClassUtil;
import org.apache.commons.lang.StringUtils;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* 自定义前端控制器(手写springmvc)原理分析
* 1.创建一个前端控制器MyDispatcherServlet拦截所有请求
* 2.初始化操作,重写servlet init 方法
* 2.1 扫描指定包的所有的类,注入到springmvc容器，存放在Map集合中，key为默认类名小写，value为对象
* 2.2 将url映射和方法进行关联
* 2.3 判断类上是否有注解,使用java反射机制循环遍历方法 ；判断方法上是否存在注解，进行封装url和方法对应存入集合中
* 3.处理请求，重写doGet或者是doPost方法
* 获取请求url,从urlBeans集合获取实例对象,获取成功实例对象后,调用urlMethods集合获取方法名称,使用反射机制执行方法
*/
public class MyDispatcherServlet extends HttpServlet {
/**
* springmvc容器对象，存放controller实例。key:类名id ,value为类实例
*/
private ConcurrentHashMap springmvcBeans = new ConcurrentHashMap();
/**
* springmvc容器对象，存放请求地址和类名的映射。 key:请求地址,value:类实例
*/
private ConcurrentHashMap urlBeans = new ConcurrentHashMap();
/**
* springmvc容器对象，存放请求地址和方法名的映射。key:请求地址,value:方法名称
*/
private ConcurrentHashMap urlMethods = new ConcurrentHashMap();
@Override
public void init() throws ServletException {
// 1.获取当前包下的所有的类
List> classes = ClassUtil.getClasses("com.zpc.controller");
// 2.将扫包范围所有的类,注入到springmvc容器(springmvcBeans)里面，存放在Map集合
try {
findClassMVCAnnotation(classes);
} catch (Exception e) {
e.printStackTrace();
}
// 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 {
resp.setContentType("text/html;charset=UTF-8");
// 1.获取请求url地址
String requestURI = req.getRequestURI();
if (StringUtils.isEmpty(requestURI)) {
return;
}
// 2.从Map集合中获取控制对象
Object object = urlBeans.get(requestURI);
if (object == null) {
resp.getWriter().println(" 404. 抱歉! 您访问的资源不存在!");
return;
}
// 3.使用url地址获取方法
String methodName = urlMethods.get(requestURI);
if (StringUtils.isEmpty(methodName)) {
resp.getWriter().println(" 404. 抱歉! 您访问的资源不存在!");
}
// 4.使用java的反射机制调用方法
String resultPage = (String) methodInvoke(object, methodName);
// 5.调用视图转换器渲染给页面展示
myResourceViewResolver(resultPage, req, resp);
}
private void myResourceViewResolver(String pageName, HttpServletRequest req, HttpServletResponse res)
throws ServletException, IOException {
// 根路径
String prefix = "/";
String suffix = ".jsp";
req.getRequestDispatcher(prefix + pageName + suffix).forward(req, res);
}
private Object methodInvoke(Object object, String methodName) {
try {
Class 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> classes)
throws ClassNotFoundException, InstantiationException, IllegalAccessException {
for (Class classInfo : classes) {
// 判断类上是否有加上注解
MyController MyController = classInfo.getDeclaredAnnotation(MyController.class);
if (MyController != 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 mvcBean : springmvcBeans.entrySet()) {
// 2.遍历所有的方法上是否有url映射注解
// 获取bean的对象
Object object = mvcBean.getValue();
// 3.判断类上是否有加url映射注解
Class classInfo = object.getClass();
MyRequestMapping declaredAnnotation = classInfo.getDeclaredAnnotation(MyRequestMapping.class);
String baseUrl = "";
if (declaredAnnotation != null) {
// 获取类上的url映射地址
baseUrl = declaredAnnotation.value();
}
// 4.判断方法上是否有加url映射地址
Method[] declaredMethods = classInfo.getDeclaredMethods();
for (Method method : declaredMethods) {
// 判断方法上是否有加url映射注解
MyRequestMapping methodMyRequestMapping = method.getDeclaredAnnotation(MyRequestMapping.class);
if (methodMyRequestMapping != null) {
String methodUrl = baseUrl + methodMyRequestMapping.value();
// springmvc 容器对象 key:请求地址,vlue:类实例
urlBeans.put(methodUrl, object);
// springmvc 容器对象 key:请求地址,value:方法名称
urlMethods.put(methodUrl, method.getName());
}
}
}
}
}
- ClassUtil工具类
package com.zpc.utils;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
public class ClassUtil {
/**
* 取得某个接口下所有实现这个接口的类
*/
public static List getAllClassByInterface(Class c) {
List returnClassList = null;
if (c.isInterface()) {
// 获取当前的包名
String packageName = c.getPackage().getName();
// 获取当前包下以及子包下所以的类
List> allClass = getClasses(packageName);
if (allClass != null) {
returnClassList = new ArrayList();
for (Class classes : allClass) {
// 判断是否是同一个接口
if (c.isAssignableFrom(classes)) {
// 本身不加入进去
if (!c.equals(classes)) {
returnClassList.add(classes);
}
}
}
}
}
return returnClassList;
}
/**
* 取得某个类所在package的所有类名
*
* @param classLocation
* @param packageName
* @return
*/
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 packageName
* @return
*/
public static List> getClasses(String packageName) {
// 第一个class类的集合
List> classes = new ArrayList>();
// 是否循环迭代
boolean recursive = true;
// 获取包的名字 并进行替换
String packageDirName = packageName.replace('.', '/');
// 定义一个枚举的集合 并进行循环来处理这个目录下的things
Enumeration 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 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> classes) {
// 获取此包的目录 建立一个File
File dir = new File(packagePath);
// 如果不存在或者 也不是目录就直接返回
if (!dir.exists() || !dir.isDirectory()) {
return;
}
// 如果存在 就获取包下的所有文件 包括目录
File[] dirfiles = dir.listFiles(new FileFilter() {
// 自定义过滤规则 如果可以循环(包含子目录) 或者是以.class结尾的文件(编译好的java类文件)
@Override
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();
}
}
- 测试，看效果
web.xml文件
<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">
<servlet>
<servlet-name>myDispatcherservlet-name>
<servlet-class>com.zpc.servlet.MyDispatcherServletservlet-class>
<load-on-startup>1load-on-startup>
servlet>
<servlet-mapping>
<servlet-name>myDispatcherservlet-name>
<url-pattern>/url-pattern>
servlet-mapping>
web-app>TestController.java
package com.zpc.controller;
import com.zpc.annotation.MyController;
import com.zpc.annotation.MyRequestMapping;
@MyController
@MyRequestMapping("/mymvc")
public class TestController {
@MyRequestMapping("/test")
public String test() {
System.out.println("手动实现迷你版springmvc框架");
return "index";
}
}
- 本文只是简单地实现了SpringMVC的处理流程，更加复杂完备的功能敬请期待~