由於最近太忙，作爲一名程序員，整整6天沒寫一行代碼，天天瞎扎騰網絡和服務器的事，好在端午前終於把由於網絡和服務器問題導致的集羣問題解決了。終於抽出一點時間來寫文章啦。
在上篇文章中SpringIOC原理、源碼解析我們介紹實現了自己的SpringIOC，將我們要使用的對象，通過我們編寫的註解，提前創建好，放到spring容器中，在本次的MVC中，其實也是這麼個原理。如果不熟悉的可以看看上面這篇文章。
1、SpringMVC的使用
首先來回憶一下，我們使用SpringMVC的時候。在springMVC項目或者SpringBoot項目中請求如下的hutao這個方法
http:[ip:端口]/xxxxx/demo/hutao
我們是如何找到這個控制器類的嗯？當然是通過DomeController 上面的@RequestMapping中的demo。那我們又是如何找到是hutao這個方法的呢？當然也是通過@RequestMapping中的hutao。
@Controller
@RequestMapping("/demo")
public class DomeController {
@RequestMapping("/hutao")
public String hutao() {
return "hutaohutaohutaohutaohutao";
}
}
我們通過@Controller註解來標識這個類是一個請求接入控制器類，在結合@RequestMapping註解來識別我們調用的是控制器的哪一個方法。在這個主流程中最核心的類是由DispatcherServlet來實現的。本文就開始來用我們的方式來實現DispatcherServlet吧。
2、SpringMVC原理圖
先上一張SpringMVC的原理示意圖。
如果我們現在要實現自己的MVC，參考上圖，我們需要梳理如下流程。
1、編寫DispatcherServlet實現Servlet攔截所有的請求接入；
2、DispatcherServlet根據請求地址中的RequestMapping映射參數，找到對象，對象在調用對應的方法；
3、DispatcherServlet把控制器類處理結果返回給調用方。
3、預備知識Servlet
Servlet 是運行在 Web 服務器或應用服務器上的程序，它是作爲來自 Web 瀏覽器或其他 HTTP 客戶端的請求和 HTTP 服務器上的數據庫或應用程序之間的中間層。
Servlet 的生命週期：加載—>初始化—>服務—>銷燬。
加載：在web.xml中配置加載
init（）
在Servlet的生命週期中，僅執行一次init()方法。它是在服務器裝入Servlet時執行的，負責初始化Servlet對象。可以配置服務器，以在啓動服務器或客戶機首次訪問Servlet時裝入Servlet。無論有多少客戶機訪問Servlet，都不會重複執行init（）。
service（）
它是Servlet的核心，負責響應客戶的請求。每當一個客戶請求一個HttpServlet對象，該對象的Service()方法就要調用，而且傳遞給這個方法一個“請求”（ServletRequest）對象和一個“響應”（ServletResponse）對象作爲參數。在HttpServlet中已存在Service()方法。默認的服務功能是調用與HTTP請求的方法相應的do功能。
destroy（）
僅執行一次，在服務器端停止且卸載Servlet時執行該方法。當Servlet對象退出生命週期時，負責釋放佔用的資源。一個Servlet在運行service()方法時可能會產生其他的線程，因此需要確認在調用destroy()方法時，這些線程已經終止或完成。
加載，並且初始化，只會被執行一次，之後根據請求方式的不同，service決定調用doPost還是doGet。
protected void service(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
String method = req.getMethod();
if (method.equals(METHOD_GET)) {
long lastModified = getLastModified(req);
if (lastModified == -1) {
// servlet doesn't support if-modified-since, no reason
// to go through further expensive logic
doGet(req, resp);
} else {
long ifModifiedSince;
try {
ifModifiedSince = req.getDateHeader(HEADER_IFMODSINCE);
} catch (IllegalArgumentException iae) {
// Invalid date header - proceed as if none was set
ifModifiedSince = -1;
}
if (ifModifiedSince < (lastModified / 1000 * 1000)) {
// If the servlet mod time is later, call doGet()
// Round down to the nearest second for a proper compare
// A ifModifiedSince of -1 will always be less
maybeSetLastModified(resp, lastModified);
doGet(req, resp);
} else {
resp.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
}
}
} else if (method.equals(METHOD_HEAD)) {
long lastModified = getLastModified(req);
maybeSetLastModified(resp, lastModified);
doHead(req, resp);
} else if (method.equals(METHOD_POST)) {
doPost(req, resp);
} else if (method.equals(METHOD_PUT)) {
doPut(req, resp);
} else if (method.equals(METHOD_DELETE)) {
doDelete(req, resp);
} else if (method.equals(METHOD_OPTIONS)) {
doOptions(req,resp);
} else if (method.equals(METHOD_TRACE)) {
doTrace(req,resp);
} else {
//
// Note that this means NO servlet supports whatever
// method was requested, anywhere on this server.
//
String errMsg = lStrings.getString("http.method_not_implemented");
Object[] errArgs = new Object[1];
errArgs[0] = method;
errMsg = MessageFormat.format(errMsg, errArgs);
resp.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED, errMsg);
}
}
4、實現SpringMVC三部曲
按照階段我們可以把實現分爲三部分：加載，初始化，運行
4.1加載期
web項目在啓動的時候，回去讀取web.xml，因此要在項目啓動的時候去加載我們所編寫的DispatcherServlet。
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>com.sunwise.alm.spring.container.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>/alm/*</url-pattern>
</servlet-mapping>
4.2初始化
加載DispatcherServlet的時候，重寫srvlet的init()方法，這個方法需要去掃描指定路徑下的class文件，找到含有Controller註解的類型，並且創建Controller類，放到SpringMVC容器中，這裏我們使用Map來實現容器。
/**
* 存放被@Controller修飾的類所創建的Controller對象
*/
private ConcurrentHashMap<String, Object> springmvcBeans = new ConcurrentHashMap<String, Object>();
將調用的請求地址，和我們要具體調用的方法形成映射關係，即通過調用地址來確定我們要調用的是那一個方法，這裏我們也是用Map來實現容器。
/**
* url請求地址,value爲對應方法
*/
private ConcurrentHashMap<String, Object> urlBeans = new ConcurrentHashMap<String, Object>();
根據調用的請求地址，找到我們要調用的是我們所創建的哪一個對象，這裏我們同樣用Map來實現容器
/**
* key爲url請求地址,value爲對應實例對象
*/
private ConcurrentHashMap<String, String> urlMethods = new ConcurrentHashMap<String, String>();
4.3、運行期
當別人通過http請求的時候，我們的XML下配置了攔截的地址，因此會攔截我們所配置的的所有請求，然後根據請求地址，找到我們所要調用的對象，調用的方法。調用完畢後，返回結果給調用方。
/**
* 從請求地址中，找到需要調用的是哪一個對象
*/
Object object = urlBeans.get(controllerUrl);
/**
* 從請求地址中，找到需要調用的是哪一個方法
*/
String methodName = urlMethods.get(controllerUrl);
/**
* 調用這個對象的這個方法
*/
String result = (String) methodInvoke(object, methodName,req,resp);
4.4、手寫實現原理圖
4.5、代碼實現
4.5.1、代碼結構
4.5.1、Controller註解
/**
* @Description Controller註解
* @author hutao
* @mail [email protected]
* @date 2020年6月27日
*/
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface Controller {
}
4.5.2、RequestMapping 註解
/**
* @Description RequestMapping註解
* @author hutao
* @mail [email protected]
* @date 2020年6月27日
*/
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestMapping {
String value() default "";
}
4.5.3、DispatcherServlet
/**
* @Description DispatcherServlet實現MVC
* @author hutao
* @mail [email protected]
* @date 2020年6月27日
*/
public class DispatcherServlet extends HttpServlet {
private static Logger logger = LoggerFactory.getLogger(DispatcherServlet.class);
/**@Description
* @author hutao
* @date 2019年10月22日
*/
private static final long serialVersionUID = 1L;
/**
* 存放被@Controller修飾的類所創建的Controller對象
*/
private ConcurrentHashMap<String, Object> springmvcBeans = new ConcurrentHashMap<String, Object>();
/**
* key爲url請求地址,value爲對應方法
*/
private ConcurrentHashMap<String, Object> urlBeans = new ConcurrentHashMap<String, Object>();
/**
* key爲url請求地址,value爲對應實例對象
*/
private ConcurrentHashMap<String, String> urlMethods = new ConcurrentHashMap<String, String>();
/**
* @Description DispatcherServlet加載初始化
* @author hutao
* @mail [email protected]
* @date 2020年6月27日
*/
public void init() throws ServletException {
// 1.獲取當前包下的所有的類
List<Class<?>> classes = ClassUtil.getClasses("com.sunwise.alm.spring");
// 2.將掃包範圍所有的類,注入到springmvc容器裏面，存放在Map集合中 key爲默認類名小寫，value 對象
try {
findClassMVCAnnotation(classes);
} catch (Exception e) {
// TODO: handle exception
}
// 3.將url映射和方法進行關聯
handlerMapping();
}
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doPost(req, resp);
}
//http://localhost/polarion/aem/dispatcher/demo/test
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
resp.setCharacterEncoding("utf-8");
resp.setContentType("text/html; charset=utf-8");
PrintWriter writer = resp.getWriter();
String requestURI = req.getRequestURI();
String controllerUrl = "";
if(requestURI!=null) {
controllerUrl = requestURI.replace("/polarion/sunwise/alm", "");
}
if (controllerUrl == null || "".equals(controllerUrl)) {
return;
}
/**
* 從請求地址中，找到需要調用的是哪一個對象
*/
Object object = urlBeans.get(controllerUrl);
if (object == null) {
resp.getWriter().println(" 404 ");
return;
}
/**
* 從請求地址中，找到需要調用的是哪一個方法
*/
String methodName = urlMethods.get(controllerUrl);
if (methodName == null || "".equals(methodName)) {
resp.getWriter().println(" not found method 404");
}
/**
* 調用這個對象的這個方法
*/
String result = (String) methodInvoke(object, methodName,req,resp);
writer.print(result);
writer.close();
}
/**
* @Description DispatcherServlet實現MVC
* @author hutao
* @mail [email protected]
* @date 2020年6月27日
*/
private Object methodInvoke(Object object, String methodName,HttpServletRequest req, HttpServletResponse resp) {
try {
Class<? extends Object> classInfo = object.getClass();
Method[] methods = classInfo.getMethods();
Method method = null;
for(Method me : methods) {
if(me.getName().equals(methodName)) {
method = me;
break;
}
}
Object result = method.invoke(object);
//Object result = method.invoke(object,req, resp);
return result;
} catch (Exception e) {
e.printStackTrace();
return null;
}
}
/**
* @Description 找到含有Controller修飾的類，並且創建對象放到springmvcBeans容器中
* @author hutao
* @mail [email protected]
* @date 2020年6月27日
*/
public void findClassMVCAnnotation(List<Class<?>> classes)
throws ClassNotFoundException, InstantiationException, IllegalAccessException {
for (Class<?> classInfo : classes) {
Controller extController = classInfo.getDeclaredAnnotation(Controller.class);
if (extController != null) {
String beanId = ClassUtil.toLowerCaseFirstOne(classInfo.getSimpleName());
Object object = ClassUtil.newInstance(classInfo);
springmvcBeans.put(beanId, object);
}
}
}
/**
* @Description 映射綁定，根據請求地址確定請求調用的對象和方法
* @author hutao
* @mail [email protected]
* @date 2020年6月27日
*/
public void handlerMapping() {
for (Map.Entry<String, Object> mvcBean : springmvcBeans.entrySet()) {
Object object = mvcBean.getValue();
Class<? extends Object> classInfo = object.getClass();
RequestMapping declaredAnnotation = classInfo.getDeclaredAnnotation(RequestMapping.class);
String baseUrl = "";
if (declaredAnnotation != null) {
baseUrl = declaredAnnotation.value();
}
Method[] declaredMethods = classInfo.getDeclaredMethods();
for (Method method : declaredMethods) {
RequestMapping methodExtRequestMapping = method.getDeclaredAnnotation(RequestMapping.class);
if (methodExtRequestMapping != null) {
String methodUrl = baseUrl + methodExtRequestMapping.value();
urlBeans.put(methodUrl, object);
urlMethods.put(methodUrl, method.getName());
}
}
}
}
}
4.5.4、ClassUtil 工具類
public class ClassUtil {
/**
* @Description 根據文件名獲取class文件
* @author hutao
* @date 2019年10月25日
*/
public static List<Class<?>> getClasses(List<String> list) {
// 第一個class類的集合
List<Class<?>> classes = new ArrayList<Class<?>>();
try {
for(String controllerName : list) {
Class<?> controllerClass = Class.forName(controllerName);
classes.add(controllerClass);
}
} catch (Exception e) {
e.printStackTrace();
}
return classes;
}
/**
* @Description 首字母變小寫
* @author hutao
* @date 2019年10月25日
*/
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();
}
/**
* @Description 初始化對象
* @author hutao
* @date 2019年10月25日
*/
public static Object newInstance(Class<?> classInfo)
throws ClassNotFoundException, InstantiationException, IllegalAccessException {
return classInfo.newInstance();
}
/**
* @Description 根據包名獲取包路徑下的class
* @author hutao
* @date 2019年10月27日
*/
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 {
//String property = System.getProperty("catalina.home");
dirs = DispatcherServlet.class.getClassLoader().getResources(packageDirName);
//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 ("bundleresource".equals(protocol)) {
//針對我的特定項目實現的一種方式，正常的項目採用file協議
Enumeration<URL> resources = Thread.currentThread().getContextClassLoader().getResources("");
URL nextElement = resources.nextElement();
String file = nextElement.getFile();
String substring = file.substring(0,file.lastIndexOf(packageName)).replace("file:", "")+packageName+"/bin/"+packageName.replace(".", "/");
// 以文件的方式掃描整個包下的文件 並添加到集合中
findAndAddClassesInPackageByFile(packageName,substring, 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);//file:/D:/workSpace/casco/com.sunwise.alm.spring/
///D:/workSpace/casco/com.sunwise.alm.spring/bin/com/sunwise/alm/spring/springIOC/service/impl
// 如果不存在或者 也不是目錄就直接返回
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();
}
}
}
}
}
4.5.5、實現效果
