最近开始学习Spring MVC框架,在传智博客的课程资源中找到了Spring MVC的教学视频,本文也作为课程笔记与小结。
Spring MVC
Spring MVC属于SpringFrameWork的后续产品,已经融合在Spring Web Flow里面。Spring 框架提供了构建 Web 应用程序的全功能 MVC 模块。
在开始入门程序之前,先了解下Spring MVC的工作原理。
Spring MVC工作流程
Spring MVC的工作流程可用下面这张图表示:
Spring MVC主要由前端控制器 DispatcherServlet、处理器映射器 HandlerMapping、处理器适配器 HandlerAdapter、处理器 Handler、视图解析器 ViewResolver 以及 视图 View 组成。
从命名上看,这里的DispatcherServlet就是一个Servlet,所有请求正是从这个Servlet开始,而Spring MVC正是采用了前端控制器模式(Front Controller Pattern)。所谓前端控制器模式,是用来提供一个集中的请求处理机制,所有的请求都将由一个单一的处理程序处理。该处理程序可以做认证/授权/记录日志,或者跟踪请求,然后把请求传给相应的处理程序。
对照上图中的数字标号,Spring MVC的工作流程大致如下:
- 用户发送请求至DispatcherServlet
- DispatcherServlet请求HandlerMapping查找Handler
- HandlerMapping向DispatcherServlet返回Handler
- DispatcherServlet请求HandlerAdapter执行Handler
- HandlerAdapter执行Handler
- Handler返回一个ModelAndView对象给HandlerAdapter,ModelAndView中包含模型数据和逻辑视图名
- HandlerAdapter返回ModelAndView给DispatcherServlet
- DispatcherServlet请求ViewResolver将逻辑视图名解析为具体的View
- ViewResolver将解析出的具体的View返回给DispatcherServlet
- View根据传过来的Model数据进行渲染,Model实际上是一个Map
- 视图渲染完毕后最终由DispatcherServlet响应给用户
在实际开发中,以上几个模块Handler和View需要我们编写,其它模块均需要进行配置,后面的入门程序中会讲到。
Spring MVC 入门程序
首先介绍我所使用的开发环境
- JDK 1.6.0_23
- Tomcat 7.0.69
- Spring Framework 4.3.3
- IDE: IntelliJ IDEA 15.0.6
入门程序是实现一个简单的商品查询功能,相关数据将采用静态数据的方式。
1.建立工程,搭建开发环境
项目目录如上所示,其中config文件夹作为存放一些xml配置文件的目录,建立文件夹后需要右键Make Directory As Sources Root才能作为classpath使用。web/WEB-INF/lib文件夹用于存放项目所用到的jar包,将Spring和其它需要的jar包放入。
其中
spring-webmvc-4.3.3.RELEASE.jar
便是Spring MVC模块,另外mybatis是为后续开发准备,入门项目暂时用不到。其它项目相关配置(如Tomcat)在这不多提及。
2.配置DispatcherServlet
前面提及DispatcherServlet实际就是一个Servlet,所以应在web.xml中配置这个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>
参数contentConfigLocation
用于指定Spring配置文件的位置,这里是项目目录中的config下的spring-mvc.xml
。
3.配置其它模块/编写Handler
接下来,需要对HandlerMapping、HandlerAdapter、ViewResolver进行配置,首先介绍使用非注解方式的配置。
3.1使用非注解方式
在Spring MVC中,由多种HandlerMapping和HandlerAdapter可供我们使用,首先介绍HandlerAdapter的配置。
第一种:SimpleControllerHandlerAdapter
使用SimpleControllerHandlerAdapter要求所编写的Handler实现Controller接口。
在Spring配置文件spring-mvc.xml添加相应的bean:
<bean class="org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter"/>
Handler类:
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
是一个po类,拥有一些基本属性和相应的getter和setter方法(如id、name、price等),这里作为入门示例使用了静态数据,itemsList.jsp
位于/WEB-INF/jsp/items
下,里面仅有一个表格用于数据的展示。
<%@ 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>商品名称</td>
<td>商品价格</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>
接下来还需要对HandlerMapping配置,首先介绍BeanNameUrlHandlerMapping:使用该映射器要求在配置Handler类时指定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的配置,对于jsp页面,使用InternalResourceViewResolver
。
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
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"/>
<!-- BeanNameUrlHandlerMapping: 将bean的name作为url查找,需在配置Handler指定bean name,即url -->
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
<!-- SimpleControllerHandlerAdapter: 要求Handler实现Controller接口 -->
<bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
</beans>
至此,相关的程序编码和配置均已完成,启动Tomcat,将项目部署至Tomcat中,访问链接
另外一种映射器叫做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实现HttpRequestHandler接口,使用如下(直接在spring-mvc.xml继续添加了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实现Controller接口 -->
<bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
<!-- HttpRequestHandlerAdapter: 要求Handler实现HttpRequestHandler接口 -->
<bean class="org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter"/>
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"/>
</beans>
使用HttpRequestHandlerAdapter时Handler中handleRequest()方法与Servlet中的doGet()或doPost()方法几乎一样,使用这种方法可以根据需求设置相应数据格式(如不需要返回页面而是Json数据,使用httpServletResponse.getWriter().write()
写入Json字符串)。
以上便是使用非注解配置方式的HandlerAdapter和HandlerMapping的内容,通过学习也了解到了非注解方式存在明显的缺点,一个Handler只有一个方法实现我们的功能,在需求较多的情况下,如本案例中同样是商品的相关请求,需要获取全部商品/根据id查找商品/修改商品信息等都需要写不同的Handler,比较麻烦,使用注解的方式正能解决这一问题。
3.2 使用非注解方式
首先需要在Spring配置文件中配置<content:component-scan>
,开启Spring的组件扫描。
<content:component-scan base-package="com.dstudiow.ssm.controller"/>
接下来是注解方式所使用的处理器适配器以及处理器映射器,分别为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/>
标签,该标签帮我们默认注册了RequestMappingHandlerAdapter
和RequestMappingHandlerMapping
这两个bean。而在Spring 3.2之前的版本中默认注册的为DefaultAnnotationHandlerMapping
与AnnotationMethodHandlerAdapter
,这两个类目前已被废弃。
接下来是Handler类:
@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
注解标识此类为一个Handler,@RequestMapping
标识所对应的访问路径。
ViewResolver
在前面的示例中,Handler会返回一个ModelAndView对象,通过setViewName()方法设置了对应的视图绝对路径,根据我们项目目录的划分,这个完整路径一般还是比较长的,每次都在代码中写下完整的路径未免有些繁琐,所以ViewResolver有关于url前后缀的属性可以配置,如下:
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/"/>
<property name="suffix" value=".jsp"/>
</bean>
Handler就不需要写下完整路径了:
modelAndView.setViewName("items/itemsList");