原始碼分析篇之手寫springvc
阿新 • • 發佈：2018-12-06
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.效果
