springmvc原理详解（手写springmvc）

最近在复习框架 在网上搜了写资料 和原理 今天总结一下 希望能加深点映像  不足之处请大家指出

我就不画流程图了 直接通过代码来了解springmvc的运行机制和原理

回想用springmvc用到最多的是什么？当然是controller和RequestMapping注解啦 

首先我们来看怎样定义注解的

首先来定义@Controller

@Target表示该注解运行在什么地方

1、public static final ElementTypeTYPE      类、接口（包括注释类型）或枚举声明

2、public static final ElementTypeFIELD     字段声明（包括枚举常量）

3、public static final ElementTypeMETHOD    方法声明

4、public static final ElementTypePARAMETER     参数声明

5、public static final ElementTypeCONSTRUCTOR    构造方法声明

6、public static final ElementTypeLOCAL_VARIABLE     局部变量声明

7、public static final ElementTypeANNOTATION_TYPE     注释类型声明

8、public static final ElementTypePACKAGE    包声明

@Retention ：用来说明该注解类的生命周期。它有以下三个参数：

　　　　　RetentionPolicy.SOURCE  : 注解只保留在源文件中

　　　　　RetentionPolicy.CLASS  : 注解保留在class文件中，在加载到JVM虚拟机时丢弃

　　　　　RetentionPolicy.RUNTIME  : 注解保留在程序运行期间，此时可以通过反射获得定义在某个类上的所有注解。

@Target(ElementType.TYPE)//表示注解运行在哪里
@Retention(RetentionPolicy.RUNTIME)//用来说明该注解类的生命周期
public @interface Controller {
}

其次定义@RequestMapping

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface  RequestMapping {
public String value();//定义一个字符数组来接收路径值
}

定义好了注解 怎样让其产生效果呢？

假设程序启动运行中 我们如何去知道类上面是否存在注解了？ 这就需要用到java的反射机制了。在运行状态中对于任意一个类，都能够知道这个类的所有属性和方法，对于任意一个对象，我们都可以调用它任意的一个方法。

项目目录结构如下：



比如说在运行状态中 我们知道springmvc扫描的包为com.czmec.Controller.IndexController这个包下面  我们通过反射就可以获取改包下的信息

public class Test {
public static void main(String[] args) {
Class clazz= IndexController.class;
//判断这个类是否存在@Controller  是否标记Controller注解
if (clazz.isAnnotationPresent(Controller.class)){
System.out.println(clazz.getName()+",被标记为控制器!");
//吧标记了@Controller注解的类管理起来
String path="";
//判断标记了Controller类上是否存在@RequestMapper
if (clazz.isAnnotationPresent(RequestMapping.class)){
//如果存在 就获取注解上的路径值
RequestMapping reqAnno= (RequestMapping) clazz.getAnnotation(RequestMapping.class);
path=reqAnno.value();
}

//获取类上路径过后 再获取该类的所有公开方法进行遍历 并且判断哪些方法上有@RequestMapping
Method[] ms=clazz.getMethods();
for (Method method:ms){
//如果不存在RequestMapping注解 进入下一轮循环
if(!method.isAnnotationPresent(RequestMapping.class)){
continue;
}
System.out.println("映射对外路径"+path+method.getAnnotation(RequestMapping.class).value());
}
}
}
}

运行结果如下：



通过以上测试类 反射机制去获取加了注解的信息（个人理解：注解是一种标记 在代码做标记 然后在特定的管理下 可以通过某种动态方式找到想要的信息）
开发人员通过自己的业务需求去添加注解类 那么框架的设计就应该去吧这些添加了注解的类管理起来。

比如在springmvc配置中需要配置扫描的包 那么我们需要写一个工具类来根据配置的扫描包来管理需要管理的类

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.*;
/**
* 用来扫描指定的包下面的类
*/
public class ClassScanner {
/**
* 用来扫描指定的包下面的类
* @param basePackg 基础包
* @return  Map<String,Class<?>> Map<类,类的class实例>
*/
public static Map<String,Class<?>> scannerClass(String basePackg){
Map<String,Class<?>> results=new HashMap<String, Class<?>>();
//com.czmec.controller
//通过包名替换成 com/czmec/controller
String filePath=basePackg.replace(".","/");
//通过类加载器获取完整路径
try {
Enumeration<URL> dirs=Thread.currentThread().getContextClassLoader().getResources(filePath);
String rootPath=Thread.currentThread().getContextClassLoader().getResource(filePath).getPath();
System.out.println(rootPath);
if (rootPath!=null){
rootPath=rootPath.substring(rootPath.lastIndexOf(filePath));
}
///C:/Users/user/Desktop/%e5%ad%a6%e4%b9%a0/springmvc/out/production/springmvc/com/czmec/Controller
//获取的是类的真实的物理路径 接下来就是io啦
while (dirs.hasMoreElements()){
URL url=dirs.nextElement();
System.out.println(url);
/**
* /C:/Users/user/Desktop/%e5%ad%a6%e4%b9%a0/springmvc/out/production/springmvc/com/czmec/Controller
file:/C:/Users/user/Desktop/%e5%ad%a6%e4%b9%a0/springmvc/out/production/springmvc/com/czmec/Controller
*/
//根据url 判断是文件还是文件夹
if (url.getProtocol().equals("file")){
File file=new File(url.getPath().substring(1));//因为路径前面多了一个/所有从1开始
//如果是文件夹 就需要递归找下去 找到所有文件
try {
scannerFile(file,rootPath,results);
} catch (ClassNotFoundException e) {
e.printStackTrace();
}

}
}
} catch (IOException e) {
e.printStackTrace();
}

return results;
}

//递归
private  static void scannerFile(File folder,String rootPath,Map<String,Class<?>> classes) throws ClassNotFoundException {
//拿到folder里面的所有文件对象  如果文件夹为空 会返回一个Null
File[] files=folder.listFiles();
for (int i=0;files!=null&&i<files.length;i++){
File file=files[i];
//如果是文件夹就继续进行递归
if (file.isDirectory()){
if (rootPath.substring(rootPath.length()-1).equals("/")){
rootPath=rootPath.substring(0,rootPath.length()-1);
}
scannerFile(file,rootPath+"/"+file.getName()+"/",classes);
}else {
String path=file.getAbsolutePath();//获取真实路径
if (path.endsWith(".class")){
//将路径中的\替换成/
path=path.replace("\\","/");
//获取完整的类路径 比如com.czmec.IndexController
if (!rootPath.substring(rootPath.length()-1).equals("/")){
rootPath+="/";
}
String className=rootPath+path.substring(path.lastIndexOf("/")+1,path.indexOf(".class"));
className=className.replace("/",".");
System.out.println(className);
//吧类路径是实例保存起来
classes.put(className,Class.forName(className));
}
}
}
}

public static void main(String[] args) {
ClassScanner.scannerClass("com.czmec");
}
}

通过上面代码 可以看出在指定的包下 获取包下类的路径 并获取实例 保存在Map中， 吧这些类扫描出来通过反射技术获取注解值，获取控制器类等等

在springmvc中 我们会配置springmvc的核心控制器DispatcherServlet来设置路径权限

DispatcherServlet的生命周期有：init(),service,destory;

下面是生命周期图



通过这个图我们可以了解到DispatcherServlet在运行过程中所起到的作用

配置DispatcherServlet有两种方式 一种是基于xml 一种是基于注解 下面我们来看看基于注解

在DispatcherServlet类中 通过设置@WebServlet来设置拦截路径 @WebInitParam来设置设置的包

在初始化方法中去获取包下面所有的类并且迭代所有类的实例 获取有Controller注解 并通过类加载机制实例化对象

保存在Map中 再获取类中所有加了@RequestMapping注解的方法，和路径保存在methods中  并在service中解析请求路径通过invoke方法

@WebServlet(urlPatterns = {"*.do"},initParams = {@WebInitParam(name = "basePackage",value = "com.czmec")})
public class DispacherServlet extends javax.servlet.http.HttpServlet {
//    protected void doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.servlet.ServletException, IOException {
//
//    }
//
//    protected void doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.servlet.ServletException, IOException {
//
//    }
//存储Controller实例
private Map<String,Object>  controllers=new HashMap<String,Object>();
//被反射调用的method
private Map<String,Method>  methods=new HashMap<String,Method>();
public DispacherServlet(){
super();
}

@Override
public void init(ServletConfig config) throws ServletException {
//获取包名
String basePackage=config.getInitParameter("basePackage");
//扫描
Map<String ,Class<?>> cons= ClassScanner.scannerClass(basePackage);
//迭代
Iterator<String> itro=cons.keySet().iterator();
while (itro.hasNext()){
String className=itro.next();
Class clazz=cons.get(className);
if (clazz.isAnnotationPresent(Controller.class)){
System.out.println(clazz.getName()+",被标记为控制器!");
//吧标记了@Controller注解的类管理起来
String path="";
//判断标记了Controller类上是否存在@RequestMapper
if (clazz.isAnnotationPresent(RequestMapping.class)){
//如果存在 就获取注解上的路径值
RequestMapping reqAnno= (RequestMapping) clazz.getAnnotation(RequestMapping.class);
path=reqAnno.value();
}
try {
controllers.put(className,clazz.newInstance());
} catch (InstantiationException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
//获取类上路径过后 再获取该类的所有公开方法进行遍历 并且判断哪些方法上有@RequestMapping
Method[] ms=clazz.getMethods();
for (Method method:ms){
//如果不存在RequestMapping注解 进入下一轮循环
if(!method.isAnnotationPresent(RequestMapping.class)){
continue;
}
System.out.println("映射对外路径"+path+method.getAnnotation(RequestMapping.class).value());
methods.put(path+method.getAnnotation(RequestMapping.class).value(),method);
}
}
}
}

@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
System.out.println(req.getRequestURI());
///abc.do
String uri=req.getRequestURI();
String contextPath=req.getContextPath();
//获取映射路径
String mappingPath=uri.substring(uri.indexOf(contextPath)+contextPath.length(),uri.indexOf(".do"));
//
Method method=methods.get(mappingPath);
//获取实例对象
Object controller=controllers.get(method.getDeclaringClass().getName());
try {
method.invoke(controller);
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
}

配上tomcat运行
输入地址：http://localhost:8080/czmec/delete.do



通过以上代码的说明 可以了解基本springmvc的运行机制和原理

至此最基本的springmvc就完成了

有哪里错误的地方请指出 

源代码下载地址：https://github.com/dcg123/springmvc