源码分析篇之手写springvc

1.先建立maven的web项目，结构如下

2.在web.xml添加如下配置

	<servlet>
		<servlet-name>dispatcher</servlet-name>
		<servlet-class>com.mayikt.aop.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>

3.自定义注解：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface ExtController {
}
///////////////////////////////////
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface ExtRequestMapping {
    String value();
}

3.反射的工具类

package com.mayikt.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<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();
	}
}

4.重写DispatcherServlet的关键方法

package com.mayikt.aop;

import com.mayikt.annotation.ExtController;
import com.mayikt.annotation.ExtRequestMapping;
import com.mayikt.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.自定义前端控制器拦截请求
 * * 2.重写servlet的init方法
 * *   ------------2.1将扫包范围内的类注入springvc容器
 * *    -----------2.2将url与方法关联
 * ----------------------2.2.1判断方法上是否加了注解
 * *    -----------2.3处理请求
 * * 3.重写doget   dopost
 * ----3.1获取url，从urlBeans获取实例对象，从而获取方法名称
 *
 * @author wangyu
 * @version 1.0
 * @date $2018/11/21$ $17:12$
 */
public class ExtDispatcherServlet extends HttpServlet {
    //线程安全的集合使用key为类名id  value为对象
    private ConcurrentHashMap<String, Object> springBeans = new ConcurrentHashMap<String, Object>();
    //springmvc容器对象key:url地址，value:类
    private ConcurrentHashMap<String, Object> urlBeans    = new ConcurrentHashMap<String, Object>();
    //springmvc容器对象key:url地址，value:方法名称
    private ConcurrentHashMap<String, String> urlMethods  = new ConcurrentHashMap<String, String>();

    @Override
    public void init() throws ServletException {
        //1.获取当前包下的类
        List<Class<?>> classList = ClassUtil.getClasses("com.mayikt.controller");
        //2.判断该类是否加了自定义控制器注解，创建实例
        try {
            //将扫包范围内的类注入springvc容器
            findClassesAnnotation(classList);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();

        }
        //2.2将url映射与方法关联
        handlerMapping();

    }

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doPost(req, resp);
    }

    //2.1将扫包范围内的类注入springvc容器
    public void findClassesAnnotation(List<Class<?>> classList) throws ClassNotFoundException, InstantiationException, IllegalAccessException {
        for (Class<?> classInfo : classList) {
            // 判断该类是否加了自定义控制器注解
            ExtController annotation = classInfo.getAnnotation(ExtController.class);
            if (annotation != null) {
                //默认类型小名
                String beanId = ClassUtil.toLowerCaseFirstOne(classInfo.getSimpleName());
                //实例化对象
                Object obj = ClassUtil.newInstance(classInfo);
                springBeans.put(beanId, obj);
            }
        }
    }

    //2.2将url映射与方法关联
    public void handlerMapping() {
        //1.获取springmvcBaen容器对象
        for (Map.Entry<String, Object> mvcBean : springBeans.entrySet()) {
            //2.遍历springmvcBaen容器判断url是否存在映射注解
            Object mvcBeanValue = mvcBean.getValue();
            //3.遍历所有方法上是否有url注解
            Class<? extends Object> classInfo = mvcBeanValue.getClass();
            ExtRequestMapping extRequestMapping = classInfo.getAnnotation(ExtRequestMapping.class);
            String baseUrl = "";
            if (extRequestMapping != null) {
                //获取类上面的url
                baseUrl = extRequestMapping.value();
            }
            //4.判断方法上是否有url注解
            Method[] declaredMethods = classInfo.getDeclaredMethods();
            for (Method method : declaredMethods) {
                //获取方法上的url注解
                ExtRequestMapping methodExtRequestMapping = method.getAnnotation(ExtRequestMapping.class);
                if (methodExtRequestMapping != null) {
                    System.out.println("该方法的url注解：" + methodExtRequestMapping);
                    String methodUrl = baseUrl + methodExtRequestMapping.value();
                    //springmvc容器对象key:url地址，value:类
                    urlBeans.put(methodUrl, mvcBeanValue);
                    //springmvc容器对象key:url地址，value:方法名称
                    System.out.println("key:" + methodUrl + ",获取urlBeans对应的value:" + urlBeans.get(methodUrl));
                    urlMethods.put(methodUrl, method.getName());
                }
            }

        }

    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //-------------------------处理请求
        //1.获取 url地址
        String requestURI = req.getRequestURI();
        if (StringUtils.isEmpty(requestURI)) {
            return;
        }
        System.out.println("获取requestURI：" + requestURI);
        //2.从map集合获取控制对象
        Object object = urlBeans.get(requestURI);
        if (object == null) {
            System.out.println("获取obj：" + object);
            resp.getWriter().print("not found 404");
            return;
        }
        //3.使用url地址获取方法
        String methodName = urlMethods.get(requestURI);
        if (StringUtils.isEmpty(methodName)) {
            System.out.println("获取methodName：" + methodName);
            resp.getWriter().print("not found method");
            return;
        }
        //4.使用反射机制调用方法
        String resultPage = (String) methodInvoke(object, methodName);
        //resp.getWriter().print(resultPage);
        //5.调用试图转换器渲染页面
        extResourceViewResolver(resultPage, req, resp);
    }

    private void extResourceViewResolver(String pageName, HttpServletRequest request, HttpServletResponse reps) throws ServletException, IOException {
        String prefix = "/";
        String suffix = ".jsp";
        request.getRequestDispatcher(prefix + pageName + suffix).forward(request, reps);
    }

    private Object methodInvoke(Object object, String methodName) {
        try {
            Class<?> classInfo = object.getClass();
            Method method = classInfo.getMethod(methodName);
            return method.invoke(object);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }

    }
}

5.测试

@ExtController
@ExtRequestMapping("/myController")
public class IndexController {

    @ExtRequestMapping("/test")
    public Object test() {
        return "test";
    }

    @ExtRequestMapping("/index")
    public Object testExtJsp() {
        return "index";
    }
}

6.效果