Spring MVC 学习总结 一共 3 篇 分别为
一、Spring MVC概述
Spring为展现层提供的基于MVC设计理念的优优秀的Web框架,是目前最主流的MVC框架之一
Spring3.0后全面超越Struts2,成为最优秀的MVC框架
Spring MVC 通过一套MVC注解,让 POJO 成为处理请求的控制器,而无须实现任何接口。
支持 REST风格的URL请求
采用了松散耦合可插拔组件结构,比其他MVC框架更具扩展性和灵活性
二、HelloWorld示例
1. 加入 jar 包
commons-logging-1.1.3.jar spring-aop-4.0.0.RELEASE.jar spring-beans-4.0.0.RELEASE.jar spring-context-4.0.0.RELEASE.jar spring-core-4.0.0.RELEASE.jar spring-expression-4.0.0.RELEASE.jar spring-web-4.0.0.RELEASE.jar spring-webmvc-4.0.0.RELEASE.jar
链接:http://pan.baidu.com/s/1mhBY66W 密码:w3zi
2. 在 web.xml 中添加 DispatcherServlet
<!-- 配置 DispatcherServlet --> <servlet> <servlet-name>dispatcherServlet</servlet-name> <servlet-class> org.springframework.web.servlet.DispatcherServlet </servlet-class> <!-- 配置 DispatcherServlet 的一个初始化参数: 配置 SpringMVC 配置文件的位置和名称 实际上也可以不通过 contextConfigLocation 来配置 SpringMVC 的配置文件, 而使用默认的. 默认的配置文件为: /WEB-INF/<servlet-name>-servlet.xml --> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:springmvc.xml</param-value> </init-param> <!-- 1:表示容器在应用启动时就加载这个servlet --> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcherServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping>
3. 加入 Spring MVC 配置文件:springmvc.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:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:aop="http://www.springframework.org/schema/aop" xmlns:c="http://www.springframework.org/schema/c" xmlns:cache="http://www.springframework.org/schema/cache" xmlns:jee="http://www.springframework.org/schema/jee" xmlns:lang="http://www.springframework.org/schema/lang" xmlns:p="http://www.springframework.org/schema/p" xmlns:task="http://www.springframework.org/schema/task" xmlns:util="http://www.springframework.org/schema/util" xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd http://www.springframework.org/schema/cache http://www.springframework.org/schema/cache/spring-cache-4.0.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-4.0.xsd http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-4.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.0.xsd"> <!-- 以上是完整的命名空间,可根据需求删减--> <!-- 配置自动扫描的包 --> <context:component-scan base-package="me.ziry.springmvc" /> <!-- 配置视图解析器 --> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/views/"></property> <property name="suffix" value=".jsp"></property> </bean> </beans>
4. 编写处理器 HelloWorld
import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; @Controller public class HelloWorld { /* 使用 RequestMapping 注解来映射请求的 URL */ @RequestMapping("/sayHello") public String HelloWorld() { System.out.println("Hello World..."); return "success"; } }
5. 编写视图
返回值会通过视图解析器解析为实际的物理视图,
对于InternalResourceViewResolver视图解析器,会做如下的解析:
通过 prefix + returnVal + suffix 这样的方式得到实际的物理视图,
然后会做转发操作,所以实际文件为:/WEB-INF/views/success.jsp
三、 使用 @RequestMapping 映射请求
Spring MVC 使用 @RequestMapping 注解为控制器指定可以处理哪些 URL 请求
在控制器的类定义及方法定义处都可标注 @RequestMapping
– 类定义处:提供初步的请求映射信息。相对于 WEB 应用的根目录
– 方法处:提供进一步的细分映射信息。相对于类定义处的 URL。若类定义处未标注 @RequestMapping,则方法处标记的 URL 相对于 WEB 应用的根目录
//类定义处 @RequestMapping("/springmvc") @Controller public class HelloWorld { //方法处 @RequestMapping("/sayHello") public String HelloWorld() { System.out.println("Hello World..."); return "success"; } }
DispatcherServlet 截获请求后,就通过控制器上的@RequestMapping 提供的映射信息确定请求所对应的处理方法。实际访问地址为:类定义+方法定义
四、映射请求参数、请求方法或请求头
1. 标准的 HTTP 请求报头
2. @RequestMapping 使用请求方法、请求参数及请求头映射请求
@RequestMapping 的 value、method、params 及 heads分别表示请求 URL、请求方法、请求参数及请求头的映射条件,他们之间是与的关系,联合使用多个条件可让请求映射更加精确化。
params 和 headers支持简单的表达式:
– param1: 表示请求必须包含名为 param1 的请求参数
– !param1: 表示请求不能包含名为 param1 的请求参数
– param1 != value1: 表示请求包含名为 param1 的请求参数,但其值不能为 value1
– {“param1=value1”, “param2”}: 请求必须包含名为 param1 和param2 的两个请求参数,且 param1 参数的值必须为 value1
示例:
@RequestMapping( value="delete", method=RequestMethod.POST, params={"username","age!=10"}, headers={"Accept-Language=zh-CN,zh;q=0.8"} ) public String test1() { //.... return "user/test1"; }
五、Ant 风格的 URL (不常用)
• Ant 风格资源地址支持 3 种匹配符:
– ?:匹配文件名中的一个字符
– *:匹配文件名中的任意字符
– **:** 匹配多层路径
• @RequestMapping 还支持 Ant 风格的 URL:
– /user/*/createUser: 匹配
/user/aaa/createUser、/user/bbb/createUser 等 URL
– /user/**/createUser: 匹配
/user/createUser、/user/aaa/bbb/createUser 等 URL
– /user/createUser??: 匹配
/user/createUseraa、/user/createUserbb 等 URL
六、@PathVariable 映射 URL 绑定的占位符
带占位符的 URL 是 Spring3.0 新增的功能,该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义
通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中:URL 中的 {xxx} 占位符可以通过 @PathVariable("xxx") 绑定到操作方法的入参中。
示例:
@RequestMapping("/delete/{id}") public String delete(@PathVariable("id")Integer id) { System.out.println("delete:"+id); return "success"; }
七、 REST
1. 参考资料:
理解本真的REST架构风格:http://kb.cnblogs.com/page/186516
2. 简介
REST:即 Representational State Transfer。(资源)表现层状态转化。是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用
资源(Resources):网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的存在。可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的 URI 。要获取这个资源,访问它的URI就可以,因此 URI 即为每一个资源的独一无二的识别符。
表现层(Representation):把资源具体呈现出来的形式,叫做它的表现层(Representation)。比如,文本可以用 txt 格式表现,也可以用 HTML 格式、XML 格式、JSON 格式表现,甚至可以采用二进制格式。
状态转化(State Transfer):每发出一个请求,就代表了客户端和服务器的一次交互过程。HTTP协议,是一个无状态协议,即所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生“状态转化”(State Transfer)。而这种转化是建立在表现层之上的,所以就是 “表现层状态转化”。具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET 用来获取资源,POST 用来新建资源,PUT 用来更新资源,DELETE 用来删除资源。
3. Spring的HiddenHttpMethodFilter过滤器
HiddenHttpMethodFilter:浏览器 form 表单只支持 GET与 POST 请求,而ELETE、PUT 等 method 并不支持,Spring3.0 添加了一个过滤器,可以将这些请求转换为标准的 http 方法,使得支持 GET、POST、PUT 与DELETE 请求。
4.Rest 风格的 URL. 以 CRUD 为例
功能 | URL | 请求类型 | 非Rest |
新增 | /order | POST | |
修改 | /order/1 | PUT | update?id=1 |
获取 | /order/1 | GET | get?id=1 |
删除 | /order/1 | DELETE | delete?id=1 |
5. 如何发送 PUT 请求和 DELETE 请求呢 ?
需要配置 HiddenHttpMethodFilter
需要发送 POST 请求
需要在发送 POST 请求时携带一个 name="_method" 的隐藏域, 值为 DELETE 或 PUT
6. 在 SpringMVC 的目标方法中如何得到 id 呢?
使用 @PathVariable 注解
八、 SpringMVC之REST示例
1. 在web.xml增加
<!-- 配置 org.springframework.web.filter.HiddenHttpMethodFilter: 可以把 POST 请求转为 DELETE 或 POST 请求 --> <filter> <filter-name>HiddenHttpMethodFilter</filter-name> <filter-class> org.springframework.web.filter.HiddenHttpMethodFilter </filter-class> </filter> <filter-mapping> <filter-name>HiddenHttpMethodFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
2. 在controller里对应示例方法
@RequestMapping(value = "/testRest/{id}", method = RequestMethod.PUT) public String testRestPut(@PathVariable Integer id) { System.out.println("testRest Put: " + id); return "success"; } @RequestMapping(value = "/testRest/{id}", method = RequestMethod.DELETE) public String testRestDelete(@PathVariable Integer id) { System.out.println("testRest Delete: " + id); return "success"; } @RequestMapping(value = "/testRest", method = RequestMethod.POST) public String testRest() { System.out.println("testRest POST"); return "success"; } @RequestMapping(value = "/testRest/{id}", method = RequestMethod.GET) public String testRest(@PathVariable Integer id) { System.out.println("testRest GET: " + id); return "success"; }
3. jsp对应示例
<!-- Rest PUT--> <form action="springmvc/testRest/1" method="post"> <input type="hidden" name="_method" value="PUT"/> <input type="submit" value="TestRest PUT"/> </form> <!-- Rest DELETE--> <form action="springmvc/testRest/1" method="post"> <input type="hidden" name="_method" value="DELETE"/> <input type="submit" value="TestRest DELETE"/> </form> <!-- Rest POST--> <form action="springmvc/testRest" method="post"> <input type="submit" value="TestRest POST"/> </form> <!-- Rest Get --> <a href="springmvc/testRest/1">Test Rest Get</a>
九、请求处理方法签名
1. 简介
Spring MVC 通过分析处理方法的签名,将 HTTP 请求信息绑定到处理方法的相应人参中。
Spring MVC 对控制器处理方法签名的限制是很宽松的,几乎可以按喜欢的任何方式对方法进行签名。
必要时可以对方法及方法入参标注相应的注解(@PathVariable、@RequestParam、@RequestHeader 等)、SpringMVC 框架会将 HTTP 请求的信息绑定到相应的方法入参中,并根据方法的返回值类型做出相应的后续处理。
2. 使用 @RequestParam 绑定请求参数值
在处理方法入参处使用 @RequestParam 可以把请求参数传递给请求方法
– value:参数名
– required:是否必须。默认为 true, 表示请求参数中必须包含对应的参数,若不存在,将抛出异常
- defaultValue 请求参数的默认值
@RequestMapping(value = "/testRequestParam") public String testRequestParam( @RequestParam(value = "username") String un, @RequestParam(value = "age", required = false, defaultValue = "0") int age) { System.out.println("testRequestParam,username:" +un+ ",age:"+age); return "success"; }
3. 使用 @RequestHeader 绑定请求报头的属性值
请求头包含了若干个属性,服务器可据此获知客户端的信息,通过 @RequestHeader 即可将请求头中的属性值绑定到处理方法的入参中
@RequestMapping("/testRequestHeader") public String testRequestHeader( @RequestHeader(value = "Accept-Language") String al) { System.out.println("testRequestHeader, Accept-Language: " + al); return "success"; }
4. 使用 @CookieValue 绑定请求中的 Cookie 值
@CookieValue 可让处理方法入参绑定某个 Cookie 值
@RequestMapping("/testCookieValue") public String testCookieValue( @CookieValue("JSESSIONID") String sessionId) { System.out.println("testCookieValue: sessionId: " + sessionId); return "success"; }
5. 使用 POJO 对象绑定请求参数值
Spring MVC 会按请求参数名和 POJO 属性名进行自动匹配,自动为该对象填充属性值。支持级联属性。如:dept.deptId、dept.address.tel 等
@RequestMapping("/testPojo") public String testPojo(User user) { System.out.println("testPojo: " + user); return "success"; }
<form action="springmvc/testPojo" method="post"> username: <input type="text" name="username"/> <br> password: <input type="password" name="password"/> <br> email: <input type="text" name="email"/> <br> age: <input type="text" name="age"/> <br> city: <input type="text" name="address.city"/> <br> province: <input type="text" name="address.province"/> <br> <input type="submit" value="Submit"/> </form>
6. 使用 Servlet API 作为入参
MVC 的 Handler 方法可以接受 ServletAPI 类型的参数
HttpServletRequest
HttpServletResponse
HttpSession
java.security.Principal
Locale
InputStream
OutputStream
Reader
Writer
@RequestMapping("/testServletAPI") public void testServletAPI(HttpServletRequest request, HttpServletResponse response, Writer out) throws IOException { System.out.println("testServletAPI, " + request + ", " + response); out.write("hello springmvc"); }
十、 处理模型数据
Spring MVC 提供了以下几种途径输出模型数据:
1. ModelAndView:
处理方法返回值类型为 ModelAndView时, 方法体即可通过该对象添加模型数据,既包含视图信息,也包含模型数据信息。
添加模型数据:
– MoelAndView addObject(String attributeName, Object attributeValue) – ModelAndView addAllObject(Map<String, ?> modelMap)
设置视图:
– void setView(View view) – void setViewName(String viewName)
示例:
@RequestMapping("/testModelAndView") public ModelAndView testModelAndView(){ ModelAndView modelAndView = new ModelAndView("success"); //添加模型数据到 ModelAndView 中. modelAndView.addObject("time", new Date()); return modelAndView; }
2. Map 及 Model
入参为org.springframework.ui.Model、org.springframework.ui.ModelMap 或 java.uti.Map 时,处理方法返回时,Map中的数据会自动添加到模型中。
具体步骤
– Spring MVC 在调用方法前会创建一个隐含的模型对象作为模型数据的存储容器。
– 如果方法的入参为 Map 或 Model 类型,Spring MVC 会将隐含模型的引用传递给这些入参。在方法体内,开发者可以通过这个入参对象访问到模型中的所有数据,也可以向模型中添加新的属性数据
示例
@RequestMapping("/testMap") public String testMap(Map<String, Object> map){ User user = (User)map.get("user"); System.out.println(user.getName()); map.put("names", Arrays.asList("Tom", "Jerry", "Mike")); return "success"; }
3. @SessionAttributes
若希望在多个请求之间共用某个模型属性数据,则可以在控制器类上标注一个 @SessionAttributes, Spring MVC将在模型中对应的属性暂存到 HttpSession 中。
@SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外,还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中
– @SessionAttributes(types=User.class) 会将隐含模型中所有类型为 User.class 的属性添加到会话中。
– @SessionAttributes(value={“user1”, “user2”})
– @SessionAttributes(types={User.class, Dept.class})
– @SessionAttributes(value={“user1”, “user2”},types={Dept.class})
@SessionAttributes(value={"user"}, types={String.class}) @RequestMapping("/springmvc") @Controller public class HelloWorld { @RequestMapping("/testSessionAttributes") public String testSessionAttributes(Map<String, Object> map){ User user = new User("Tom", 15); map.put("user", user); map.put("name", "ziry"); return "success"; } }
4. @ModelAttribute
在方法定义上使用 @ModelAttribute 注解:Spring MVC在调用目标处理方法前,会先逐个调用在方法级上标注了@ModelAttribute 的方法。
在方法的入参前使用 @ModelAttribute 注解:
– 可以从隐含对象中获取隐含的模型数据中获取对象,再将请求参数绑定到对象中,再传入入参
– 将方法入参对象添加到模型中
@ModelAttribute public void getUser( @RequestParam(value="id",required=false)Integer id, Map<String , Object> map) { if(id != null) { User user = new User(1,"ziry","123",24); map.put("dbUser", user); } } @RequestMapping("/testModelAttribute") public String testModelAttribute(@ModelAttribute("dbUser")User user) { System.out.println(user); return "success"; }
由@SessionAttributes引发的异常
如果在处理类定义处标注了@SessionAttributes(“xxx”),则尝试从会话中获取该属性,并将其赋给该入参,然后再用请求消息填充该入参对象。如果在会话中找不到对应的属性,则抛出 HttpSessionRequiredException 异常
org.springframework.web.HttpSessionRequiredException:Session attribute 'user' required - not found in session
如何避免@SessionAttributes引发的异常
//该方法会往隐含模型中添加一个名为user的模型属性 @ModelAttribute("user") public User getUser(){ User user = new User(); return user; }
源码分析 SpringMVC 确定目标方法 POJO 类型入参的过程(看的吃力可以略过)
确定一个 key:
·若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写
·若使用了 @ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值.
在 implicitModel 中查找 key 对应的对象, 若存在, 则作为入参传入
· 若在 @ModelAttribute 标记的方法中在 Map 中保存过, 且 key 和 1 确定的 key 一致, 则会获取到.
若 implicitModel 中不存在 key 对应的对象, 则检查当前的 Handler 是否使用 @SessionAttributes 注解修饰, 若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了key, 则会从 HttpSession 中来获取 key 所对应的 value 值, 若存在则直接传入到目标方法的入参中. 若不存在则将抛出异常.
若 Handler 没有标识 @SessionAttributes 注解或 @SessionAttributes 注解的 value 值中不包含 key, 则会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数
SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中.
===Spring MVC 学习总结 一共 3 篇 分别为===
注意:本文归作者所有,未经作者允许,不得转载