本文將通過自定義代碼實現SpringMVC中@RequestMapping 和@Controller註解功能,通過該代碼的實現能更好的理解SpringMVC的處理流程和原理。
由於是實現mvc,而且代碼的實現過程中用到了Servlet,下面先複習下兩塊的內容:
1. SpringMVC原理
運行流程如下:
⑴ 用戶發送請求至前端控制器DispatcherServlet
⑵ DispatcherServlet收到請求調用HandlerMapping處理器映射器。
⑶ 處理器映射器根據請求url找到具體的處理器,生成處理器對象及處理器攔截器(如果有則生成)一併返回給DispatcherServlet。
⑷ DispatcherServlet通過HandlerAdapter處理器適配器調用處理器
⑸ 執行處理器(Controller,也叫後端控制器)。
⑹ Controller執行完成返回ModelAndView
⑺ HandlerAdapter將controller執行結果ModelAndView返回給DispatcherServlet
⑻ DispatcherServlet將ModelAndView傳給ViewReslover視圖解析器
⑼ ViewReslover解析後返回具體View
⑽ DispatcherServlet對View進行渲染視圖(即將模型數據填充至視圖中)。
⑾ DispatcherServlet響應用戶。
關於SpringMVC這塊知識具體查看本人所寫的ssm專欄的SpringMVC部分。
2. 回顧Servet知識
2.1 什麼是Servlet
Java Servlet 是運行在 Web 服務器或應用服務器上的程序,它是作爲來自 Web 瀏覽器或其他 HTTP 客戶端的請求和 HTTP 服務器上的數據庫或應用程序之間的中間層。
使用 Servlet,您可以收集來自網頁表單的用戶輸入,呈現來自數據庫或者其他源的記錄,還可以動態創建網頁。
Java Servlet 通常情況下與使用 CGI(Common Gateway Interface,公共網關接口)實現的程序可以達到異曲同工的效果。但是相比於 CGI,Servlet 有以下幾點優勢:
性能明顯更好。
Servlet 在 Web 服務器的地址空間內執行。這樣它就沒有必要再創建一個單獨的進程來處理每個客戶端請求。
Servlet 是獨立於平臺的,因爲它們是用 Java 編寫的。
服務器上的 Java 安全管理器執行了一系列限制,以保護服務器計算機上的資源。因此,Servlet 是可信的。
Java 類庫的全部功能對 Servlet 來說都是可用的。它可以通過 sockets 和 RMI 機制與 applets、數據庫或其他軟件進行交互。
2.2 什麼是Servlet生命週期
Servlet 生命週期:
Servlet 加載—>實例化—>服務—>銷燬。
- 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()方法時,這些線程已經終止或完成。
3. 手寫SpringMVC思路
- web.xml加載
要實現一個web項目,肯定是首先讀取web.xm,爲了讀取web.xml中的配置,我們用到ServletConfig這個類,它代表當前Servlet在web.xml中的配置信息。通過web.xml中加載我們自己寫的MyDispatcherServlet和讀取配置文件。 - 初始化階段
在前面我們提到DispatcherServlet的initStrategies方法會初始化9大組件,但是這裏將實現一些SpringMVC的最基本的組件而不是全部,按順序包括:
• 加載配置文件
• 掃描用戶配置包下面所有的類
• 拿到掃描到的類,通過反射機制,實例化。並且放到ioc容器中(Map的鍵值對 beanName-bean) beanName默認是首字母小寫
• 初始化HandlerMapping,這裏其實就是把url和method對應起來放在一個k-v的Map中,在運行階段取出
3、運行階段
每一次請求將會調用doGet或doPost方法,所以統一運行階段都放在doDispatch方法裏處理,它會根據url請求去HandlerMapping中匹配到對應的Method,然後利用反射機制調用Controller中的url對應的方法,並得到結果返回。按順序包括以下功能:
• 異常的攔截
• 獲取請求傳入的參數並處理參數
• 通過初始化好的handlerMapping中拿出url對應的方法名,反射調用
4. 手寫SpringMVC基本實現
這裏僅需導入servlet的倚賴,和commons包
<!-- 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>
實現SpingMVC的核心就是ExtDispatcherServlet:
/**
* 自定義前端控制器
* 手寫springmvc 原理分析
* 1.創建一個前端控制器()ExtDispatcherServlet 攔截所有請求(springmvc 基於servlet實現)
* 2.初始化操作 重寫servlet init 方法
* ###2.1 將掃包範圍所有的類,注入到springmvc容器裏面,存放在Map集合中 key爲默認類名小寫,value 對象
* ###2.2 將url映射和方法進行關聯
* #####2.2.1 判斷類上是否有註解,使用java反射機制循環遍歷方法 ,判斷方法上是否存在註解,進行封裝url和方法對應存入集合中
* 3.處理請求 重寫Get或者是Post方法
* ###3.1
* 獲取請求url,從urlBeans集合獲取實例對象,獲取成功實例對象後,調用urlMethods集合獲取方法名稱,使用反射機制執行
*/
public class ExtDispatcherServlet extends HttpServlet {
// springmvc 容器對象 key:類名id ,value 對象
private ConcurrentHashMap<String, Object> springmvcBeans = new ConcurrentHashMap<String, Object>();
// springmvc 容器對象 keya:請求地址 ,vlue類
private ConcurrentHashMap<String, Object> urlBeans = new ConcurrentHashMap<String, Object>();
// springmvc 容器對象 key:請求地址 ,value 方法名稱
private ConcurrentHashMap<String, String> urlMethods = new ConcurrentHashMap<String, String>();
@Override
public void init() throws ServletException {
// 1.獲取當前包下的所有的類
List<Class<?>> classes = ClassUtil.getClasses("com.test.controller");
// 2.將掃包範圍所有的類,注入到springmvc容器裏面,存放在Map集合中 key爲默認類名小寫,value 對象
try {
findClassMVCAnnotation(classes);
} catch (Exception e) {
// TODO: handle exception
}
// 3.將url映射和方法進行關聯
handlerMapping();
}
@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.獲取請求url地址
String requestURI = req.getRequestURI();
if (StringUtils.isEmpty(requestURI)) {
return;
}
// 2.從Map集合中獲取控制對象
Object object = urlBeans.get(requestURI);
if (object == null) {
resp.getWriter().println(" not found 404 url");
return;
}
// 3.使用url地址獲取方法
String methodName = urlMethods.get(requestURI);
if (StringUtils.isEmpty(methodName)) {
resp.getWriter().println(" not found method");
}
// 4.使用java的反射機制調用方法
String resultPage = (String) methodInvoke(object, methodName);
// 5.調用視圖轉換器渲染給頁面展示
extResourceViewResolver(resultPage, req, resp);
}
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);
}
private Object methodInvoke(Object object, String methodName) {
try {
Class<? extends Object> classInfo = object.getClass();
Method method = classInfo.getMethod(methodName);
Object result = method.invoke(object);
return result;
} catch (Exception e) {
return null;
}
}
// 2.將掃包範圍所有的類,注入到springmvc容器裏面,存放在Map集合中 key爲默認類名小寫,value 對象
public void findClassMVCAnnotation(List<Class<?>> classes)
throws ClassNotFoundException, InstantiationException, IllegalAccessException {
for (Class<?> classInfo : classes) {
// 判斷類上是否有加上註解
ExtController extController = classInfo.getDeclaredAnnotation(ExtController.class);
if (extController != null) {
// 默認類名是小寫
String beanId = ClassUtil.toLowerCaseFirstOne(classInfo.getSimpleName());
// 實例化對象
Object object = ClassUtil.newInstance(classInfo);
springmvcBeans.put(beanId, object);
}
}
}
// 3.將url映射和方法進行關聯
public void handlerMapping() {
// 1.遍歷springmvc bean容器 判斷類上屬否有url映射註解
for (Map.Entry<String, Object> mvcBean : springmvcBeans.entrySet()) {
// 2.遍歷所有的方法上是否有url映射註解
// 獲取bean的對象
Object object = mvcBean.getValue();
// 3.判斷類上是否有加url映射註解
Class<? extends Object> classInfo = object.getClass();
ExtRequestMapping declaredAnnotation = classInfo.getDeclaredAnnotation(ExtRequestMapping.class);
String baseUrl = "";
if (declaredAnnotation != null) {
// 獲取類上的url映射地址
baseUrl = declaredAnnotation.value();
}
// 4.判斷方法上是否有加url映射地址
Method[] declaredMethods = classInfo.getDeclaredMethods();
for (Method method : declaredMethods) {
// 判斷方法上是否有加url映射註解
ExtRequestMapping methodExtRequestMapping = method.getDeclaredAnnotation(ExtRequestMapping.class);
if (methodExtRequestMapping != null) {
String methodUrl = baseUrl + methodExtRequestMapping.value();
// springmvc 容器對象 keya:請求地址 ,vlue類
urlBeans.put(methodUrl, object);
// springmvc 容器對象 key:請求地址 ,value 方法名稱
urlMethods.put(methodUrl, method.getName());
}
}
}
}
}
其中用到了反射的一個工具類:
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
* @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();
}
}
自定義的註解:
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtController {
}
@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ExtRequestMapping {
String value() default "";
}
定義controller:
@ExtController
@ExtRequestMapping("/ext")
public class ExtIndexController {
@ExtRequestMapping("/test")
public String test() {
System.out.println("手寫springmvc框架...");
return "index";
}
}
配置好servlet:
<web-app>
<!-- Spring MVC 核心控制器 DispatcherServlet 配置 -->
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>com.test.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>
</web-app>
通過tomcat啓動,訪問http://localhost:8080/ext/test,就能訪問到index.jsp頁面