持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第29天，点击查看活动详情
Spring MVC提供了以下几种途径输出模型数据：
- ModelAndView： 处理方法返回值类型为 ModelAndView时, 方法体即可通过该对象添加模型数据。
- Map及Model： 入参为org.springframework.ui.Model、org.springframework.ui.ModelMap 或 java.uti.Map时，处理方法返回时，Map中的数据会自动添加到模型中。
- @SessionAttributes： 将模型中的某个属性暂存到HttpSession 中，以便多个请求之间可以共享这个属性。
- @ModelAttribute： 方法入参标注该注解后，入参的对象就会放到数据模型中。
1 ModelAndView
控制器处理方法的返回值如果为ModelAndView，则其既包含视图信息，也包含模型数据信息。
添加模型数据:
-
MoelAndView addObject(String attributeName, Object attributeValue)
-
ModelAndView addAllObject(Map<String, ?> modelMap)
设置视图:
-
void setView(View view)
-
void setViewName(String viewName)
示例：
/**
* 目标方法的返回值可以是ModelAndView类型
* 其中可以包含视图和模型信息
* SpringMVC会把ModelAndView的model中数据放入到request域对象中
*
* @return ModelAndView
*/
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView() {
String viewName = "success";
ModelAndView modelAndView = new ModelAndView(viewName);
modelAndView.addObject("time", new Date());
return modelAndView;
}
在页面中通过requestScope获取值：
time:${requestScope.time}
2 Map及Model
Spring MVC 在内部使用了一个org.springframework.ui.Model 接口存储模型数据。
具体步骤：
– Spring MVC在调用方法前会创建一个隐含的模型对象作为模型数据的存储容器。
– 如果方法的入参为Map或Model类型，Spring MVC会将隐含模型的引用传递给这些入参。在方法体内，开发者可以通过这个入参对象访问到模型中的所有数据，也可以向模型中添加新的属性数据。
示例：
/**
* 目标方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数.
*
* @param map Map
* @return 目标页面
*/
@RequestMapping("/testMap")
public String testMap(Map<String, Object> map) {
map.put("names", Arrays.asList("zhangsan", "lisi", "王五"));
return "success";
}
${requestScope.names}
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 属性值),
* 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上使用的是 types 属性值)
* <p>
* 注意: 该注解只能放在类的上面. 而不能修饰放方法.
*/
@RequestMapping("/testSessionAttributes")
public String testSessionAttributes(Map<String, Object> map) {
map.put("user", new User("刘备", "123", 30, "liubei@qq.com"));
map.put("country", "蜀国");
return "success";
}
在类上添加@SessionAttributes注解：
@SessionAttributes(value = {"user"}, types = {String.class})
在页面中获取值：
<br/>
request user:${requestScope.user}
<br/>
session user:${sessionScope.user}
<br/>
request country:${requestScope.country}
<br/>
session country:${sessionScope.country}
4 @ModelAttribute
在方法定义上使用 @ModelAttribute 注解：Spring MVC 在调用目标处理方法前，会先逐个调用在方法级上标注了@ModelAttribute 的方法。
在方法的入参前使用@ModelAttribute注解：
-
可以从隐含对象中获取隐含的模型数据中获取对象，再将请求参数绑定到对象中，再传入入参。
-
将方法入参对象添加到模型中。
示例：
/**
* 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) {
if (id != null) {
//模拟从数据库中获取对象
User user = new User(1, "赵云", "12345", 36, "zhaoyun@gmail.com");
System.out.println("从数据库中取出User对象：" + user);
map.put("user", user);
}
}
/**
* 运行流程:
* 1. 执行 @ModelAttribute 注解修饰的方法: 从数据库中取出对象, 把对象放入到了 Map 中. 键为: user
* 2. SpringMVC 从 Map 中取出 User 对象, 并把表单的请求参数赋给该 User 对象的对应属性.
* 3. SpringMVC 把上述对象传入目标方法的参数.
* <p>
* 注意: 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致!
* <p>
* 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 中.
* <p>
* 源代码分析的流程
* 1. 调用 @ModelAttribute 注解修饰的方法. 实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中.
* 2. 解析请求处理器的目标参数, 实际上该目标参数来自于 WebDataBinder 对象的 target 属性
* 1). 创建 WebDataBinder 对象:
* ①. 确定 objectName 属性: 若传入的 attrName 属性值为 "", 则 objectName 为类名第一个字母小写.
* *注意: attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰, 则 attrName 值即为 @ModelAttribute
* 的 value 属性值
* <p>
* ②. 确定 target 属性:
* > 在 implicitModel 中查找 attrName 对应的属性值. 若存在, ok
* > *若不存在: 则验证当前 Handler 是否使用了 @SessionAttributes 进行修饰, 若使用了, 则尝试从 Session 中
* 获取 attrName 所对应的属性值. 若 session 中没有对应的属性值, 则抛出了异常.
* > 若 Handler 没有使用 @SessionAttributes 进行修饰, 或 @SessionAttributes 中没有使用 value 值指定的 key
* 和 attrName 相匹配, 则通过反射创建了 POJO 对象
* <p>
* 2). SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性.
* 3). *SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel.
* 近而传到 request 域对象中.
* 4). 把 WebDataBinder 的 target 作为参数传递给目标方法的入参.
*/
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user) {
System.out.println("testModelAttribute: 修改" + user);
return "success";
}
<form action="/springmvc/testModelAttribute">
<input type="hidden" name="id" value="1">
username:<input type="text" name="username" value="赵云">
<br/>
age:<input type="number" name="age" value="36">
<br/>
email:<input type="email" name="email" value="zhaoyun@gmail.com">
<br/>
<input type="submit" value="submit">
</form>
关注木水小站 (zhangmushui.cn)和微信公众号【木水Code】，及时获取更多最新技术干货。
