Spring MVC 提供了以下几种途径输出模型数据:
- ModelAndView:处理方法返回值类型为 ModelAndView时, 方法体即可通过该对象添加模型数据
- Map 及 Model:org.springframework.ui.Model、org.springframework.ui.ModelMap 或java.uti.Map 时,处理方法返回时,Map中的数据会自动添加到模型中
- @SessionAttributes:将模型中的某个属性暂存到HttpSession 中,以便多个请求之间可以共享这个属性
- @ModelAttribute:方法入参标注该注解后, 入参的对象就会放到数据模型中
处理模型之ModelAndView
目标方法的返回值可以是 ModelAndView 类型。 其中可以包含视图和模型信息
SpringMVC 会把 ModelAndView 的 model 中数据放入到 request 域对象中.
Controller
private static final String SUCCESS = "success";
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
String viewName = SUCCESS;
ModelAndView modelAndView = new ModelAndView(viewName);
//添加模型数据到 ModelAndView 中.
modelAndView.addObject("time", new Date());
return modelAndView;
}
jsp测试页面
<a href="testModelAndView">Test ModelAndView</a>
success.jsp
<h4>Sucess Page</h4>
time: ${requestScope.time }
处理模型之Map
目标方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数.
Controller
private static final String SUCCESS = "success";
@RequestMapping("/testMap")
public String testMap(Map<String, Object> map){
System.out.println(map.getClass().getName()); //BindingAwareModelMap类
map.put("names", Arrays.asList("Tom", "Jerry", "Mike"));
return SUCCESS;
}
jsp测试页面
<a href="testMap">Test Map</a>
success.jsp
names: ${requestScope.names }
@SessionAttributes
若希望在多个请求之间共用某个模型属性数据,则可以在控制器类上标注一个 @SessionAttributes, Spring MVC将在模型中对应的属性暂存到 HttpSession 中,同时也放在request域中。
@SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外(实际上使用的是 value 属性值), 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上使用的是 types 属性值)
位置:只能放在类上
User.java
public class User {
private String username;
private String password;
private String email;
private int age;
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;
}
@Override
public String toString() {
return "User ["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() {}
}
Controller
@SessionAttributes(value={"user"}, types={String.class})
public class Test{
private static final String SUCCESS = "success";
@RequestMapping("/testSessionAttributes")
public String testSessionAttributes(Map<String, Object> map){
User user = new User("Tom", "123456", "tom@111.com", 15);
map.put("user", user);
map.put("school", "zsdx");
return SUCCESS;
}
}
jsp测试页面
<a href="testSessionAttributes">Test SessionAttributes</a>
success.jsp
request user: ${requestScope.user }
<br><br>
session user: ${sessionScope.user }
<br><br>
request school: ${requestScope.school }
<br><br>
session school: ${sessionScope.school }
<br><br>
@ModelAttribute
位置:方法上、参数前
使用场景:
假如一个User对象有3个属性值,分别是ID、name、sex,在表单进行修改提交的时候,要求只能修改name和sex,ID不能被修改,这样就会造成new出来存放表单内容的User对象的ID属性值为空,存储进数据库会造成User对象ID值为空
第一个解决方法是使用隐藏域,使用隐藏域有两个致命的缺点,第一:要求不能被修改的属性值为password时,安全性堪忧,第二:当不能修改的属性值非常多时,会非常麻烦
第二个解决方法是使用数据库赋值,在new出新对象存表单值后,再从数据库取出要求不能被修改的值赋上空属性值,这样做也很麻烦
SpringMVC提供了一个方法
在表单对对象属性值赋值之前,不用创建新对象,即不用new对象,而是从数据库获取出一个对象。简单来说就是下图:
模拟场景如下:
要求:
- 原始数据为: 1, Tom, 123456,tom@111.com,12
- 密码不能被修改
- 表单回显, 模拟操作直接在表单填写对应的属性值
User.java
public class User {
private Integer id;
private String username;
private String password;
private String email;
private int age;
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;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", password="
+ password + ", email=" + email + ", 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() {}
}
Controller
private static final String SUCCESS = "success";
@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);
}
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user){ //入参类型
System.out.println("修改: " + user);
return SUCCESS;
}
jsp测试页面
<form action="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@111.com"/>
<br>
age: <input type="text" name="age" value="12"/>
<br>
<input type="submit" value="Submit"/>
</form>
运行流程:
- 执行 @ModelAttribute 注解修饰的方法: 从数据库中取出对象, 把对象放入到了 Map 中. 键为: user
- SpringMVC 从 Map 中取出 User 对象, 并把表单的请求参数赋给该 User 对象的对应属性
- SpringMVC 把上述对象传入目标方法的参数.
=========================================================================
注意: 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致!
注意: 有 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用!
=========================================================================
@ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参, 其 value 属性值有如下的作用:
- SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象, 若存在则会直接传入到目标方法的入参中
- SpringMVC 会以value 为 key, POJO 类型的对象为 value, 存入到 request 域中
=========================================================================
在上面的注意点有说到, 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致(以下代码解释)
private static final String SUCCESS = "success";
@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);//===双引号中的user要和下面的入参类型的第一个字母小写的字符串一种
}
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user){ //===入参类型
System.out.println("修改: " + user);
return SUCCESS;
}
如果不一致则不能完成入参,那么我就喜欢他不一致~~有什么解决方法吗?答案是有的
这个时候我们就要用@ModelAttribute的value属性值来修饰入参类型
private static final String SUCCESS = "success";
@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("aaa", user);
}
@RequestMapping("/testModelAttribute")
public String testModelAttribute(@ModelAttribute("aaa")User user){
System.out.println("修改: " + user);
return SUCCESS;
}
本质上就是要key一样才能完成入参,默认情况下目标方法放入request域中的key就是入参类型第一个字母小写的字符串,那么@ModelAttribute修饰的方法放进Map里的key就要和目标方法的放入request域中的key一样,如果不想一样那就用@ModelAttribute的value属性去修改目标方法入参类型的key
@SessionAttribute引发的异常
这里我们要了解一下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 中
第三点可以看出,如果没有@ModelAttribute修饰的方法,那么implicitModel 中将不存在 key 对应的对象,SpringMVC会检查Handler是否使用@SessionAttribute注解修饰,且 @SessionAttributes 注解的 value 属性值中包含的 key和目标方法标记的入参类型的key一致,那么就会强制到Session里面去找,找不到则抛出异常。
要解决这个异常,有两个方法,(不常用)第一种方法是在目标方法的入参类型使用@ModelAttribute修改入参类型的key,使其与@SessionAttribute注解的value值不一样,如下
@SessionAttributes(value={"user"}, types={String.class})
public class Test{
private static final String SUCCESS = "success";
@RequestMapping("/testModelAttribute")
public String testModelAttribute(@ModelAttribute("aaa") User user){
System.out.println("修改: " + user);
return SUCCESS;
}
}
(推荐)第二种方法是加上带有@ModelAttribute注解修饰的方法
@ModelAttribute
public void getUser(@RequestParam(value="id",required=false) Integer id,
Map<String, Object> map){
if(id != null){
//模拟从数据库中获取对象
User user = new User(1, "Tom", "123456", "tom@111.com", 12);
System.out.println("从数据库中获取一个对象: " + user);
map.put("user", user);
}
}