纯手写springmvc框架

最新推荐文章于 2024-09-24 22:46:46 发布

code_须臾

最新推荐文章于 2024-09-24 22:46:46 发布

阅读量748

点赞数

文章标签：怎么写代码如何手写框架 springmvc

本文链接：https://blog.csdn.net/qq_38357267/article/details/82807553

版权

我的 github代码地址：https://github.com/xuyuadmin/spring-mvc-ext-dispatcher

controller层：

package com.xuyu.ext.springmvc.controller;

import com.xuyu.ext.springmvc.exannotation.ExtController;
import com.xuyu.ext.springmvc.exannotation.ExtRequestMapping;

@ExtController
@ExtRequestMapping("/ext")
public class ExtIndexController {

	@ExtRequestMapping("/text")
	public String test() {
		System.out.println("手写springmvc");
		return "index";
	}
}

exannotation层：

package com.xuyu.ext.springmvc.exannotation;

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  ExtController {

}

package com.xuyu.ext.springmvc.exannotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;


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

servlet层：

package com.xuyu.ext.springmvc.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.xuyu.ext.springmvc.exannotation.ExtController;
import com.xuyu.ext.springmvc.exannotation.ExtRequestMapping;
import com.xuyu.ext.springmvc.utils.ClassUtil;

/** 自定义前端控制器

 * 手写springmvc注解版本原理
 * 1.创建一个前端控制器（）ExtDispatcherServlet 拦截所有请求
 * 2.初始化操作 重写servlet 的init 方法
 * 		2.1开始扫包，将扫包范围的所有类注入到springmvc容器里面，存放map集合中key为默认类名小写，value为对象
 * 		2.2将URL映射和方法进行关联
 * 			2.2.1判断类上是否有注解，使用Java反射机制循环遍历方法是否有注解，进行封装url和方法对应
 * 3.处理请求 重写Get或者Post方法
 * 		3.1获取请求url，去urlBeans集合中获取实例对象，获取成功实例对象后，调用urlMethods集合获取方法名称，使用反射机制执行
 * 
 * @author Administrator
 *
 */
//【一】：创建一个前端控制器 ExtDispatcherServlet 继承HttpServlet
public class ExtDispatcherServlet extends HttpServlet{

	//定义扫包范围
	private  String packageName="com.xuyu.ext.springmvc.controller";
	/**
	 * new 3个map集合来存
	 */
	//springmvc容器对象 key为类名id，value为类对象
	private ConcurrentHashMap<String, Object>map1=new ConcurrentHashMap<String, Object>();
	//springmvc容器对象 key为请求地址，value为类对象
	private ConcurrentHashMap<String, Object>map2=new ConcurrentHashMap<String, Object>();
	//springmvc 容器对象 key为请求地址，value为方法名称
	private ConcurrentHashMap<String, String>map3=new ConcurrentHashMap<String, String>();

	/**
	 * 【二】：重写HttpServlet的init()方法
	 */
	@Override
	public void init() throws ServletException {
		//1.扫包去获得当前包下的所有类
		List<Class<?>> classes = ClassUtil.getClasses(packageName);
		try {
			//2.判断类上是否加上ExtController注解
			findClassMvcAnnotation(classes);
		} catch (Exception e) {
			e.printStackTrace();
		}
		//3.将url映射和方法进行关联
		handlerMapping();
	}
	public void findClassMvcAnnotation(List<Class<?>> classes) throws Exception {
		for (Class<?> classInfo : classes) {
			ExtController extControllerAnnotation = classInfo.getDeclaredAnnotation(ExtController.class);
			//3.如果类上存在相对应的注解
			if(extControllerAnnotation!=null) {
				//①将类名首字母转小写作为beanId
				String beanId = ClassUtil.toLowerCaseFirstOne(classInfo.getSimpleName());
				//②使用java反射机制实例化对象得到beanObject
				Object beanObject = ClassUtil.newInstance(classInfo);
				//③把对象的beanId作为key，beanObject作为value存map1集合
				map1.put(beanId, beanObject);
			}
		}
	}
	//【三】：将url映射和方法进行关联
	public void handlerMapping() {
		for (Map.Entry<String, Object> map1BeanObject : map1.entrySet()) {
			//1.从map1集合中循环遍历获取beanObject实例对象
			Object beanObject = map1BeanObject.getValue();
			//2.通过beanObject实例对象得到对象类型
			Class<? extends Object> classInfo = beanObject.getClass();
			//3.通过这个对象类型去获得ExtRequestMapping注解
			ExtRequestMapping extRequestMapping = classInfo.getDeclaredAnnotation(ExtRequestMapping.class);
			String beanClassUrl ="";
			//4.如果类上存在相对应的注解
			if(extRequestMapping!=null) {
				//获取这个类上的注解的value值就是对应url映射地址
				beanClassUrl = extRequestMapping.value();
			}
			//5.根据这个类信息去获取这个类下的所有方法
			Method[] declaredMethods = classInfo.getDeclaredMethods();
			//6.循环遍历得到的方法
			for (Method method : declaredMethods) {
				//6.1根据方法名称去查找这个方法上的ExtRequestMapping注解
				ExtRequestMapping methodExTRequestMapping = method.getDeclaredAnnotation(ExtRequestMapping.class);
				//6.2.如果方法上有ExtRequestMapping注解
				if(methodExTRequestMapping!=null) {
					//1.获得这个方法上注解的value值就是对应的url映射地址
					String beanMethodUrl = methodExTRequestMapping.value();
					//2.获取方法名称
					String methodName = method.getName();
					//3.url拼接
					String realUrl=beanClassUrl+beanMethodUrl;
					//4.将地址和类对象实例存入map2集合中
					map2.put(realUrl, beanObject);
					//5.将地址和方法名称存map3集合中
					map3.put(realUrl, methodName);
				}
			}
		}
	}
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException, ServletException {
		doPost(req,resp);
	}
	@Override
	protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException, ServletException {
		//####################处理请求###########################
		//1.获取url地址
		String requestURI = req.getRequestURI();
		if(StringUtils.isEmpty(requestURI)) {
			return;
		}
		//2.从map2集合中使用url地址获取对象实例
		Object object = map2.get(requestURI);
		if(object==null) {
			resp.getWriter().println("not found 404 url");
			return;
		}
		//3.从map3集合中使用url地址获取方法名称
		String methodName = map3.get(requestURI);
		if(StringUtils.isEmpty(methodName)) {
			resp.getWriter().println("not found 404 methodName");
		}
		//4.使用java反射机制调用方法
		String methodInvokeResultPage = (String) methodInvoke(object,methodName);
		//5.使用Java反射机制获取方法返回结果
		resp.getWriter().println(methodInvokeResultPage);
		//6.调用视图转换器渲染给页面展示
		extResourceViewResolver(methodInvokeResultPage,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);
	}
	private Object methodInvoke(Object object,String methodName) {
		try {
			//1.获取对象类型
			Class<? extends Object> classInfo = object.getClass();
			//2.通过对象类型获得方法名称
			Method method = classInfo.getMethod(methodName);
			//通过方法名称反射获取方法
			Object invokeResult = method.invoke(object);
			//返回方法结果
			return invokeResult;
		} catch (Exception e) {
			e.printStackTrace();
		}
		return null;
		
	}
}

util层：

package com.xuyu.ext.springmvc.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();
	}
}

web.xml:

<!-- Spring MVC 核心控制器 DispatcherServlet 配置 -->
	<servlet>
		<servlet-name>dispatcher</servlet-name>
		<servlet-class>com.xuyu.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>

pom依赖：

<dependencies>
		<!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>javax.servlet-api</artifactId>
			<version>3.1.0</version>
			<scope>provided</scope>
		</dependency>
		<!-- https://mvnrepository.com/artifact/commons-lang/commons-lang -->
		<dependency>
			<groupId>commons-lang</groupId>
			<artifactId>commons-lang</artifactId>
			<version>2.6</version>
		</dependency>

	</dependencies>