自定義實現SpringMvc框架，自定義@Controller、@RequestMapping註解，自己也是一步一步的對程式碼的理解出來的，只是比較簡單的例子
阿新 • • 發佈：2018-12-09
1.自定義的DispatcherServlet,就是SpringMvc執行載入類
/*** * 手寫SpringMvc框架<br> * 思路：<br> * 1.手動建立一個DispatcherServlet 攔截專案的所有請求 SpringMvc 基於servlet實現<br> * 2.extends HttpHttpServlet 重寫init 方法<br> * #######2.1 判斷掃包路徑下面是否有ExtController註解，並且注入到SpringMvc容器中，存放在springmvcBeans集合當中 * key為 預設類名小寫，value 為物件<br> * #######2.2 將url對映和方法進行關聯 <br> * #######2.3判斷類上是否有ExtRequestMaping註解，使用java反射機制迴圈遍歷的方法，再判斷方法上是否有註解，將url和方法對應的存入urlBeans集合中<br> * 3.處理請求，重寫get，post方法 <br> * #######3.1獲取到請求的url，與初始化得到的方法進行匹配，獲取到例項的物件，urlMethodsBeans呼叫物件獲取方法名稱，使用反射機制進行執行。 * * @author DateLoader * */ public class ExtDispatcherServlet extends HttpServlet { // springmvc 容器物件 key:類名id ,value 物件 private ConcurrentHashMap<String, Object> springmvcBeans = new ConcurrentHashMap<String, Object>(); // springmvc 容器物件 key:請求地址 ,value類 private ConcurrentHashMap<String, Object> urlBeans = new ConcurrentHashMap<String, Object>(); // springmvc 容器物件 key:請求地址 ,value 方法 private ConcurrentHashMap<String, String> urlMethodsBeans = new ConcurrentHashMap<String, String>(); // DispatcherServlet 初始化操作 @Override public void init() throws ServletException { // 1.定義一個掃包的路徑，進行掃包獲取全部的類 List<Class<?>> listClass = ClassUtil.getClasses("com.shty.controller"); // 2.將獲取到的所有類全部注入到Springmvc容器中，並且存放在springmvcBeans集合中 try { findClassMvcAnnotation(listClass); } catch (Exception e) { // TODO Auto-generated catch block e.printStackTrace(); } // 3將url對映和方法進行關聯 handlerMapping(); } // 4.處理請求，重寫get，post方法 @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { // TODO Auto-generated method stub doPost(req, resp); } @Override protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { // TODO Auto-generated method stub // 1.獲取請求的URL String requestURI = req.getRequestURI(); if (StringUtils.isEmpty(requestURI)) { return; } // 2.從urlBeans獲取物件 Object object = urlBeans.get(requestURI); if (object == null) { resp.getWriter().print("not found 404 url"); return; } // 3.使用url地址獲取方法 String urlName = urlMethodsBeans.get(requestURI); if (StringUtils.isEmpty(urlName)) { resp.getWriter().print("not found method"); } // 4.使用反射機制執行方法 String methodInvoke = (String)methodInvoke(object, urlName); //返回資料 resp.getWriter().print(methodInvoke); // 5.如果想呼叫檢視轉換器渲染給頁面展示 //extResourceViewResolver(methodInvoke, req, resp); } // 4.使用反射機制執行方法 public Object methodInvoke(Object object, String urlName) { Class<? extends Object> classInfo = object.getClass(); try { Method method = classInfo.getMethod(urlName); Object result = method.invoke(object); return result; } catch (Exception e) { // TODO Auto-generated catch block e.printStackTrace(); } return null; } 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); } // 2.將獲取到的所有類全部注入到Springmvc容器中，並且存放在springmvcBeans集合中 public void findClassMvcAnnotation(List<Class<?>> listClass) throws InstantiationException, IllegalAccessException { for (Class<?> classInfo : listClass) { // 判斷類上是否有@ExtController註解 ExtController extControllerAnnotation = classInfo.getDeclaredAnnotation(ExtController.class); if (extControllerAnnotation != null) { // 根據ClassUtil 將類名稱首字母轉換為小寫 String simpleName = ClassUtil.toLowerCaseFirstOne(classInfo.getSimpleName()); // 例項化物件，並且存入到springmvcBeans Object newInstance = classInfo.newInstance(); springmvcBeans.put(simpleName, newInstance); } } } // 將url對映和方法進行關聯 public void handlerMapping() { for (Map.Entry<String, Object> springEntry : springmvcBeans.entrySet()) { // 遍歷初始化注入到SpringMvc容器中的類，是否含有url對映註解 Object object = springEntry.getValue(); // 判斷類上是否有 @ExtRequestMaping Class<? extends Object> classInfo = object.getClass(); ExtRequestMapping extRequestMappingAnnotation = classInfo.getDeclaredAnnotation(ExtRequestMapping.class); String baseUrl = ""; if (extRequestMappingAnnotation != null) { // 獲取類上的註解value 值 baseUrl = extRequestMappingAnnotation.value(); } // 獲取類的所有方法，判斷是否有@ExtRequestMaping Method[] declaredMethods = classInfo.getDeclaredMethods(); // 迴圈得到的所有方法，進行判斷 for (Method method : declaredMethods) { ExtRequestMapping declaredAnnotation = method.getDeclaredAnnotation(ExtRequestMapping.class); if (declaredAnnotation != null) { // 如果類上有註解那麼需要和類上的註解進行拼接 String methodurl = baseUrl + declaredAnnotation.value(); // 將獲得的url 存入urlBeans urlBeans.put(methodurl, object); urlMethodsBeans.put(methodurl, method.getName()); } } } }
2.自定義@Controller 註解，來代替SpringMvc的註解
/**
* 自定義Controller註解
* @author DateLoader
*
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtController {
}2.自定義@RequestMapping註解，來代替SpringMvc的註解
/** * 自定義RequestMapping註解 * @author DateLoader * */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface ExtRequestMapping { String value() default ""; }
3.Controller 包下的類，執行方法
@ExtController
@ExtRequestMapping("/req")
public class TestController {
@ExtRequestMapping("/test")
public String test(){
System.out.println("這個是我自己手寫的Springmvc框架");
return "這個是我自己手寫的Springmvc框架";
}
}4.專案中需要用到的幫組類
package com.shty.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(); } }
5.web.xml檔案的填寫方法
<!-- Spring MVC 核心控制器 DispatcherServlet 配置 -->
<servlet>
<servlet-name>dispatcher</servlet-name>
<!-- 這裡填的是自己專案中寫的Springmvc載入類 -->
<servlet-class>com.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>6.pom.xml檔案，需要引用的jar包
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<!-- 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>
<!-- Spring strat -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.0.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.0.0.RELEASE</version>
</dependency>
<!-- Spring end -->
</dependencies>