一:springmvc 需要实现哪些功能?
情景描述:
浏览器输入地址 127.0.0.1:8080/xwf/test
请求被拦截,做相应的处理,再返回浏览器,跳转对应的页面
需要实现功能:
- 如何拦截请求
- 如何知道拦截url地址/xwf/test 跳转对应的方法
- 通过哪种方式执行该方法
- 如何跳转jsp页面
二:实现原理
- 通过web.xml文件配置servlet拦截,指向自己实现类ExtDispatcherServlet(此为springmvc核心)
- 实现@RequestMapping注解,在容器启动时扫包,第一:将带有该注解的方法和url地址映射关系存放在集合中 第二:将该类的实例和url映射关系存放在集合中,为后面的请求分发和方法调用做准备
- 实现@controller注解,可以参考https://blog.csdn.net/xiewenfeng520/article/details/81542639
- 通过类和方法名,反射的方式执行该方法
- 封装简易视图解析器,通过request.RequestDispatcher进行跳转
三:实现步骤
1.pom文件引入相关基础包
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.6</version>
</dependency>
2.新建web.xml文件
配置servlet拦截
<!-- Spring MVC 核心控制器 DispatcherServlet 配置 -->
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>com.huajie.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>
3.创建@controller,@RequestMappring注解
package com.huajie.ext.springmvc.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 XwfController {
}
package com.huajie.ext.springmvc.annotation;
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 XwfRequestMapping {
String value() default "";
}
4.创建扫包工具类ClassUtil.java
package com.huajie.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) {
try {
return classInfo.newInstance();
} catch (Exception e) {
throw new RuntimeException("反射生成对象失败" + e.getMessage());
}
}
}
5.核心类ExtDispatcherServlet编写
核心代码说明:
5.1 创建三个容器,分别存放java对象名称和实例Map集合,requestMapping中url和实例Map集合,requestMapping中url和实例中方法名称Map集合
// springmvc容器对象 bean编号和实例Map集合
ConcurrentHashMap<String, Object> springmvcBeans = new ConcurrentHashMap<String, Object>();
// springmvc容器对象 key url value 类 Map集合
ConcurrentHashMap<String, Object> urlBeans = new ConcurrentHashMap<String, Object>();
// springmvc容器对象 key url value 方法名称 Map集合
ConcurrentHashMap<String, String> urlMethod = new ConcurrentHashMap<String, String>();
在扫包的过程中判断注解,并将对应关系存储在上面三个容器中
5.2 使用反射机制执行url对应类实例的方法
// 4.使用反射机制执行方法
private Object methodInvoke(Object bean, String methodName) {
Class<?> classInfo = bean.getClass();
try {
Method method = classInfo.getMethod(methodName);
method.setAccessible(true);
Object reuslt = method.invoke(bean);
return reuslt;
} catch (Exception e) {
throw new RuntimeException();
}
}
5.3 视图解析器
private void extResourceViewResolver(HttpServletRequest req, HttpServletResponse resp, String reusltPage) throws ServletException, IOException {
String prefix = "/";
String suffix = ".jsp";
req.getRequestDispatcher(prefix + reusltPage + suffix).forward(req, resp);
}
5.4 完整代码如下:
package com.huajie.ext.springmvc.servlet;
import java.io.IOException;
import java.lang.reflect.Method;
import java.util.List;
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.huajie.ext.springmvc.annotation.XwfController;
import com.huajie.ext.springmvc.annotation.XwfRequestMapping;
import com.huajie.utils.ClassUtil;
/**
* @author Administrator 自定义前端控制器<br>
* 1.创建一个前端控制器ExtDispatcherServlet 拦截所有请求做分发<br>
* 2.重新servlet的init方法<br>
* #2.1 将扫包范围内所有的类有注解,注入到springmvc容器,存放在map集合,key为类名小写,value为对象<br>
* #2.2 将url和方法进行关联,判断方法上是否有注解,使用反射机制循环遍历类里面的所有方法,将有注解的方法封装到map集合中<br>
* 3.请求处理,重写GET,POST方法<br>
* #3.1获取url,冲urlbeans集合中获取实例的对象和方法,通过反射执行<br>
*/
public class ExtDispatcherServlet extends HttpServlet {
// 扫包范围
// springmvc容器对象 bean编号和实例Map集合
ConcurrentHashMap<String, Object> springmvcBeans = new ConcurrentHashMap<String, Object>();
// springmvc容器对象 key url value 类 Map集合
ConcurrentHashMap<String, Object> urlBeans = new ConcurrentHashMap<String, Object>();
// springmvc容器对象 key url value 方法名称 Map集合
ConcurrentHashMap<String, String> urlMethod = new ConcurrentHashMap<String, String>();
@Override
public void init() throws ServletException {
// 1.获取当前包下面所有的类
// 1.扫包
List<Class<?>> classes = ClassUtil.getClasses("com.huajie");
// 2.判断哪些类有注解,存放到map集合中
ConcurrentHashMap<String, Object> findClassExisAnnotation = findClassExisAnnotation(classes);
if (findClassExisAnnotation == null || findClassExisAnnotation.isEmpty()) {
throw new RuntimeException("该包下没有这个注解");
}
// 3.将url映射和方法进行关联
handerMapping();
}
@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.获取请求地址
String url = req.getRequestURI();
if (StringUtils.isEmpty(url)) {
return;
}
// 2.从Map集合中获取控制对象
Object bean = urlBeans.get(url);
if (bean == null) {
resp.getWriter().println("not found 404 url...");
return;
}
// 3.使用url获取方法
String methodName = urlMethod.get(url);
if (StringUtils.isEmpty(methodName)) {
resp.getWriter().println("not found method...");
return;
}
// 4.使用反射机制执行方法 获取方法的结果
String reusltPage = String.valueOf(methodInvoke(bean, methodName));
// resp.getWriter().println(reusltPage);
// 5.调用视图转换器渲染页面
extResourceViewResolver(req, resp, reusltPage);
}
private void extResourceViewResolver(HttpServletRequest req, HttpServletResponse resp, String reusltPage) throws ServletException, IOException {
String prefix = "/";
String suffix = ".jsp";
req.getRequestDispatcher(prefix + reusltPage + suffix).forward(req, resp);
}
// 4.使用反射机制执行方法
private Object methodInvoke(Object bean, String methodName) {
Class<?> classInfo = bean.getClass();
try {
Method method = classInfo.getMethod(methodName);
method.setAccessible(true);
Object reuslt = method.invoke(bean);
return reuslt;
} catch (Exception e) {
throw new RuntimeException();
}
}
// 3.将url映射和方法进行关联
private void handerMapping() {
// 1.获取springmvc bean容器对象
for (Object obj : springmvcBeans.keySet()) {
System.out.println("key=" + obj + " value=" + springmvcBeans.get(obj));
// 2.遍历springmvc 判断类上面是否有url注解
Class<?> classInfo = springmvcBeans.get(obj).getClass();
XwfRequestMapping annotation = classInfo.getAnnotation(XwfRequestMapping.class);
String BaseUrl = "";
if (annotation != null) {
BaseUrl = annotation.value();
}
String url = "";
// 判断方法上是否有url地址
Method[] declaredMethods = classInfo.getDeclaredMethods();
for (Method method : declaredMethods) {
// 判断方法上是否有XwfRequestMapping
XwfRequestMapping mAnnotation = method.getAnnotation(XwfRequestMapping.class);
if (mAnnotation != null) {
url = BaseUrl + mAnnotation.value();
// springmvc容器key url value 类
urlBeans.put(url, springmvcBeans.get(obj));
// springmvc容器对象 key url value 方法名称
urlMethod.put(url, method.getName());
}
}
}
}
// 是否有注解
public ConcurrentHashMap<String, Object> findClassExisAnnotation(List<Class<?>> classes) {
for (Class<?> class1 : classes) {
XwfController annotation = class1.getAnnotation(XwfController.class);
if (annotation != null) {
// beanId 类名小写
String beanId = ClassUtil.toLowerCaseFirstOne(class1.getSimpleName());
Object newInstance = ClassUtil.newInstance(class1);
springmvcBeans.put(beanId, newInstance);
}
}
return springmvcBeans;
}
}
四:测试
package com.huajie.controller;
import com.huajie.ext.springmvc.annotation.XwfController;
import com.huajie.ext.springmvc.annotation.XwfRequestMapping;
@XwfController
@XwfRequestMapping("/xwf")
public class UserController {
@XwfRequestMapping("/test")
public String add() {
System.out.println("手写springmvc...");
return "index";
}
}