springmvc 工作原理機原始碼解析
springmvc是一個基於spring的web框架.本篇文章對它的工作原理以及原始碼進行深入分析.
一、springmvc請求處理流程
引用spring in action上的一張圖來說明了springmvc的核心元件和請求處理流程:
①：DispatcherServlet是springmvc中的前端控制器(front controller),負責接收request並將request轉發給對應的處理元件.
②：HanlerMapping是springmvc中完成url到controller對映的元件.DispatcherServlet接收request,然後從HandlerMapping查詢處理request的controller.
③：Cntroller處理request,並返回ModelAndView物件,Controller是springmvc中負責處理request的元件(類似於struts2中的Action),ModelAndView是封裝結果檢視的元件.
④ ⑤ ⑥：檢視解析器解析ModelAndView物件並返回對應的檢視給客戶端.
二、springmvc的工作機制
在容器初始化時會建立所有url和controller的對應關係,儲存到Map<url,controller>中.tomcat啟動時會通知spring初始化容器(載入bean的定義資訊和初始化所有單例bean),然後springmvc會遍歷容器中的bean,獲取每一個controller中的所有方法訪問的url,然後將url和controller儲存到一個Map中;
這樣就可以根據request快速定位到controller,因為最終處理request的是controller中的方法,Map中只保留了url和controller中的對應關係,所以要根據request的url進一步確認controller中的method,這一步工作的原理就是拼接controller的url(controller上@RequestMapping的值)和方法的url(method上@RequestMapping的值),與request的url進行匹配,找到匹配的那個方法;
確定處理請求的method後,接下來的任務就是引數繫結,把request中引數繫結到方法的形式引數上,這一步是整個請求處理過程中最複雜的一個步驟。springmvc提供了兩種request引數與方法形參的繫結方法:
① 通過註解進行繫結,@RequestParam
② 通過引數名稱進行繫結.
使用註解進行繫結,我們只要在方法引數前面宣告@RequestParam("a"),就可以將request中引數a的值繫結到方法的該引數上.使用引數名稱進行繫結的前提是必須要獲取方法中引數的名稱,Java反射只提供了獲取方法的引數的型別,並沒有提供獲取引數名稱的方法.springmvc解決這個問題的方法是用asm框架讀取位元組碼檔案,來獲取方法的引數名稱.asm框架是一個位元組碼操作框架,關於asm更多介紹可以參考它的官網.個人建議,使用註解來完成引數繫結,這樣就可以省去asm框架的讀取位元組碼的操作.
三、原始碼的分析
我們根據工作機制中三部分來分析springmvc的原始碼.
第一步、建立Map<urls,controller>的關係
我們首先看第一個步驟,也就是建立Map<url,controller>關係的部分.第一部分的入口類為ApplicationObjectSupport的setApplicationContext方法.setApplicationContext方法中核心部分就是初始化容器initApplicationContext(context),子類AbstractDetectingUrlHandlerMapping實現了該方法,所以我們直接看子類中的初始化容器方法.
View Code
determineUrlsForHandler(String beanName)方法的作用是獲取每個controller中的url,不同的子類有不同的實現,這是一個典型的模板設計模式.因為開發中我們用的最多的就是用註解來配置controller中的url,DefaultAnnotationHandlerMapping是AbstractDetectingUrlHandlerMapping的子類,處理註解形式的url對映.所以我們這裡以DefaultAnnotationHandlerMapping來進行分析.我們看DefaultAnnotationHandlerMapping是如何查beanName上所有對映的url.
View Code
到這裡HandlerMapping元件就已經建立所有url和controller的對應關係。
第二步、根據訪問url找到對應controller中處理請求的方法.
下面我們開始分析第二個步驟,第二個步驟是由請求觸發的,所以入口為DispatcherServlet.DispatcherServlet的核心方法為doService(),doService()中的核心邏輯由doDispatch()實現,我們檢視doDispatch()的原始碼.
/** 中央控制器,控制請求的轉發 **/
protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
HttpServletRequest processedRequest = request;
HandlerExecutionChain mappedHandler = null;
int interceptorIndex = -1;
try {
ModelAndView mv;
boolean errorView = false;
try {
// 1.檢查是否是檔案上傳的請求
processedRequest = checkMultipart(request);
// 2.取得處理當前請求的controller,這裡也稱為hanlder,處理器,第一個步驟的意義就在這裡體現了.這裡並不是直接返回controller,而是返回的HandlerExecutionChain請求處理器鏈物件,該物件封裝了handler和interceptors.
mappedHandler = getHandler(processedRequest, false);
// 如果handler為空,則返回404
if (mappedHandler == null || mappedHandler.getHandler() == null) {
noHandlerFound(processedRequest, response);
return;
}
//3. 獲取處理request的處理器介面卡handler adapter
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
// 處理 last-modified 請求頭
String method = request.getMethod();
boolean isGet = "GET".equals(method);
if (isGet || "HEAD".equals(method)) {
long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
if (logger.isDebugEnabled()) {
String requestUri = urlPathHelper.getRequestUri(request);
logger.debug("Last-Modified value for [" + requestUri + "] is: " + lastModified);
}
if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
return;
}
}
// 4.攔截器的預處理方法
HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();
if (interceptors != null) {
for (int i = 0; i < interceptors.length; i++) {
HandlerInterceptor interceptor = interceptors[i];
if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) {
triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
return;
}
interceptorIndex = i;
}
}
// 5.實際的處理器處理請求,返回結果檢視物件
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
// 結果檢視物件的處理
if (mv != null && !mv.hasView()) {
mv.setViewName(getDefaultViewName(request));
}
// 6.攔截器的後處理方法
if (interceptors != null) {
for (int i = interceptors.length - 1; i >= 0; i--) {
HandlerInterceptor interceptor = interceptors[i];
interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);
}
}
}
catch (ModelAndViewDefiningException ex) {
logger.debug("ModelAndViewDefiningException encountered", ex);
mv = ex.getModelAndView();
}
catch (Exception ex) {
Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
mv = processHandlerException(processedRequest, response, handler, ex);
errorView = (mv != null);
}
if (mv != null && !mv.wasCleared()) {
render(mv, processedRequest, response);
if (errorView) {
WebUtils.clearErrorRequestAttributes(request);
}
}
else {
if (logger.isDebugEnabled()) {
logger.debug("Null ModelAndView returned to DispatcherServlet with name '" + getServletName() +
"': assuming HandlerAdapter completed request handling");
}
}
// 請求成功響應之後的方法
triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
}
第2步:getHandler(processedRequest)方法實際上就是從HandlerMapping中找到url和controller的對應關係.這也就是第一個步驟:建立Map<url,Controller>的意義.我們知道,最終處理request的是controller中的方法,我們現在只是知道了controller,還要進一步確認controller中處理request的方法.由於下面的步驟和第三個步驟關係更加緊密,直接轉到第三個步驟.
第三步、反射呼叫處理請求的方法,返回結果檢視
上面的方法中,第2步其實就是從第一個步驟中的Map<urls,beanName>中取得controller,然後經過攔截器的預處理方法,到最核心的部分--第5步呼叫controller的方法處理請求.在第2步中我們可以知道處理request的controller,第5步就是要根據url確定controller中處理請求的方法,然後通過反射獲取該方法上的註解和引數,解析方法和引數上的註解,最後反射呼叫方法獲取ModelAndView結果檢視。因為上面採用註解url形式說明的,所以我們這裡繼續以註解處理器介面卡來說明.第5步呼叫的就是AnnotationMethodHandlerAdapter的handle().handle()中的核心邏輯由invokeHandlerMethod(request, response, handler)實現。
/** 獲取處理請求的方法,執行並返回結果檢視 **/
protected ModelAndView invokeHandlerMethod(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
// 1.獲取方法解析器
ServletHandlerMethodResolver methodResolver = getMethodResolver(handler);
// 2.解析request中的url,獲取處理request的方法
Method handlerMethod = methodResolver.resolveHandlerMethod(request);
// 3.方法呼叫器
ServletHandlerMethodInvoker methodInvoker = new ServletHandlerMethodInvoker(methodResolver);
ServletWebRequest webRequest = new ServletWebRequest(request, response);
ExtendedModelMap implicitModel = new BindingAwareModelMap();
// 4.執行方法
Object result = methodInvoker.invokeHandlerMethod(handlerMethod, handler, webRequest, implicitModel);
// 5.封裝結果檢視
ModelAndView mav =
methodInvoker.getModelAndView(handlerMethod, handler.getClass(), result, implicitModel, webRequest);
methodInvoker.updateModelAttributes(handler, (mav != null ? mav.getModel() : null), implicitModel, webRequest);
return mav;
}
這一部分的核心就在2和4了.先看第2步,通過request找controller的處理方法.實際上就是拼接controller的url和方法的url,與request的url進行匹配,找到匹配的方法.
/** 根據url獲取處理請求的方法 **/
public Method resolveHandlerMethod(HttpServletRequest request) throws ServletException {
// 如果請求url為,localhost:8080/springmvc/helloWorldController/say.action, 則lookupPath=helloWorldController/say.action
String lookupPath = urlPathHelper.getLookupPathForRequest(request);
Comparator<String> pathComparator = pathMatcher.getPatternComparator(lookupPath);
Map<RequestSpecificMappingInfo, Method> targetHandlerMethods = new LinkedHashMap<RequestSpecificMappingInfo, Method>();
Set<String> allowedMethods = new LinkedHashSet<String>(7);
String resolvedMethodName = null;
// 遍歷controller上的所有方法,獲取url匹配的方法
for (Method handlerMethod : getHandlerMethods()) {
RequestSpecificMappingInfo mappingInfo = new RequestSpecificMappingInfo(this.mappings.get(handlerMethod));
boolean match = false;
if (mappingInfo.hasPatterns()) {// 獲取方法上的url
for (String pattern : mappingInfo.getPatterns()) { // 方法上可能有多個url,springmvc支援方法對映多個url
if (!hasTypeLevelMapping() && !pattern.startsWith("/")) {
pattern = "/" + pattern;
}
// 獲取controller上的對映和url和方法上的url,拼湊起來與lookupPath是否匹配
String combinedPattern = getCombinedPattern(pattern, lookupPath, request);
if (combinedPattern != null) {
if (mappingInfo.matches(request)) {
match = true;
mappingInfo.addMatchedPattern(combinedPattern);
}
else {
if (!mappingInfo.matchesRequestMethod(request)) {
allowedMethods.addAll(mappingInfo.methodNames());
}
break;
}
}
}
mappingInfo.sortMatchedPatterns(pathComparator);
}
else if (useTypeLevelMapping(request)) {
// other
}
通過上面的程式碼,已經可以找到處理request的controller中的方法了,現在看如何解析該方法上的引數,並呼叫該方法。也就是執行方法這一步.執行方法這一步最重要的就是獲取方法的引數,然後我們就可以反射呼叫方法了.
public final Object invokeHandlerMethod(Method handlerMethod, Object handler,
NativeWebRequest webRequest, ExtendedModelMap implicitModel) throws Exception {
Method handlerMethodToInvoke = BridgeMethodResolver.findBridgedMethod(handlerMethod);
try {
boolean debug = logger.isDebugEnabled();
// 處理方法上的其他註解
for (String attrName : this.methodResolver.getActualSessionAttributeNames()) {
Object attrValue = this.sessionAttributeStore.retrieveAttribute(webRequest, attrName);
if (attrValue != null) {
implicitModel.addAttribute(attrName, attrValue);
}
}
for (Method attributeMethod : this.methodResolver.getModelAttributeMethods()) {
Method attributeMethodToInvoke = BridgeMethodResolver.findBridgedMethod(attributeMethod);
Object[] args = resolveHandlerArguments(attributeMethodToInvoke, handler, webRequest, implicitModel);
if (debug) {
logger.debug("Invoking model attribute method: " + attributeMethodToInvoke);
}
String attrName = AnnotationUtils.findAnnotation(attributeMethod, ModelAttribute.class).value();
if (!"".equals(attrName) && implicitModel.containsAttribute(attrName)) {
continue;
}
ReflectionUtils.makeAccessible(attributeMethodToInvoke);
Object attrValue = attributeMethodToInvoke.invoke(handler, args);
if ("".equals(attrName)) {
Class resolvedType = GenericTypeResolver.resolveReturnType(attributeMethodToInvoke, handler.getClass());
attrName = Conventions.getVariableNameForReturnType(attributeMethodToInvoke, resolvedType, attrValue);
}
if (!implicitModel.containsAttribute(attrName)) {
implicitModel.addAttribute(attrName, attrValue);
}
}
// 核心程式碼,獲取方法上的引數值
Object[] args = resolveHandlerArguments(handlerMethodToInvoke, handler, webRequest, implicitModel);
if (debug) {
logger.debug("Invoking request handler method: " + handlerMethodToInvoke);
}
ReflectionUtils.makeAccessible(handlerMethodToInvoke);
return handlerMethodToInvoke.invoke(handler, args);
}
resolveHandlerArguments方法實現程式碼比較長,它最終要實現的目的就是:完成request中的引數和方法引數上資料的繫結.
springmvc中提供兩種request引數到方法中引數的繫結方式:
① 通過註解進行繫結,@RequestParam
② 通過引數名稱進行繫結.
使用註解進行繫結,我們只要在方法引數前面宣告@RequestParam("a"),就可以將request中引數a的值繫結到方法的該引數上.使用引數名稱進行繫結的前提是必須要獲取方法中引數的名稱,Java反射只提供了獲取方法的引數的型別,並沒有提供獲取引數名稱的方法.springmvc解決這個問題的方法是用asm框架讀取位元組碼檔案,來獲取方法的引數名稱.asm框架是一個位元組碼操作框架,關於asm更多介紹可以參考它的官網.個人建議,使用註解來完成引數繫結,這樣就可以省去asm框架的讀取位元組碼的操作.
View Code
關於asm框架獲取方法引數的部分,這裡就不再進行分析了.感興趣的話F3進去就能看到這個過程.
到這裡,方法的引數值列表也獲取到了,就可以直接進行方法的呼叫了.整個請求過程中最複雜的一步就是在這裡了.ok,到這裡整個請求處理過程的關鍵步驟都分析完了.理解了springmvc中的請求處理流程,整個程式碼還是比較清晰的.
四、談談springmvc的優化
上面我們已經對springmvc的工作原理和原始碼進行了分析,在這個過程發現了幾個優化點:
1.controller如果能保持單例,儘量使用單例,這樣可以減少建立物件和回收物件的開銷.也就是說,如果controller的類變數和例項變數可以以方法形參宣告的儘量以方法的形參宣告,不要以類變數和例項變數宣告,這樣可以避免執行緒安全問題.
2.處理request的方法中的形參務必加上@RequestParam註解,這樣可以避免springmvc使用asm框架讀取class檔案獲取方法引數名的過程.即便springmvc對讀取出的方法引數名進行了快取,如果不要讀取class檔案當然是更加好.
3.閱讀原始碼的過程中,發現springmvc並沒有對處理url的方法進行快取,也就是說每次都要根據請求url去匹配controller中的方法url,如果把url和method的關係快取起來,會不會帶來效能上的提升呢?有點噁心的是,負責解析url和method對應關係的ServletHandlerMethodResolver是一個private的內部類,不能直接繼承該類增強程式碼,必須要該程式碼後重新編譯.當然,如果快取起來,必須要考慮快取的執行緒安全問題.