Spring的模型-視圖-控制器(MVC)框架是圍繞一個DispatcherServlet來設(shè)計的拄丰,這個Servlet會把請求分發(fā)給各個處理器,并支持可配置的處理器映射谚殊、視圖渲染戈鲁、本地化仇参、時區(qū)與主題渲染等,甚至還能支持文件上傳婆殿。
(1) Http請求:客戶端請求提交到DispatcherServlet诈乒。
(2) 尋找處理器:由DispatcherServlet控制器查詢一個或多個HandlerMapping,找到處理請求的Controller婆芦。
(3) 調(diào)用處理器:DispatcherServlet將請求提交到Controller抓谴。
(4)(5)調(diào)用業(yè)務(wù)處理和返回結(jié)果:Controller調(diào)用業(yè)務(wù)邏輯處理后,返回ModelAndView寞缝。
(6)(7)處理視圖映射并返回模型: DispatcherServlet查詢一個或多個ViewResoler視圖解析器癌压,找到ModelAndView指定的視圖。
(8) Http響應(yīng):視圖負(fù)責(zé)將結(jié)果顯示到客戶端荆陆。
主要注解
ContextLoaderListener
在講ContextLoaderListener之前滩届,首先來了解一下web.xml的作用。
一個web中可以沒有web.xml文件被啼,也就是說帜消,web.xml文件并不是web工程必須的。web.xml文件是用來初始化配置信息:比如Welcome頁面浓体、servlet泡挺、servlet-mapping、filter命浴、listener娄猫、啟動加載級別等。當(dāng)你的web工程沒用到這些時生闲,你可以不用web.xml文件來配置你的Application媳溺。
當(dāng)要啟動某個web項目時,服務(wù)器軟件或容器如(tomcat)會第一步加載項目中的web.xml文件碍讯,通過其中的各種配置來啟動項目悬蔽,只有其中配置的各項均無誤時,項目才能正確啟動捉兴。web.xml有多項標(biāo)簽蝎困,在其加載的過程中順序依次為:context-param >> listener >> fileter >> servlet?。(同類多個節(jié)點以出現(xiàn)順序依次加載)
而spring mvc啟動過程大致分為兩個過程:
ContextLoaderListener初始化倍啥,實例化IoC容器禾乘,并將此容器實例注冊到ServletContext中。
DispatcherServlet初始化逗栽。
其中ContextLoaderListener監(jiān)聽器它實現(xiàn)了ServletContextListener這個接口盖袭,在web.xml配置這個監(jiān)聽器,啟動容器時,就會默認(rèn)執(zhí)行它實現(xiàn)的方法鳄虱。在ContextLoaderListener中關(guān)聯(lián)了ContextLoader這個類弟塞,所以整個加載配置過程由ContextLoader來完成。
ContextLoaderListener在web.xml中的配置
<context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/applicationContext.xml</param-value></context-param><listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class></listener>
ServletContextListener 接口有兩個方法:contextInitialized,contextDestroyed
DispatcherServlet
Spring MVC框架拙已,與其他很多web的MVC框架一樣:請求驅(qū)動决记;所有設(shè)計都圍繞著一個中央Servlet來展開,它負(fù)責(zé)把所有請求分發(fā)到控制器倍踪;同時提供其他web應(yīng)用開發(fā)所需要的功能系宫。不過Spring的中央處理器,DispatcherServlet建车,能做的比這更多扩借。
下圖展示了Spring Web MVC的DispatcherServlet處理請求的工作流。熟悉設(shè)計模式的朋友會發(fā)現(xiàn)缤至,DispatcherServlet應(yīng)用的其實就是一個“前端控制器”的設(shè)計模式(其他很多優(yōu)秀的web框架也都使用了這個設(shè)計模式)潮罪。
流程圖
在web.xml中的配置
<servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <load-on-startup>1</load-on-startup></servlet><servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/</url-pattern></servlet-mapping>
其中
load-on-startup:表示啟動容器時初始化該Servlet;
url-pattern:表示哪些請求交給Spring Web MVC處理领斥, “/” 是用來定義默認(rèn)servlet映射的嫉到。也可以如“*.html”表示攔截所有以html為擴(kuò)展名的請求。
在Spring MVC中月洛,每個DispatcherServlet都持有一個自己的上下文對象WebApplicationContext何恶,它又繼承了根(root)WebApplicationContext對象中已經(jīng)定義的所有bean。這些繼承的bean可以在具體的Servlet實例中被重載嚼黔,在每個Servlet實例中你也可以定義其scope下的新bean细层。
WebApplicationContext繼承自ApplicationContext,它提供了一些web應(yīng)用經(jīng)常需要用到的特性隔崎。它與普通的ApplicationContext不同的地方在于今艺,它支持主題的解析韵丑,并且知道它關(guān)聯(lián)到的是哪個servlet(它持有一個該ServletContext的引用)
spring mvc同時提供了很多特殊的注解爵卒,用于處理請求和渲染視圖等。DispatcherServlet初始化的過程中會默認(rèn)使用這些特殊bean進(jìn)行配置撵彻。如果你想指定使用哪個特定的bean钓株,你可以在web應(yīng)用上下文WebApplicationContext中簡單地配置它們。
[圖片上傳中陌僵。轴合。。(7)]
其中碗短,常用的ViewResolver的配置受葛。以jsp作為視圖為例
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/jsp/" /> <property name="suffix" value=".jsp" /></bean>
配置上傳文件限制MultipartResolver
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"> <property name="maxUploadSize" value="32505856"/></bean>
applicationContext.xml中的標(biāo)簽
文件上傳
前面說到DispatcherServlet中有個特殊的Bean叫MultipartResolver,可用于限制文件的上傳大小等。當(dāng)解析器MultipartResolver完成處理時总滩,請求便會像其他請求一樣被正常流程處理纲堵。
表單
<form method="post" action="/form" enctype="multipart/form-data"> <input type="text" name="name"/> <input type="file" name="file"/> <input type="submit"/></form>
控制器
@RequestMapping(path = "/form", method = RequestMethod.POST) public String handleFormUpload(@RequestParam("name") String name, @RequestParam("file") MultipartFile file) { if (!file.isEmpty()) { byte[] bytes = file.getBytes(); // store the bytes somewhere return "redirect:uploadSuccess"; } return "redirect:uploadFailure";}
異常處理
先來說下常見的異常處理有幾種方式,如下圖:
Spring的處理器異常解析器HandlerExceptionResolver接口的實現(xiàn)負(fù)責(zé)處理各類控制器執(zhí)行過程中出現(xiàn)的異常闰渔。也是上面提到的席函,是DispatcherServlet中的特殊bean,可以自定義配置處理冈涧。
某種程度上講茂附,HandlerExceptionResolver與你在web應(yīng)用描述符web.xml文件中能定義的異常映射(exception mapping)很相像,不過它比后者提供了更靈活的方式督弓。比如它能提供異常被拋出時正在執(zhí)行的是哪個處理器這樣的信息营曼。
HandlerExceptionResolver 提供resolveException接口
public interface HandlerExceptionResolver { ModelAndView resolveException( HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex); }
在BaseController中使用 @ExceptionHandler注解處理異常
@ExceptionHandler(Exception.class) public Object exceptionHandler(Exception ex, HttpServletResponse response, HttpServletRequest request) throws IOException { String url = ""; String msg = ex.getMessage(); Object resultModel = null; try { if (ex.getClass() == HttpRequestMethodNotSupportedException.class) { url = "admin/common/500"; System.out.println("--------毛有找到對應(yīng)方法---------"); } else if (ex.getClass() == ParameterException.class) {//自定義的異常 } else if (ex.getClass() == UnauthorizedException.class) { url = "admin/common/unauth"; System.out.println("--------毛有權(quán)限---------"); } String header = req.getHeader("X-Requested-With"); boolean isAjax = "XMLHttpRequest".equalsIgnoreCase(header); String method = req.getMethod(); boolean isPost = "POST".equalsIgnoreCase(method); if (isAjax || isPost) { return Message.error(msg); } else { ModelAndView view = new ModelAndView(url); view.addObject("error", msg); view.addObject("class", ex.getClass()); view.addObject("method", request.getRequestURI()); return view; } } catch (Exception exception) { logger.error(exception.getMessage(), exception); return resultModel; } finally { logger.error(msg, ex); ex.printStackTrace(); } }
在web.xml中處理異常
<error-page> <error-code>403</error-code> <location>/403.html</location></error-page><error-page> <error-code>404</error-code> <location>/404.html</location></error-page><error-page> <error-code>500</error-code> <location>/500.html</location> </error-page> <error-page> <exception-type>java.lang.Exception</exception-type> <location>/500.jsp</location> </error-page> <error-page> <exception-type>java.lang.Throwable</exception-type> <location>/500.jsp</location> </error-page>
來一個問題:HandlerExceptionResolver和web.xml中配置的error-page會有沖突嗎?
解答:如果resolveException返回了ModelAndView愚隧,會優(yōu)先根據(jù)返回值中的頁面來顯示溶推。不過,resolveException可以返回null奸攻,此時則展示web.xml中的error-page的500狀態(tài)碼配置的頁面蒜危。 當(dāng)web.xml中有相應(yīng)的error-page配置,則可以在實現(xiàn)resolveException方法時返回null睹耐。 API文檔中對返回值的解釋: return a corresponding ModelAndView to forward to, or null for default processing.
Spring的模型-視圖-控制器(MVC)框架是圍繞一個DispatcherServlet來設(shè)計的辐赞,這個Servlet會把請求分發(fā)給各個處理器,并支持可配置的處理器映射硝训、視圖渲染响委、本地化、時區(qū)與主題渲染等窖梁,甚至還能支持文件上傳赘风。
(1) Http請求:客戶端請求提交到DispatcherServlet。
(2) 尋找處理器:由DispatcherServlet控制器查詢一個或多個HandlerMapping纵刘,找到處理請求的Controller邀窃。
(3) 調(diào)用處理器:DispatcherServlet將請求提交到Controller。
(4)(5)調(diào)用業(yè)務(wù)處理和返回結(jié)果:Controller調(diào)用業(yè)務(wù)邏輯處理后假哎,返回ModelAndView瞬捕。
(6)(7)處理視圖映射并返回模型: DispatcherServlet查詢一個或多個ViewResoler視圖解析器,找到ModelAndView指定的視圖舵抹。
(8) Http響應(yīng):視圖負(fù)責(zé)將結(jié)果顯示到客戶端肪虎。
主要注解
ContextLoaderListener
在講ContextLoaderListener之前,首先來了解一下web.xml的作用惧蛹。
一個web中可以沒有web.xml文件扇救,也就是說刑枝,web.xml文件并不是web工程必須的。web.xml文件是用來初始化配置信息:比如Welcome頁面迅腔、servlet仅讽、servlet-mapping、filter钾挟、listener洁灵、啟動加載級別等。當(dāng)你的web工程沒用到這些時掺出,你可以不用web.xml文件來配置你的Application徽千。
當(dāng)要啟動某個web項目時,服務(wù)器軟件或容器如(tomcat)會第一步加載項目中的web.xml文件汤锨,通過其中的各種配置來啟動項目双抽,只有其中配置的各項均無誤時,項目才能正確啟動闲礼。web.xml有多項標(biāo)簽牍汹,在其加載的過程中順序依次為:context-param >> listener >> fileter >> servlet?。(同類多個節(jié)點以出現(xiàn)順序依次加載)
而spring mvc啟動過程大致分為兩個過程:
ContextLoaderListener初始化柬泽,實例化IoC容器慎菲,并將此容器實例注冊到ServletContext中。
DispatcherServlet初始化锨并。
其中ContextLoaderListener監(jiān)聽器它實現(xiàn)了ServletContextListener這個接口露该,在web.xml配置這個監(jiān)聽器,啟動容器時第煮,就會默認(rèn)執(zhí)行它實現(xiàn)的方法解幼。在ContextLoaderListener中關(guān)聯(lián)了ContextLoader這個類,所以整個加載配置過程由ContextLoader來完成包警。
ContextLoaderListener在web.xml中的配置
<context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/applicationContext.xml</param-value></context-param><listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class></listener>
ServletContextListener 接口有兩個方法:contextInitialized,contextDestroyed
DispatcherServlet
Spring MVC框架撵摆,與其他很多web的MVC框架一樣:請求驅(qū)動;所有設(shè)計都圍繞著一個中央Servlet來展開害晦,它負(fù)責(zé)把所有請求分發(fā)到控制器特铝;同時提供其他web應(yīng)用開發(fā)所需要的功能。不過Spring的中央處理器篱瞎,DispatcherServlet苟呐,能做的比這更多。
下圖展示了Spring Web MVC的DispatcherServlet處理請求的工作流俐筋。熟悉設(shè)計模式的朋友會發(fā)現(xiàn),DispatcherServlet應(yīng)用的其實就是一個“前端控制器”的設(shè)計模式(其他很多優(yōu)秀的web框架也都使用了這個設(shè)計模式)严衬。
流程圖
在web.xml中的配置
<servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <load-on-startup>1</load-on-startup></servlet><servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/</url-pattern></servlet-mapping>
其中
load-on-startup:表示啟動容器時初始化該Servlet澄者;
url-pattern:表示哪些請求交給Spring Web MVC處理, “/” 是用來定義默認(rèn)servlet映射的。也可以如“*.html”表示攔截所有以html為擴(kuò)展名的請求粱挡。
在Spring MVC中赠幕,每個DispatcherServlet都持有一個自己的上下文對象WebApplicationContext,它又繼承了根(root)WebApplicationContext對象中已經(jīng)定義的所有bean询筏。這些繼承的bean可以在具體的Servlet實例中被重載榕堰,在每個Servlet實例中你也可以定義其scope下的新bean。
WebApplicationContext繼承自ApplicationContext嫌套,它提供了一些web應(yīng)用經(jīng)常需要用到的特性逆屡。它與普通的ApplicationContext不同的地方在于,它支持主題的解析踱讨,并且知道它關(guān)聯(lián)到的是哪個servlet(它持有一個該ServletContext的引用)
[圖片上傳中魏蔗。。痹筛。(6)]
spring mvc同時提供了很多特殊的注解莺治,用于處理請求和渲染視圖等。DispatcherServlet初始化的過程中會默認(rèn)使用這些特殊bean進(jìn)行配置帚稠。如果你想指定使用哪個特定的bean谣旁,你可以在web應(yīng)用上下文WebApplicationContext中簡單地配置它們。
[圖片上傳中滋早。蔓挖。。(7)]
其中馆衔,常用的ViewResolver的配置瘟判。以jsp作為視圖為例
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/jsp/" /> <property name="suffix" value=".jsp" /></bean>
配置上傳文件限制MultipartResolver
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver"> <property name="maxUploadSize" value="32505856"/></bean>
applicationContext.xml中的標(biāo)簽
文件上傳
前面說到DispatcherServlet中有個特殊的Bean叫MultipartResolver,可用于限制文件的上傳大小等角溃。當(dāng)解析器MultipartResolver完成處理時拷获,請求便會像其他請求一樣被正常流程處理。
表單
<form method="post" action="/form" enctype="multipart/form-data"> <input type="text" name="name"/> <input type="file" name="file"/> <input type="submit"/></form>
控制器
@RequestMapping(path = "/form", method = RequestMethod.POST) public String handleFormUpload(@RequestParam("name") String name, @RequestParam("file") MultipartFile file) { if (!file.isEmpty()) { byte[] bytes = file.getBytes(); // store the bytes somewhere return "redirect:uploadSuccess"; } return "redirect:uploadFailure";}
異常處理
先來說下常見的異常處理有幾種方式减细,如下圖:
Spring的處理器異常解析器HandlerExceptionResolver接口的實現(xiàn)負(fù)責(zé)處理各類控制器執(zhí)行過程中出現(xiàn)的異常匆瓜。也是上面提到的,是DispatcherServlet中的特殊bean未蝌,可以自定義配置處理驮吱。
某種程度上講,HandlerExceptionResolver與你在web應(yīng)用描述符web.xml文件中能定義的異常映射(exception mapping)很相像萧吠,不過它比后者提供了更靈活的方式左冬。比如它能提供異常被拋出時正在執(zhí)行的是哪個處理器這樣的信息。
HandlerExceptionResolver 提供resolveException接口
public interface HandlerExceptionResolver { ModelAndView resolveException( HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex); }
在BaseController中使用 @ExceptionHandler注解處理異常
@ExceptionHandler(Exception.class) public Object exceptionHandler(Exception ex, HttpServletResponse response, HttpServletRequest request) throws IOException { String url = ""; String msg = ex.getMessage(); Object resultModel = null; try { if (ex.getClass() == HttpRequestMethodNotSupportedException.class) { url = "admin/common/500"; System.out.println("--------毛有找到對應(yīng)方法---------"); } else if (ex.getClass() == ParameterException.class) {//自定義的異常 } else if (ex.getClass() == UnauthorizedException.class) { url = "admin/common/unauth"; System.out.println("--------毛有權(quán)限---------"); } String header = req.getHeader("X-Requested-With"); boolean isAjax = "XMLHttpRequest".equalsIgnoreCase(header); String method = req.getMethod(); boolean isPost = "POST".equalsIgnoreCase(method); if (isAjax || isPost) { return Message.error(msg); } else { ModelAndView view = new ModelAndView(url); view.addObject("error", msg); view.addObject("class", ex.getClass()); view.addObject("method", request.getRequestURI()); return view; } } catch (Exception exception) { logger.error(exception.getMessage(), exception); return resultModel; } finally { logger.error(msg, ex); ex.printStackTrace(); } }
在web.xml中處理異常
<error-page> <error-code>403</error-code> <location>/403.html</location></error-page><error-page> <error-code>404</error-code> <location>/404.html</location></error-page><error-page> <error-code>500</error-code> <location>/500.html</location> </error-page> <error-page> <exception-type>java.lang.Exception</exception-type> <location>/500.jsp</location> </error-page> <error-page> <exception-type>java.lang.Throwable</exception-type> <location>/500.jsp</location> </error-page>
來一個問題:HandlerExceptionResolver和web.xml中配置的error-page會有沖突嗎纸型?
解答:如果resolveException返回了ModelAndView拇砰,會優(yōu)先根據(jù)返回值中的頁面來顯示梅忌。不過,resolveException可以返回null除破,此時則展示web.xml中的error-page的500狀態(tài)碼配置的頁面牧氮。 當(dāng)web.xml中有相應(yīng)的error-page配置,則可以在實現(xiàn)resolveException方法時返回null瑰枫。 API文檔中對返回值的解釋: return a corresponding ModelAndView to forward to, or null for default processing.