Spring MVC (二)
一、使用 @RequestMapping 映射请求
Spring MVC使用@RequestMapping注解为控制器指定可以处理哪些URL请求
在控制器的类定义以及方法定义处都可以标注
类定义处:提供初步的请求映射信息。相对于Web应用的根目录
方法处:提供进一步的细分映射信息。相对于类定义处的URL。若类定义处未标注@RequestMapping,则方法处标记的URL是相对于Web应用的根目录的。
DispatcherServlet截获请求后,九通过控制器上@RequestMapping提供的映射信息确定请求所对应的处理方法
private static final String SUCCESS = "success";
/** * 1. @RequestMapping 除了修饰方法, 还可来修饰类 2. 1). 类定义处: 提供初步的请求映射信息。相对于 WEB 应用的根目录 * 2). 方法处: 提供进一步的细分映射信息。 相对于类定义处的 URL。若类定义处未标注 @RequestMapping,则方法处标记的 URL * 相对于 WEB 应用的根目录 */ @RequestMapping("/testRequestMapping") public String testRequestMapping() { System.out.println("testRequestMapping"); return SUCCESS; }
不但可以根据URL映射,还可以根据请求参数、请求方法或请求头映射
HTTP请求报头:
@RequestMapping除了可以使用请求URL映射请求外,还可以使用请求方法、请求参数及请求头映射请求
@RequestMapping的value、method、params及heads分别表示请求URL、请求方法、请求参数及请求头的映射条件,它们之间是与的关系,联合使用多个条件可让请求映射更加精确化。
method
/** * 常用: 使用 method 属性来指定请求方式 */ @RequestMapping(value = "/testMethod", method = RequestMethod.POST) public String testMethod() { System.out.println("testMethod"); return SUCCESS; }
params和headers
params和headers支持简单的表达式:
/** * 了解: 可以使用 params 和 headers 来更加精确的映射请求. params 和 headers 支持简单的表达式. * * @return */ @RequestMapping(value = "testParamsAndHeaders", params = { "username", "age!=10" }, headers = { "Accept-Language=en-US,zh;q=0.8" }) public String testParamsAndHeaders() { System.out.println("testParamsAndHeaders"); return SUCCESS; }
支持匹配符,但要使用Ant风格
Ant风格资源地址支持3种匹配符:
- ? 匹配文件名中的一个字符
- * 匹配文件名中的任意字符
- ** 匹配多层路径
还支持Ant风格的URL:
通过@PathVariable可以将URL中占位符参数绑定到控制器处理方法的入参中,URL中的{xxx}占位符,如下例中的{id}可以通过@PathVariable("xxx")绑定到操作方法的入参中。
/** * @PathVariable 可以来映射 URL 中的占位符到目标方法的参数中. * @param id * @return */ @RequestMapping("/testPathVariable/{id}") public String testPathVariable(@PathVariable("id") Integer id) { System.out.println("testPathVariable: " + id); return SUCCESS; } @RequestMapping("/testAntPath/*/abc") public String testAntPath() { System.out.println("testAntPath"); return SUCCESS; }
Rest
配置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>
<form action="springmvc/testRest/1" method="post"> <input type="hidden" name="_method" value="PUT"/> <input type="submit" value="TestRest PUT"/> </form> <br><br> <form action="springmvc/testRest/1" method="post"> <input type="hidden" name="_method" value="DELETE"/> <input type="submit" value="TestRest DELETE"/> </form> <br><br> <form action="springmvc/testRest" method="post"> <input type="submit" value="TestRest POST"/> </form> <a href="springmvc/testRest/1">Test Rest Get</a> <br><br>
/** * Rest 风格的 URL. 以 CRUD 为例:
新增: /order POST
修改: /order/1 PUT update?id=1
获取: /order/1 GET get?id=1
删除: /order/1 DELETE delete?id=1 * * 如何发送 PUT 请求和 DELETE 请求呢 ?
1. 需要配置 HiddenHttpMethodFilter
2. 需要发送 POST 请求 * 3. 需要在发送 POST 请求时携带一个 name="_method" 的隐藏域, 值为 DELETE 或 PUT * * 在 SpringMVC 的目标方法中如何得到 id 呢? 使用 @PathVariable 注解 * */ @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; }
绑定请求参数值
在处理方法入参处使用 @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; }
使用 @RequestHeader 绑定请求报头的属性值
请求头包含了若干个属性,服务器可据此获知客户端的信息,通过 @RequestHeader 即可将请求头中的属性值绑定到处理方法的入参中
/** * 了解: 映射请求头信息 用法同 @RequestParam */ @RequestMapping("/testRequestHeader") public String testRequestHeader( @RequestHeader(value = "Accept-Language") String al) { System.out.println("testRequestHeader, Accept-Language: " + al); return SUCCESS; }
@CookieValue 可让处理方法入参绑定某个 Cookie 值
/** * 了解: * * @CookieValue: 映射一个 Cookie 值. 属性同 @RequestParam */ @RequestMapping("/testCookieValue") public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) { System.out.println("testCookieValue: sessionId: " + sessionId); return SUCCESS; }
使用 POJO 对象绑定请求参数值
Spring MVC 会按请求参数名和 POJO 属性名进行自动匹配,自动为该对象填充属性值。支持级联属性。如:dept.deptId、dept.address.tel 等
<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> <br><br>
public class User { private Integer id; private String username; private String password; private String email; private int age; private Address address; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public Address getAddress() { return address; } public void setAddress(Address address) { this.address = address; } // @Override // public String toString() { // return "User [username=" + username + ", password=" + password // + ", email=" + email + ", age=" + age + ", address=" + address // + "]"; // } @Override public String toString() { return "User [id=" + id + ", username=" + username + ", password=" + password + ", email=" + email + ", age=" + age + "]"; } public User(String username, String password, String email, int age) { super(); this.username = username; this.password = password; this.email = email; this.age = age; } public User(Integer id, String username, String password, String email, int age) { super(); this.id = id; this.username = username; this.password = password; this.email = email; this.age = age; } public User() {} }
public class Address { private String province; private String city; public String getProvince() { return province; } public void setProvince(String province) { this.province = province; } public String getCity() { return city; } public void setCity(String city) { this.city = city; } @Override public String toString() { return "Address [province=" + province + ", city=" + city + "]"; } }
/** * Spring MVC 会按请求参数名和 POJO 属性名进行自动匹配, 自动为该对象填充属性值。支持级联属性。 * 如:dept.deptId、dept.address.tel 等 */ @RequestMapping("/testPojo") public String testPojo(User user) { System.out.println("testPojo: " + user); return SUCCESS; }
可以使用Servlet的原生API
<a href="springmvc/testServletAPI">Test ServletAPI</a>
/** * 可以使用 Serlvet 原生的 API 作为目标方法的参数 具体支持以下类型 * * HttpServletRequest * HttpServletResponse * HttpSession * java.security.Principal * Locale InputStream * OutputStream * Reader * Writer * @throws IOException */ @RequestMapping("/testServletAPI") public void testServletAPI(HttpServletRequest request, HttpServletResponse response, Writer out) throws IOException { System.out.println("testServletAPI, " + request + ", " + response); out.write("hello springmvc"); // return SUCCESS; }
二、处理模型数据
Spring MVC提供了以下几种途径输出模型数据:
- ModelAndView:处理方法返回值类型为 ModelAndView 时, 方法体即可通过该对象添加模型数据
- Map及Model:入参为org.springframework.ui.Model、org.springframework.ui.ModelMap 或 java.uti.Map 时,处理方法返回时,Map 中的数据会自动添加到模型中。
- @SessionAttributes: 将模型中的某个属性暂存到HttpSession 中,以便多个请求之间可以共享这个属性。
- @ModelAttribute: 方法入参标注该注解后, 入参的对象就会放到数据模型中。
ModelAndView
控制器处理方法的返回值如果为 ModelAndView, 则其既包含视图信息,也包含模型数据信息。
添加模型数据:
- MoelAndView addObject(String attributeName, Object attributeValue)
- ModelAndView addAllObject(Map<String, ?> modelMap )
设置视图:
- void setView(View view)
- void setViewName(String viewName)
<a href="springmvc/testModelAndView">Test ModelAndView</a>
<%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %> <!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=UTF-8"> <title>Insert title here</title> </head> <body> <h4>Sucess Page</h4> time: ${requestScope.time } <br><br> </body> </html>
/** * 目标方法的返回值可以是 ModelAndView 类型。 * 其中可以包含视图和模型信息 * SpringMVC 会把 ModelAndView 的 model 中数据放入到 request 域对象中. * @return */ @RequestMapping("/testModelAndView") public ModelAndView testModelAndView(){ String viewName = SUCCESS; ModelAndView modelAndView = new ModelAndView(viewName); //添加模型数据到 ModelAndView 中. modelAndView.addObject("time", new Date()); return modelAndView; }
或
ModelAndView modelAndView = new ModelAndView(); modelAndView.setViewName(view); modelAndView.addObject("time", new Date()); return modelAndView;
Map 及 Model
Spring MVC 在内部使用了一个 org.springframework.ui.Model 接口存储模型数据
具体步骤:
- Spring MVC 在调用方法前会创建一个隐含的模型对象作为模型数据的存储容器。
- 如果方法的入参为 Map 或 Model 类型,Spring MVC 会将隐含模型的引用传递给这些入参。在方法体内,开发者可以通过这个入参对象访问到模型中的所有数据,也可以向模型中添加新的属性数据。
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %> <!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=UTF-8"> <title>Insert title here</title> </head> <body> <h4>Sucess Page</h4> time: ${requestScope.time } <br><br> names: ${requestScope.names } <br><br> </body> </html>
/** * 目标方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数. * @param map * @return */ @RequestMapping("/testMap") public String testMap(Map<String, Object> map){ System.out.println(map.getClass().getName()); map.put("names", Arrays.asList("Tom", "Jerry", "Mike")); return SUCCESS; }
上面是在Request中添加了数据,如果想在Session中添加,需要 @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})
request user: ${requestScope.user } <br><br> session user: ${sessionScope.user } <br><br> request school: ${requestScope.school } <br><br> session school: ${sessionScope.school } <br><br>
@SessionAttributes(value={"user"}, types={String.class}) @RequestMapping("/springmvc") @Controller public class SpringMVCTest { private static final String SUCCESS = "success"; /** * @SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外(实际上使用的是 value 属性值), * 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上使用的是 types 属性值) * * 注意: 该注解只能放在类的上面. 而不能修饰放方法. */ @RequestMapping("/testSessionAttributes") public String testSessionAttributes(Map<String, Object> map){ User user = new User("Tom", "123456", "tom@atguigu.com", 15); map.put("user", user); map.put("school", "atguigu"); return SUCCESS; } }
结果:
在方法定义上使用 @ModelAttribute 注解:Spring MVC在调用目标处理方法前,会先逐个调用在方法级上标注了@ModelAttribute 的方法。
在方法的入参前使用 @ModelAttribute 注解:
- 可以从隐含对象中获取隐含的模型数据中获取对象,再将请求参数绑定到对象中,再传入入参
- 将方法入参对象添加到模型中
<!-- 模拟修改操作 1. 原始数据为: 1, Tom, 123456,tom@atguigu.com,12 2. 密码不能被修改. 3. 表单回显, 模拟操作直接在表单填写对应的属性值 --> <form action="springmvc/testModelAttribute" method="Post"> <input type="hidden" name="id" value="1"/> username: <input type="text" name="username" value="Tom"/> <br> email: <input type="text" name="email" value="tom@atguigu.com"/> <br> age: <input type="text" name="age" value="12"/> <br> <input type="submit" value="Submit"/> </form> <br><br>
密码不能被修改,于是不为密码赋值,如上面没有密码的项,则此时处理方法接收到user的密码是空的
@RequestMapping("/testModelAttribute") public String testModelAttribute(User user){ System.out.println("修改: " + user); return SUCCESS; }
显然,我们想要的是密码保持原来的密码,而不是空
一种方法是从数据库获得密码,再赋给上面的user,麻烦
另一种方法是先从数据库获得原来的user,只修改需要修改的属性:
使用@ModelAttribute:
@RequestMapping("/testModelAttribute") public String testModelAttribute(User user) { System.out.println("修改: " + user); return SUCCESS; } /** * 1. 有 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用! * 2. @ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参, 其 value 属性值有如下的作用: * 1). SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象, 若存在则会直接传入到目标方法的入参中. * 2). SpringMVC 会以 value 为 key, POJO 类型的对象为 value, 存入到 request 中. */ @ModelAttribute public void getUser(@RequestParam(value = "id", required = false) Integer id, Map<String, Object> map) { System.out.println("modelAttribute method"); if (id != null) { // 模拟从数据库中获取对象 User user = new User(1, "Tom", "123456", "tom@atguigu.com", 12); System.out.println("从数据库中获取一个对象: " + user); map.put("user", user); } }
结果:
@ModelAttribute标注后,该方法会在所有方法之前被调用,因此,此时的user是从数据库(这里是模拟,只是新建了对象)取到的,age=12,有password
然后,提交修改的表格后还是会调用 testModelAttribute 方法,只是此时的user是有注解的 getUser 方法中的user,在此user基础上上进行修改,而该user是有password的
于是,我们可以分析下流程:
1. 执行 @ModelAttribute 注解修饰的方法:从数据库中取出对象,把对象放入到了 Map 中, 键为: user,
map.put("user", user);
2. SpringMVC 从 Map 中取出 User 对象,并把表单的请求参数赋给该 User 对象的对应属性。这个过程没有在我们编写的代码中体现,是SpringMVC自动为我们做的。
3. SpringMVC 把上述对象传入目标方法的参数。
public String testModelAttribute(User user)
注意: 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致!
如果不一致,可以使用@ModelAttribute 注解来修饰目标方法 POJO 类型的入参, 其 value 属性值设为map中的键名
@RequestMapping("/testModelAttribute") public String testModelAttribute(@ModelAttribute("abc") User user) { System.out.println("修改: " + user); return SUCCESS; } /** * 1. 有 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用! * 2. @ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参, 其 value 属性值有如下的作用: * 1). SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象, 若存在则会直接传入到目标方法的入参中. * 2). SpringMVC 会一 value 为 key, POJO 类型的对象为 value, 存入到 request 中. */ @ModelAttribute public void getUser(@RequestParam(value = "id", required = false) Integer id, Map<String, Object> map) { System.out.println("modelAttribute method"); if (id != null) { // 模拟从数据库中获取对象 User user = new User(1, "Tom", "123456", "tom@atguigu.com", 12); System.out.println("从数据库中获取一个对象: " + user); map.put("abc", user); } }
* SpringMVC 确定目标方法 POJO 类型入参的过程
* 1. 确定一个 key:
* 1). 若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写
* 2). 若使用了 @ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值.
* 2. 在 implicitModel 中查找 key 对应的对象, 若存在, 则作为入参传入
* 1). 若在 @ModelAttribute 标记的方法中在 Map 中保存过, 且 key 和 1 确定的 key 一致, 则会获取到.
* 3. 若 implicitModel 中不存在 key 对应的对象, 则检查当前的 Handler 是否使用 @SessionAttributes 注解修饰,
* 若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了 key, 则会从 HttpSession 中来获取 key 所
* 对应的 value 值, 若存在则直接传入到目标方法的入参中. 若不存在则将抛出异常.
* 4. 若 Handler 没有标识 @SessionAttributes 注解或 @SessionAttributes 注解的 value 值中不包含 key, 则
* 会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数
* 5. SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中.
*
* 源代码分析的流程
* 1. 调用 @ModelAttribute 注解修饰的方法. 实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中.
* 2. 解析请求处理器的目标参数, 实际上该目标参数来自于 WebDataBinder 对象的 target 属性
* 1). 创建 WebDataBinder 对象:
* ①. 确定 objectName 属性: 若传入的 attrName 属性值为 "", 则 objectName 为类名第一个字母小写.
* *注意: attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰, 则 attrName 值即为 @ModelAttribute
* 的 value 属性值
*
* ②. 确定 target 属性:
* > 在 implicitModel 中查找 attrName 对应的属性值. 若存在, ok
* > *若不存在: 则验证当前 Handler 是否使用了 @SessionAttributes 进行修饰, 若使用了, 则尝试从 Session 中
* 获取 attrName 所对应的属性值. 若 session 中没有对应的属性值, 则抛出了异常.
* > 若 Handler 没有使用 @SessionAttributes 进行修饰, 或 @SessionAttributes 中没有使用 value 值指定的 key
* 和 attrName 相匹配, 则通过反射创建了 POJO 对象
*
* 2). SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性.
* 3). SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel.
* 进而传到 request 域对象中.
* 4). 把 WebDataBinder 的 target 作为参数传递给目标方法的入参.
*/
注意上面标黄部分@SessionAttributes 引起异常
三、视图和视图解析器
SpringMVC解析视图
请求处理方法执行完成后,最终返回一个 ModelAndView对象。对于那些返回 String,View 或 ModeMap 等类型的
处理方法,Spring MVC 也会在内部将它们装配成一个ModelAndView 对象,它包含了逻辑名和模型对象的视图
Spring MVC 借助视图解析器(ViewResolver)得到最终的视图对象(View),最终的视图可以是 JSP ,也可能是Excel、JFreeChart 等各种表现形式的视图
对于最终究竟采取何种视图对象对模型数据进行渲染,处理器并不关心,处理器工作重点聚焦在生产模型数据的工作上,从而实现 MVC 的充分解耦
视图
视图的作用是渲染模型数据,将模型里的数据以某种形式呈现给客户。
为了实现视图模型和具体实现技术的解耦,Spring 在org.springframework.web.servlet 包中定义了一个高度抽象的 View接口:
视图对象由视图解析器负责实例化。由于视图是无状态的,所以他们不会有线程安全的问题
常用的视图实现类
视图解析器
SpringMVC 为逻辑视图名的解析提供了不同的策略,可以在 Spring WEB 上下文中配置一种或多种解析策略,并指定他们之间的先后顺序。每一种映射策略对应一个具体的视图解析器实现类。
视图解析器的作用比较单一:将逻辑视图解析为一个具体的视图对象。
所有的视图解析器都必须实现 ViewResolver 接口:
常用的视图解析器实现类
程序员可以选择一种视图解析器或混用多种视图解析器每个视图解析器都实现了 Ordered 接口并开放出一个 order 属性,可以通过 order 属性指定解析器的优先顺序,order 越小优先级越高。
SpringMVC 会按视图解析器顺序的优先顺序对逻辑视图名进行解析,直到解析成功并返回视图对象,否则将抛出 ServletException 异常
InternalResourceViewResolver
JSP 是最常见的视图技术,可以使用InternalResourceViewResolver 作为视图解析器:
若项目中使用了 JSTL,则 SpringMVC 会自动把视图由InternalResourceView 转为 JstlView。若使用 JSTL 的 fmt 标签则需要在 SpringMVC 的配置文件中配置国际化资源文件。
若希望直接响应通过 SpringMVC 渲染的页面,可以使用 mvc:view-controller 标签实现
重定向
一般情况下,控制器方法返回字符串类型的值会被当成逻辑视图名处理,如果返回的字符串中带 forward: 或 redirect: 前缀时,SpringMVC 会对他们进行特殊处理:将 forward: 和redirect: 当成指示符,其后的字符串作为 URL 来处理
- redirect:success.jsp:会完成一个到 success.jsp 的重定向的操作
- forward:success.jsp:会完成一个到 success.jsp 的转发操作
@RequestMapping("/testRedirect") public String testRedirect(){ System.out.println("testRedirect"); return "redirect:/index.jsp"; }