spring mvc(超詳細 要安靜的來看)
一、前言:
大家好,Spring3 MVC是非常優秀的MVC框架,由其是在3.0版本釋出後,現在有越來越多的團隊選擇了Spring3 MVC了。Spring3 MVC結構簡單,應了那句話簡單就是美,而且他強大不失靈活,效能也很優秀。
Struts2也是比較優秀的MVC構架,優點非常多比如良好的結構。但這裡想說的是缺點,Struts2由於採用了值棧、OGNL表示式、 struts2標籤庫等,會導致應用的效能下降。Struts2的多層攔截器、多例項action效能都很好。可以參考我寫的一篇關於Spring MVC與Struts2與Servlet比較的文章 http://elf8848.iteye.com/admin/blogs/698217
Spring3 MVC的優點:
1、Spring3 MVC的學習難度小於Struts2,Struts2用不上的多餘功能太多。呵呵,當然這不是決定因素。
2、Spring3 MVC很容易就可以寫出效能優秀的程式,Struts2要處處小心才可以寫出效能優秀的程式(指MVC部分)
3、Spring3 MVC的靈活是你無法想像的,Spring的擴充套件性有口皆碑,Spring3 MVC當然也不會落後,不會因使用了MVC框架而感到有任何的限制。
Struts2的眾多優點:略... (呵呵,是不是不公平?)
眾多文章開篇時總要吹些牛,吸引一下讀者的眼球,把讀者的胃口調起來,這樣大家才有興趣接著往後看。本文也沒能例外。不過保證你看了之後不會後悔定有收穫。
二、核心類與介面:
先來了解一下,幾個重要的介面與類。現在不知道他們是幹什麼的沒關係,先混個臉熟,為以後認識他們打個基礎。
DispatcherServlet -- 前置控制器
HandlerMapping介面 -- 處理請求的對映
HandlerMapping介面的實現類:
SimpleUrlHandlerMapping 通過配置檔案,把一個URL對映到Controller
DefaultAnnotationHandlerMapping 通過註解,把一個URL對映到Controller類上
HandlerAdapter介面 -- 處理請求的對映
AnnotationMethodHandlerAdapter類,通過註解,把一個URL對映到Controller類的方法上
Controller介面 -- 控制器
由於我們使用了@Controller註解,添加了@Controller註解註解的類就可以擔任控制器(Action)的職責,
所以我們並沒有用到這個介面。
HandlerInterceptor 介面--攔截器
無圖,我們自己實現這個介面,來完成攔截的器的工作。
ViewResolver介面的實現類
UrlBasedViewResolver類 通過配置檔案,把一個檢視名交給到一個View來處理
InternalResourceViewResolver類,比上面的類,加入了JSTL的支援
View介面
JstlView類
LocalResolver介面
HandlerExceptionResolver介面 --異常處理
SimpleMappingExceptionResolver實現類
ModelAndView類
無圖。
三、核心流程圖
本圖是我個人畫的,有不嚴謹的地方,大家對付看吧。總比沒的看強。
四、DispatcherServlet說明
使用Spring MVC,配置DispatcherServlet是第一步。
DispatcherServlet是一個Servlet,所以可以配置多個DispatcherServlet。
DispatcherServlet是前置控制器,配置在web.xml檔案中的。攔截匹配的請求,Servlet攔截匹配規則要自已定義,把攔截下來的請求,依據某某規則分發到目標Controller(我們寫的Action)來處理。
“某某規則”:是根據你使用了哪個HandlerMapping介面的實現類的不同而不同。
先來看第一個例子:
Xml程式碼
- <web-app>
- <servlet>
- <servlet-name>example</servlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>example</servlet-name>
- <url-pattern>*.form</url-pattern>
- </servlet-mapping>
- </web-app>
<load-on-startup>1</load-on-startup>是啟動順序,讓這個Servlet隨Servletp容器一起啟動。
<url-pattern>*.form</url-pattern> 會攔截*.form結尾的請求。
<servlet-name>example</servlet-name>這個Servlet的名字是example,可以 有多個DispatcherServlet,是通過名字來區分的。每一個DispatcherServlet有自己的 WebApplicationContext上下文物件。同時儲存的ServletContext中和Request物件中,關於key,以後說明。
在DispatcherServlet的初始化過程中,框架會在web應用的 WEB-INF資料夾下尋找名為[servlet-name]-servlet.xml 的配置檔案,生成檔案中定義的bean。
第二個例子:
Xml程式碼
- <servlet>
- <servlet-name>springMVC</servlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
- <init-param>
- <param-name>contextConfigLocation</param-name>
- <param-value>classpath*:/springMVC.xml</param-value>
- </init-param>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>springMVC</servlet-name>
- <url-pattern>/</url-pattern>
- </servlet-mapping>
指明瞭配置檔案的檔名,不使用預設配置檔名,而使用springMVC.xml配置檔案。
其中<param-value>**.xml</param-value> 這裡可以使用多種寫法
1、不寫,使用預設值:/WEB-INF/<servlet-name>-servlet.xml
2、<param-value>/WEB-INF/classes/springMVC.xml</param-value>
3、<param-value>classpath*:springMVC-mvc.xml</param-value>
4、多個值用逗號分隔
Servlet攔截匹配規則可以自已定義,Servlet攔截哪種URL合適?
當對映為@RequestMapping("/user/add")時:
1、攔截*.do,例如:/user/add.do,弊端:所有的url都要以.do結尾。不會影響訪問靜態檔案。
2、攔截/app/*,例如:/app/user/add,弊端:請求的url都要包含/app,@RequestMapping("/user/add")中不須要包含/app。
3、攔截/,例如:/user/add,弊端:對jpg,js,css靜態檔案的訪問也被攔截不能正常顯示。後面有解決辦法。
4、攔截/*,可以走到Action中,但轉發到jsp時再次被攔截,不能訪問到jsp。
五、雙親上下文的說明
如果你使用了listener監聽器來載入配置,一般在Struts+Spring+Hibernate的專案中都是使用listener監聽器的。如下
Java程式碼
- <listener>
- <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
- </listener>
Spring會建立一個全域性的WebApplicationContext上下文,稱為根上下文 ,儲存在 ServletContext 中,key是WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE屬性的值。可 以使用工具類取出上下 文:WebApplicationContextUtils.getWebApplicationContext(ServletContext);
DispatcherServlet是一個Servlet,可以同時配置多個,每個 DispatcherServlet有一個自己的 WebApplicationContext上下文,這個上下文繼承了 根上下文 中所有東西。 儲存在 ServletContext中,key是"org.springframework.web.servlet.FrameworkServlet.CONTEXT"+Servlet名稱。當一個Request物件產生時,會把這個WebApplicationContext上下文儲存在Request物件中,key是DispatcherServlet.class.getName() + ".CONTEXT"。可以使用工具類取出上下文:RequestContextUtils.getWebApplicationContext(request);
Spring中的 ApplicationContext例項可以被限制在不同的作用域(scope)中。
在web MVC框架中,每個 DispatcherServlet有它自己的WebApplicationContext ,這個context繼承了根 WebApplicationContext 的所有bean定義。
這些繼承的bean也可以在每個serlvet自己的所屬的域中被覆蓋(override),覆蓋後的bean 可以被設定上只有這個servlet例項自己使用的屬性。
總結:不使用listener監聽器來載入spring的配置,改用DispatcherServlet來載入spring的配置,不要雙親上下文,只使用一個DispatcherServlet,事情就簡單了,什麼麻煩事兒也沒有了。
六、springMVC-mvc.xml 配置檔案片段講解 (未使用預設配置檔名)
Xml程式碼
- <!-- 自動掃描的包名 -->
- <context:component-scan base-package="com.app,com.core,JUnit4" ></context:component-scan>
- <!-- 預設的註解對映的支援 -->
- <mvc:annotation-driven />
- <!-- 檢視解釋類 -->
- <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
- <property name="prefix" value="/WEB-INF/jsp/"/>
- <property name="suffix" value=".jsp"/><!--可為空,方便實現自已的依據副檔名來選擇檢視解釋類的邏輯 -->
- <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
- </bean>
- <!-- 攔截器 -->
- <mvc:interceptors>
- <bean class="com.core.mvc.MyInteceptor" />
- </mvc:interceptors>
- <!-- 對靜態資原始檔的訪問 方案一 (二選一) -->
- <mvc:default-servlet-handler/>
- <!-- 對靜態資原始檔的訪問 方案二 (二選一)-->
- <mvc:resources mapping="/images/**" location="/images/" cache-period="31556926"/>
- <mvc:resources mapping="/js/**" location="/js/" cache-period="31556926"/>
- <mvc:resources mapping="/css/**" location="/css/" cache-period="31556926"/>
<context:component-scan/> 掃描指定的包中的類上的註解,常用的註解有:
@Controller 宣告Action元件
@Service 宣告Service元件 @Service("myMovieLister")
@Repository 宣告Dao元件
@Component 泛指元件, 當不好歸類時.
@RequestMapping("/menu") 請求對映
@Resource 用於注入,( j2ee提供的 ) 預設按名稱裝配,@Resource(name="beanName")
@Autowired 用於注入,(srping提供的) 預設按型別裝配
@Transactional( rollbackFor={Exception.class}) 事務管理
@ResponseBody
@Scope("prototype") 設定bean的作用域
<mvc:annotation-driven /> 是一種簡寫形式,完全可以手動配置替代這種簡寫形式,簡寫形式可以讓初學都快速應用預設配置方案。<mvc:annotation-driven /> 會自動註冊DefaultAnnotationHandlerMapping與AnnotationMethodHandlerAdapter 兩個bean,是spring MVC為@Controllers分發請求所必須的。
並提供了:資料繫結支援,@NumberFormatannotation支援,@DateTimeFormat支援,@Valid支援,讀寫XML的支援(JAXB),讀寫JSON的支援(Jackson)。
後面,我們處理響應ajax請求時,就使用到了對json的支援。
後面,對action寫JUnit單元測試時,要從spring IOC容器中取DefaultAnnotationHandlerMapping與AnnotationMethodHandlerAdapter 兩個bean,來完成測試,取的時候要知道是<mvc:annotation-driven />這一句註冊的這兩個bean。
<mvc:interceptors/> 是一種簡寫形式。通過看前面的大圖,知道,我們可以配置多個HandlerMapping。<mvc:interceptors/>會為每一 個HandlerMapping,注入一個攔截器。其實我們也可以手動配置為每個HandlerMapping注入一個攔截器。
<mvc:default-servlet-handler/> 使用預設的Servlet來響應靜態檔案。
<mvc:resources mapping="/images/**" location="/images/" cache-period="31556926"/> 匹配URL /images/** 的URL被當做靜態資源,由Spring讀出到記憶體中再響應http。
七、如何訪問到靜態的檔案,如jpg,js,css?
如何你的DispatcherServlet攔截 *.do這樣的URL,就不存在訪問不到靜態資源的問題。如果你的
DispatcherServlet攔截“/”,攔截了所有的請求,同時對*.js,*.jpg的訪問也就被攔截了。
目的:可以正常訪問靜態檔案,不要找不到靜態檔案報404。
方案一:啟用Tomcat的defaultServlet來處理靜態檔案
Xml程式碼
- <servlet-mapping>
- <servlet-name>default</servlet-name>
- <url-pattern>*.jpg</url-pattern>
- </servlet-mapping>
- <servlet-mapping>
- <servlet-name>default</servlet-name>
- <url-pattern>*.js</url-pattern>
- </servlet-mapping>
- <servlet-mapping>
- <servlet-name>default</servlet-name>
- <url-pattern>*.css</url-pattern>
- </servlet-mapping>
- 要配置多個,每種檔案配置一個
要寫在DispatcherServlet的前面, 讓 defaultServlet先攔截,這個就不會進入Spring了,我想效能是最好的吧。
Tomcat, Jetty, JBoss, and GlassFish 預設 Servlet的名字 -- "default"
Google App Engine 預設 Servlet的名字 -- "_ah_default"
Resin 預設 Servlet的名字 -- "resin-file"
WebLogic 預設 Servlet的名字 -- "FileServlet"
WebSphere 預設 Servlet的名字 -- "SimpleFileServlet"
方案二: 在spring3.0.4以後版本提供了mvc:resources
mvc:resources 的使用方法:
Xml程式碼
- <!-- 對靜態資原始檔的訪問 -->
- <mvc:resources mapping="/images/**" location="/images/" />
/images/**對映到ResourceHttpRequestHandler進行處 理,location指定靜態資源的位置.可以是web application根目錄下、jar包裡面,這樣可以把靜態資源壓縮到jar包中。cache-period 可以使得靜態資源進行web cache
如果出現下面的錯誤,可能是沒有配置<mvc:annotation-driven />的原因。
報錯WARNING: No mapping found for HTTP request with URI [/mvc/user/findUser/lisi/770] in DispatcherServlet with name 'springMVC'
使用<mvc:resources/>元素,把mapping的URI註冊到SimpleUrlHandlerMapping的urlMap中,
key為mapping的URI pattern值,而value為ResourceHttpRequestHandler,
這樣就巧妙的把對靜態資源的訪問由HandlerMapping轉到ResourceHttpRequestHandler處理並返回,所以就支援classpath目錄,jar包內靜態資源的訪問.
另外需要注意的一點是,不要對SimpleUrlHandlerMapping設定defaultHandler.因為對static uri的defaultHandler就是ResourceHttpRequestHandler,
否則無法處理static resources request.
方案三 ,使用<mvc:default-servlet-handler/>
Xml程式碼
- <mvc:default-servlet-handler/>
會把"/**" url,註冊到SimpleUrlHandlerMapping的urlMap中,把對靜態資源的訪問由HandlerMapping轉到 org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler 處理並返回.
DefaultServletHttpRequestHandler使用就是各個Servlet容器自己的預設Servlet.
補充說明:多個HandlerMapping的執行順序問題:
DefaultAnnotationHandlerMapping的order屬性值是:0
<mvc:resources/ >自動註冊的 SimpleUrlHandlerMapping的order屬性值是: 2147483646
<mvc:default-servlet-handler/>自動註冊 的SimpleUrlHandlerMapping 的order屬性值是: 2147483647
spring會先執行order值比較小的。當訪問一個a.jpg圖片檔案時,先通過 DefaultAnnotationHandlerMapping 來找處理器,一定是找不到的,我們沒有叫a.jpg的Action。再 按order值升序找,由於最後一個 SimpleUrlHandlerMapping 是匹配 "/**"的,所以一定會匹配上,再響應圖片。
訪問一個圖片,還要走層層匹配。真不知效能如何?改天做一下壓力測試,與Apache比一比。
最後再說明一下,如何你的DispatcherServlet攔截 *.do這樣的URL,就不存上述問題了。
八、請求如何對映到具體的Action中的方法?
方案一:基於xml配置對映,可以利用SimpleUrlHandlerMapping、BeanNameUrlHandlerMapping進行Url對映和攔截請求。
配置方法略。
方案二:基於註解對映,可以使用DefaultAnnotationHandlerMapping。
Xml程式碼
- <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"> </bean>
但前面我們配置了<mvc:annotation-driven />,他會自動註冊這個bean,就不須要我們顯示的註冊這個bean了。
以上都可以注入interceptors,實現許可權控制等前置工作。
我們使用第2種,基於註解來使用spring MVC
並在action類上使用:
@Controller
@RequestMapping("/user")
九、Spring中的攔截器:
Spring為我們提供了:
org.springframework.web.servlet.HandlerInterceptor介面,
org.springframework.web.servlet.handler.HandlerInterceptorAdapter介面卡,
實現這個介面或繼承此類,可以非常方便的實現自己的攔截器。
有以下三個方法:
Action之前執行:
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler);
生成檢視之前執行
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView);
最後執行,可用於釋放資源
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler, Exception ex)
分別實現預處理、後處理(呼叫了Service並返回ModelAndView,但未進行頁面渲染)、返回處理(已經渲染了頁面)
在preHandle中,可以進行編碼、安全控制等處理;
在postHandle中,有機會修改ModelAndView;
在afterCompletion中,可以根據ex是否為null判斷是否發生了異常,進行日誌記錄。
引數中的Object handler是下一個攔截器。
十、如何使用攔截器?
自定義一個攔截器,要實現HandlerInterceptor介面:
Java程式碼
- public class MyInteceptor implements HandlerInterceptor {
- 略。。。
- }
Spring MVC並沒有總的攔截器,不能對所有的請求進行前後攔截。
Spring MVC的攔截器,是屬於HandlerMapping級別的,可以有多個HandlerMapping ,每個HandlerMapping可以有自己的攔截器。
當一個請求按Order值從小到大,順序執行HandlerMapping介面的實現類時,哪一個先有返回,那就可以結束了,後面的HandlerMapping就不走了,本道工序就完成了。就轉到下一道工序了。
攔截器會在什麼時候執行呢? 一個請求交給一個HandlerMapping時,這個HandlerMapping先找有沒有處理器來處理這個請求,如何找到了,就執行攔截器,執行完攔截後,交給目標處理器。
如果沒有找到處理器,那麼這個攔截器就不會被執行。
在spring MVC的配置檔案中配置有三種方法:
方案一,(近似)總攔截器,攔截所有url
Java程式碼
- <mvc:interceptors>
- <bean class="com.app.mvc.MyInteceptor" />
- </mvc:interceptors>
為什麼叫“近似”,前面說了,Spring沒有總的攔截器。
<mvc:interceptors/>會為每一 個HandlerMapping,注入一個攔截器。總有一個HandlerMapping是可以找到處理器的,最多也只找到一個處理器,所以這個攔截器總會被執行的。起到了總攔截器的作用。
方案二, (近似) 總攔截器, 攔截匹配的URL。
Xml程式碼
- <mvc:interceptors >
- <mvc:interceptor>
- <mvc:mapping path="/user/*" /> <!-- /user/* -->
- <bean class="com.mvc.MyInteceptor"></bean>
- </mvc:interceptor>
- </mvc:interceptors>
就是比 方案一多了一個URL匹配。
方案三,HandlerMappint上的攔截器
Xml程式碼
- <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">
- <property name="interceptors">
- <list>
- <bean class="com.mvc.MyInteceptor"></bean>
- </list>
- </property>
- </bean>
如果使用 了<mvc:annotation-driven />, 它會自動註冊DefaultAnnotationHandlerMapping 與AnnotationMethodHandlerAdapter 這兩個bean,所以就沒有機會再給它注入interceptors屬性,就無法指定攔截器。
當然我們可以通過人工配置上面的兩個Bean,不使用 <mvc:annotation-driven />,就可以 給interceptors屬性 注入攔截器了。
其實我也不建議使用<mvc:annotation-driven />,而建議手動寫配置檔案,來替代 <mvc:annotation-driven />,這就控制力就強了。
十一、如何實現全域性的異常處理?
在spring MVC的配置檔案中:
Xml程式碼
- <!-- 總錯誤處理-->
- <bean id="exceptionResolver" class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
- <property name="defaultErrorView">
- <value>/error/error</value>
- </property>
- <property name="defaultStatusCode">
- <value>500</value>
- </property>
- <property name="warnLogCategory">
- <value>org.springframework.web.servlet.handler.SimpleMappingExceptionResolver</value>
- </property>
- </bean>
這裡主要的類是SimpleMappingExceptionResolver類,和他的父類AbstractHandlerExceptionResolver類。
具體可以配置哪些屬性,我是通過檢視原始碼知道的。
你也可以實現HandlerExceptionResolver介面,寫一個自己的異常處理程式。spring的擴充套件性是很好的。
通過SimpleMappingExceptionResolver我們可以將不同的異常對映到不同的jsp頁面(通過exceptionMappings屬性的配置)。
同時我們也可以為所有的異常指定一個預設的異常提示頁面(通過defaultErrorView屬性的配置),如果所丟擲的異常在exceptionMappings中沒有對應的對映,則Spring將用此預設配置顯示異常資訊。
注意這裡配置的異常顯示介面均僅包括主檔名,至於檔案路徑和字尾已經在viewResolver中指定。如/error/error表示/error/error.jsp
顯示錯誤的jsp頁面:
Html程式碼
- <%@ page language="java" contentType="text/html; charset=GBK"
- pageEncoding="GBK"%>
- <%@ page import="java.lang.Exception"%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=GBK">
- <title>錯誤頁面</title>
- </head>
- <body>
- <h1>出錯了</h1>
- <%
- Exception e = (Exception)request.getAttribute("exception");
- out.print(e.getMessage());
- %>
- </body>
- </html>
其中一句:request.getAttribute("exception"),key是exception,也是在SimpleMappingExceptionResolver類預設指定的,是可能通過配置檔案修改這個值的,大家可以去看原始碼。