最近開(kāi)始學(xué)習(xí)Spring MVC框架,在傳智博客的課程資源中找到了Spring MVC的教學(xué)視頻,本文也作為課程筆記與小結(jié)。
Spring MVC
Spring MVC屬于SpringFrameWork的后續(xù)產(chǎn)品,已經(jīng)融合在Spring Web Flow里面。Spring 框架提供了構(gòu)建 Web 應(yīng)用程序的全功能 MVC 模塊。
在開(kāi)始入門(mén)程序之前,先了解下Spring MVC的工作原理。
Spring MVC工作流程
Spring MVC的工作流程可用下面這張圖表示:
Spring MVC主要由前端控制器 DispatcherServlet、處理器映射器 HandlerMapping、處理器適配器 HandlerAdapter、處理器 Handler、視圖解析器 ViewResolver 以及 視圖 View 組成。
從命名上看,這里的DispatcherServlet就是一個(gè)Servlet,所有請(qǐng)求正是從這個(gè)Servlet開(kāi)始,而Spring MVC正是采用了前端控制器模式(Front Controller Pattern)。所謂前端控制器模式,是用來(lái)提供一個(gè)集中的請(qǐng)求處理機(jī)制,所有的請(qǐng)求都將由一個(gè)單一的處理程序處理。該處理程序可以做認(rèn)證/授權(quán)/記錄日志,或者跟蹤請(qǐng)求,然后把請(qǐng)求傳給相應(yīng)的處理程序。
對(duì)照上圖中的數(shù)字標(biāo)號(hào),Spring MVC的工作流程大致如下:
- 用戶(hù)發(fā)送請(qǐng)求至DispatcherServlet
- DispatcherServlet請(qǐng)求HandlerMapping查找Handler
- HandlerMapping向DispatcherServlet返回Handler
- DispatcherServlet請(qǐng)求HandlerAdapter執(zhí)行Handler
- HandlerAdapter執(zhí)行Handler
- Handler返回一個(gè)ModelAndView對(duì)象給HandlerAdapter,ModelAndView中包含模型數(shù)據(jù)和邏輯視圖名
- HandlerAdapter返回ModelAndView給DispatcherServlet
- DispatcherServlet請(qǐng)求ViewResolver將邏輯視圖名解析為具體的View
- ViewResolver將解析出的具體的View返回給DispatcherServlet
- View根據(jù)傳過(guò)來(lái)的Model數(shù)據(jù)進(jìn)行渲染,Model實(shí)際上是一個(gè)Map
- 視圖渲染完畢后最終由DispatcherServlet響應(yīng)給用戶(hù)
在實(shí)際開(kāi)發(fā)中,以上幾個(gè)模塊Handler和View需要我們編寫(xiě),其它模塊均需要進(jìn)行配置,后面的入門(mén)程序中會(huì)講到。
Spring MVC 入門(mén)程序
首先介紹我所使用的開(kāi)發(fā)環(huán)境
- JDK 1.6.0_23
- Tomcat 7.0.69
- Spring Framework 4.3.3
- IDE: IntelliJ IDEA 15.0.6
入門(mén)程序是實(shí)現(xiàn)一個(gè)簡(jiǎn)單的商品查詢(xún)功能,相關(guān)數(shù)據(jù)將采用靜態(tài)數(shù)據(jù)的方式。
1.建立工程,搭建開(kāi)發(fā)環(huán)境
項(xiàng)目目錄如上所示,其中config文件夾作為存放一些xml配置文件的目錄,建立文件夾后需要右鍵Make Directory As Sources Root才能作為classpath使用。web/WEB-INF/lib文件夾用于存放項(xiàng)目所用到的jar包,將Spring和其它需要的jar包放入。
其中
spring-webmvc-4.3.3.RELEASE.jar
便是Spring MVC模塊,另外mybatis是為后續(xù)開(kāi)發(fā)準(zhǔn)備,入門(mén)項(xiàng)目暫時(shí)用不到。其它項(xiàng)目相關(guān)配置(如Tomcat)在這不多提及。
2.配置DispatcherServlet
前面提及DispatcherServlet實(shí)際就是一個(gè)Servlet,所以應(yīng)在web.xml中配置這個(gè)Servlet。
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<servlet>
<servlet-name>DispatchServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>DispatchServlet</servlet-name>
<url-pattern>*.action</url-pattern>
</servlet-mapping>
</web-app>
參數(shù)contentConfigLocation
用于指定Spring配置文件的位置,這里是項(xiàng)目目錄中的config下的spring-mvc.xml
。
3.配置其它模塊/編寫(xiě)Handler
接下來(lái),需要對(duì)HandlerMapping、HandlerAdapter、ViewResolver進(jìn)行配置,首先介紹使用非注解方式的配置。
3.1使用非注解方式
在Spring MVC中,由多種HandlerMapping和HandlerAdapter可供我們使用,首先介紹HandlerAdapter的配置。
第一種:SimpleControllerHandlerAdapter
使用SimpleControllerHandlerAdapter要求所編寫(xiě)的Handler實(shí)現(xiàn)Controller接口。
在Spring配置文件spring-mvc.xml添加相應(yīng)的bean:
<bean class="org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter"/>
Handler類(lèi):
public class ItemsControllerA implements Controller
{
@Override
public ModelAndView handleRequest(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws Exception
{
List<Items> itemsList = new ArrayList<Items>();
Items items1 = new Items();
items1.setName("Microsoft Surface Pro 4");
items1.setPrice(8900f);
items1.setDetail("Surface");
Items items2 = new Items();
items2.setName("Microsoft Surface Studio");
items2.setPrice(20000f);
items2.setDetail("Surface");
itemsList.add(items1);
itemsList.add(items2);
ModelAndView modelAndView = new ModelAndView();
modelAndView.addObject("itemsList", itemsList);
modelAndView.setViewName("/WEB-INF/jsp/items/itemsList.jsp");
return modelAndView;
}
}
Items
是一個(gè)po類(lèi),擁有一些基本屬性和相應(yīng)的getter和setter方法(如id、name、price等),這里作為入門(mén)示例使用了靜態(tài)數(shù)據(jù),itemsList.jsp
位于/WEB-INF/jsp/items
下,里面僅有一個(gè)表格用于數(shù)據(jù)的展示。
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<%@taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt"%>
<html>
<head>
<title>Title</title>
</head>
<body>
<form>
商品列表:
<table>
<tr>
<td>商品名稱(chēng)</td>
<td>商品價(jià)格</td>
<td>商品描述</td>
</tr>
<c:forEach items="${itemsList}" var="item">
<tr>
<td>${item.name}</td>
<td>${item.price}</td>
<td>${item.detail}</td>
</tr>
</c:forEach>
</table>
</form>
</body>
</html>
接下來(lái)還需要對(duì)HandlerMapping配置,首先介紹BeanNameUrlHandlerMapping:使用該映射器要求在配置Handler類(lèi)時(shí)指定bean的name屬性,且name作為url,配置如下:
<!-- Handler -->
<bean id="ItemsControllerA" name="/queryItems.action" class="com.dstudiow.ssm.controller.ItemsControllerA"/>
<!-- BeanNameUrlHandlerMapping: 將bean的name作為url查找,需在配置Handler指定bean name,即url -->
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
</bean>
最后還有ViewResolver的配置,對(duì)于jsp頁(yè)面,使用InternalResourceViewResolver
。
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
spring-mvc.xml完整內(nèi)容如下:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:content="http://www.springframework.org/schema/context"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.1.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.1.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-4.1.xsd">
<!-- Handler -->
<bean id="ItemsControllerA" name="/queryItems.action" class="com.dstudiow.ssm.controller.ItemsControllerA"/>
<!-- BeanNameUrlHandlerMapping: 將bean的name作為url查找,需在配置Handler指定bean name,即url -->
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
<!-- SimpleControllerHandlerAdapter: 要求Handler實(shí)現(xiàn)Controller接口 -->
<bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
</beans>
至此,相關(guān)的程序編碼和配置均已完成,啟動(dòng)Tomcat,將項(xiàng)目部署至Tomcat中,訪問(wèn)鏈接
另外一種映射器叫做SimpleUrlHandlerMapping,使用方式如下:
<!-- SimpleUrlHandlerMapping -->
<bean class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
<property name="mappings">
<props>
<!-- key為url,值為bean id -->
<prop key="/queryItems1.action">ItemsControllerA</prop>
</props>
</property>
</bean>
第二種 HttpRequestHandlerAdapter
使用HttpRequestHandlerAdapter要求Handler實(shí)現(xiàn)HttpRequestHandler接口,使用如下(直接在spring-mvc.xml繼續(xù)添加了bean):
Handler:
public class ItemsControllerB implements HttpRequestHandler
{
@Override
public void handleRequest(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws ServletException, IOException
{
List<Items> itemsList = new ArrayList<Items>();
Items items1 = new Items();
items1.setName("Microsoft Surface Pro 4");
items1.setPrice(8900f);
items1.setDetail("Surface");
Items items2 = new Items();
items2.setName("Microsoft Surface Studio");
items2.setPrice(20000f);
items2.setDetail("Surface");
itemsList.add(items1);
itemsList.add(items2);
httpServletRequest.setAttribute("itemsList", itemsList);
httpServletRequest.getRequestDispatcher("/WEB-INF/jsp/items/itemsList.jsp").forward(httpServletRequest, httpServletResponse);
}
}
spring-mvc.xml:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:content="http://www.springframework.org/schema/context"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.1.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.1.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-4.1.xsd">
<!-- Handler -->
<bean id="ItemsControllerA" name="/queryItems.action" class="com.dstudiow.ssm.controller.ItemsControllerA"/>
<bean id="ItemsControllerB" class="com.dstudiow.ssm.controller.ItemsControllerB"/>
<!-- BeanNameUrlHandlerMapping: 將bean的name作為url查找,需在配置Handler指定bean name,即url -->
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
</bean>
<!-- SimpleUrlHandlerMapping -->
<bean class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
<property name="mappings">
<props>
<!-- key為url,值為bean id -->
<prop key="/queryItems1.action">ItemsControllerA</prop>
<prop key="/queryItems2.action">ItemsControllerB</prop>
</props>
</property>
</bean>
<!-- SimpleControllerHandlerAdapter: 要求Handler實(shí)現(xiàn)Controller接口 -->
<bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
<!-- HttpRequestHandlerAdapter: 要求Handler實(shí)現(xiàn)HttpRequestHandler接口 -->
<bean class="org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter"/>
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
</beans>
使用HttpRequestHandlerAdapter時(shí)Handler中handleRequest()方法與Servlet中的doGet()或doPost()方法幾乎一樣,使用這種方法可以根據(jù)需求設(shè)置相應(yīng)數(shù)據(jù)格式(如不需要返回頁(yè)面而是Json數(shù)據(jù),使用httpServletResponse.getWriter().write()
寫(xiě)入Json字符串)。
以上便是使用非注解配置方式的HandlerAdapter和HandlerMapping的內(nèi)容,通過(guò)學(xué)習(xí)也了解到了非注解方式存在明顯的缺點(diǎn),一個(gè)Handler只有一個(gè)方法實(shí)現(xiàn)我們的功能,在需求較多的情況下,如本案例中同樣是商品的相關(guān)請(qǐng)求,需要獲取全部商品/根據(jù)id查找商品/修改商品信息等都需要寫(xiě)不同的Handler,比較麻煩,使用注解的方式正能解決這一問(wèn)題。
3.2 使用非注解方式
首先需要在Spring配置文件中配置<content:component-scan>
,開(kāi)啟Spring的組件掃描。
<content:component-scan base-package="com.dstudiow.ssm.controller"/>
接下來(lái)是注解方式所使用的處理器適配器以及處理器映射器,分別為RequestMappingHandlerAdapter
和RequestMappingHandlerMapping
,在配置文件加入bean即可:
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"/>
除此之外,可以使用<mvc:annotation-driven/>
標(biāo)簽,該標(biāo)簽幫我們默認(rèn)注冊(cè)了RequestMappingHandlerAdapter
和RequestMappingHandlerMapping
這兩個(gè)bean。而在Spring 3.2之前的版本中默認(rèn)注冊(cè)的為DefaultAnnotationHandlerMapping
與AnnotationMethodHandlerAdapter
,這兩個(gè)類(lèi)目前已被廢棄。
接下來(lái)是Handler類(lèi):
@Controller
public class ItemsControllerC
{
@RequestMapping("/queryItems3.action")
public ModelAndView queryItems() throws Exception
{
List<Items> itemsList = new ArrayList<Items>();
Items items1 = new Items();
items1.setName("Microsoft Surface Pro 4");
items1.setPrice(8900f);
items1.setDetail("Surface");
Items items2 = new Items();
items2.setName("Microsoft Surface Studio");
items2.setPrice(20000f);
items2.setDetail("Surface");
itemsList.add(items1);
itemsList.add(items2);
ModelAndView modelAndView = new ModelAndView();
modelAndView.addObject("itemsList", itemsList);
modelAndView.setViewName("/WEB-INF/jsp/items/itemsList.jsp");
return modelAndView;
}
}
@Controller
注解標(biāo)識(shí)此類(lèi)為一個(gè)Handler,@RequestMapping
標(biāo)識(shí)所對(duì)應(yīng)的訪問(wèn)路徑。
ViewResolver
在前面的示例中,Handler會(huì)返回一個(gè)ModelAndView對(duì)象,通過(guò)setViewName()方法設(shè)置了對(duì)應(yīng)的視圖絕對(duì)路徑,根據(jù)我們項(xiàng)目目錄的劃分,這個(gè)完整路徑一般還是比較長(zhǎng)的,每次都在代碼中寫(xiě)下完整的路徑未免有些繁瑣,所以ViewResolver有關(guān)于url前后綴的屬性可以配置,如下:
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/"/>
<property name="suffix" value=".jsp"/>
</bean>
Handler就不需要寫(xiě)下完整路徑了:
modelAndView.setViewName("items/itemsList");