参数绑定（11）
前记：这是很早之前自学学习spingMvc时的笔记，内容比较基础，适合新手，内容基本是来自网络，如有雷同，敬请谅解！
参数绑定
参数绑定过程
从客户端请求key/value数据，即url中”?”后面的参数，经过参数绑定，将key/value绑定到controller方法的形参上。
也就是说，在springMvc中，接收页面提交的数据是通过方法形参来接收，而不是在controller类中定义成员变量来接收。
默认支持的类型参数绑定
默认支持的类型：
直接在controller方法形参上定义下面的类型的对象，就可以使用这些对象。在参数绑定的过程中，适配器如果遇到下面的类型，那么将直接进行绑定。
1. HttpServletRequest
2. HttpServletResponse
3. HttpSession
4. Model/ModelMap：
Model是一个接口，ModelMap是一个接口实现。作用就是要将模型数据填充的Request域。
简单类型参数绑定
可以通过@RequestParam注解来对简单类型的参数进行绑定。
如果不使用@RequestParam注解则要求request传入的参数的名称和controller方法的形参名称一致，方可绑定成功。
如果使用@RequestParam注解则不用要求request传入的参数的名称和controller方法的形参名称一致.
1. @RequestParam中的value属性值是request传入的形参名
2. @RequestParam中的required属性指定此参数是否必须传入，
true--必须传入，
false--不是必须传入。
3. @RequestParam中的defalutValue属性可以设置默认值。会将默认值与形参绑定。
Pojo的绑定
页面中的input的属性name值与controller的pojo形参中的属性名称一致。
这样就可以将页面的数据绑定到controller的pojo形参中。
它与简单类型的绑定互不影响
自定义参数绑定
举例：自定义日期格式进行参数绑定
自定义转换器Converter
实现Converter接口
publicclass CustomDateConverterimplements Converter<String,Date> {
@Override
public Date convert(String source) {
try {
SimpleDateFormat simpleDateFormat = newSimpleDateFormat("yyyy-MM-dd HH:mm:ss");
return simpleDateFormat.parse(source);
} catch (Exception e) {
e.printStackTrace();
}
returnnull;
}
}
配置方式1
<mvc:annotation-drivenconversion-service="conversionService">
</mvc:annotation-driven>
<!--conversionService -->
<beanid="conversionService" class=“org.springframework.format.support.FormattingConversionServiceFactoryBean”
<!-- 转换器 -->
<property name="converters">
<list>
<beanclass="cn.itcast.ssm.controller.converter.CustomDateConverter"/>
</list>
</property>
</bean>
配置方式2
<!--注解适配器 -->
<bean
class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
<propertyname="webBindingInitializer"ref="customBinder"></property>
</bean>
<!--自定义webBinder -->
<beanid="customBinder"class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">
<property name="conversionService"ref="conversionService"/>
</bean>
<!--conversionService -->
<beanid="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean">
<!-- 转换器 -->
<property name="converters">
<list>
<beanclass="cn.itcast.ssm.controller.converter.CustomDateConverter"/>
</list>
</property>
</bean>
集合类
字符串数组
页面定义如下：
页面选中多个checkbox向controller方法传递
<inputtype="checkbox" name="item_id" value="001"/>
<inputtype="checkbox" name="item_id" value="002"/>
<inputtype="checkbox" name="item_id" value="002"/>
传递到controller方法中的格式是：001,002,003
Controller方法中可以用String[]接收，定义如下：
public String deleteitem(String[]item_id)throws Exception{
System.out.println(item_id);
｝
List
List中存放对象，并将定义的List放在包装类中，action使用包装对象接收。
List中对象：
成绩对象
Public class QueryVo{
PrivateList<Items> itemList//商品列表
//get/set方法..
}
包装类中定义List对象，并添加get/set方法如下：
页面定义如下：
<tr>
<td>
<inputtype="text" name=" itemsList[0].id" value="${item.id}"/>
</td>
<input type="text" name=" itemsList[0].name" value="${item.name }"/>
</td>
<td>
<inputtype="text" name=" itemsList[0].price" value="${item.price}"/>
</td>
</tr>
<tr>
<td>
<inputtype="text" name=" itemsList[1].id" value="${item.id}"/>
</td>
<td>
<inputtype="text" name=" itemsList[1].name" value="${item.name }"/>
</td>
<td>
<inputtype="text" name=" itemsList[1].price" value="${item.price}"/>
</td>
</tr>
上边的静态代码改为动态jsp代码如下：
<c:forEachitems="${itemsList }"var="item"varStatus="s">
<tr>
<td><inputtype="text"name="itemsList[${s.index}].name"value="${item.name }"/></td>
<td><inputtype="text"name="itemsList[${s.index}].price"value="${item.price }"/></td>
.....
.....
</tr>
</c:forEach>
Contrller方法定义如下：
public String useraddsubmit(Modelmodel,QueryVo queryVo)throwsException{
System.out.println(queryVo.getItemList());
}
Map
在包装类中定义Map对象，并添加get/set方法，action使用包装对象接收。
包装类中定义Map对象如下：
Public class QueryVo {
private Map<String, Object> itemInfo new HashMap<String, Object>();
//get/set方法..
}
页面定义如下：
<tr>
<td>学生信息：</td>
<td>
姓名：<inputtype="text"name="itemInfo['name']"/>
年龄：<inputtype="text"name="itemInfo['price']"/>
.. .. ..
</td>
</tr>
Contrller方法定义如下：
public String useraddsubmit(Modelmodel,QueryVo queryVo throws Exception{
System.out.println(queryVo.getStudentinfo());
}
数据绑定的其他注解
@PathVariable绑定URI模板变量值
@RequestMapping(value="/users/{userId}/topics/{topicId}")
public Stringtest(
@PathVariable(value="userId")int userId,
@PathVariable(value="topicId")int topicId)
如上例中，请求的URL为“控制器URL/users/123/topics/456”，则自动将URL中模板变量{userId}和{topicId}绑定到通过@PathVariable注解的同名参数上，即入参后userId=123、topicId=456。
@CookieValue绑定Cookie数据值
@CookieValue用于将请求的Cookie数据映射到功能处理方法的参数上。
public Stringtest(@CookieValue(value="JSESSIONID", defaultValue="")String sessionId);
如上配置将自动将JSESSIONID值入参到sessionId参数上，defaultValue表示Cookie中没有JSESSIONID时默认为空。
public Stringtest2(@CookieValue(value="JSESSIONID", defaultValue="")Cookie sessionId) ;
传入参数类型也可以是javax.servlet.http.Cookie类型。
@CookieValue也拥有和@RequestParam相同的三个参数，含义一样。
@RequestHeader绑定请求头数据
@RequestHeader用于将请求的头信息区数据映射到功能处理方法的参数上。
[java] view plain copy
@RequestMapping(value="/header")
public String test(
@RequestHeader("User-Agent")String userAgent,
@RequestHeader(value="Accept") String[] accepts)
如上配置将自动将请求头“User-Agent”值入参到userAgent参数上，并将“Accept”请求头值入参到accepts参数上。
@RequestHeader也拥有和@RequestParam相同的三个参数，含义一样。
@ModelAttribute绑定请求参数到命令对象
@ModelAttribute一个具有如下三个作用：
①绑定请求参数到命令对象：放在功能处理方法的入参上时，用于将多个请求参数绑定到一个命令对象，从而简化绑定流程，而且自动暴露为模型数据用于视图页面展示时使用；
②暴露表单引用对象为模型数据：放在处理器的一般方法（非功能处理方法）上时，是为表单准备要展示的表单引用对象，如注册时需要选择的所在城市等，而且在执行功能处理方法（@RequestMapping注解的方法）之前，自动添加到模型对象中，用于视图页面展示时使用；
③暴露@RequestMapping方法返回值为模型数据：放在功能处理方法的返回值上时，是暴露功能处理方法的返回值为模型数据，用于视图页面展示时使用。
一、绑定请求参数到命令对象
如用户登录，我们需要捕获用户登录的请求参数（用户名、密码）并封装为用户对象，此时我们可以使用@ModelAttribute绑定多个请求参数到我们的命令对象。
[java] view plain copy
public Stringtest1(@ModelAttribute("user") UserModel user)
此处多了一个注解@ModelAttribute("user")，它的作用是将该绑定的命令对象以“user”为名称添加到模型对象中供视图页面展示使用。我们此时可以在视图页面使用${user.username}来获取绑定的命令对象的属性。
绑定请求参数到命令对象支持对象图导航式的绑定，如请求参数包含“?username=zhang&password=123&workInfo.city=bj”自动绑定到user中的workInfo属性的city属性中。
[java] view plain copy
@RequestMapping(value="/model2/{username}")
public Stringtest2(@ModelAttribute("model") DataBinderTestModel model) {包含“bool=yes&schooInfo.specialty=computer&hobbyList[0]=program&hobbyList[1]=music&map[key1]=value1&map[key2]=value2&state=blocked”会自动绑定到命令对象上。
当URI模板变量和请求参数同名时，URI模板变量具有高优先权。
二、暴露表单引用对象为模型数据
[java] view plain copy
@ModelAttribute("cityList")
public List<String> cityList() {
return Arrays.asList("北京", "山东");
}
如上代码会在执行功能处理方法之前执行，并将其自动添加到模型对象中，在功能处理方法中调用Model 入参的containsAttribute("cityList")将会返回true。
[java] view plain copy
@ModelAttribute("user") //①
public UserModelgetUser(@RequestParam(value="username", defaultValue="")String username) {
//去数据库根据用户名查找用户对象
UserModel user = new UserModel();
user.setRealname("zhang");
return user;
}
如你要修改用户资料时一般需要根据用户的编号/用户名查找用户来进行编辑，此时可以通过如上代码查找要编辑的用户。
也可以进行一些默认值的处理。
[java] view plain copy
@RequestMapping(value="/model1")//②
public Stringtest1(@ModelAttribute("user") UserModel user, Model model)
此处我们看到①和②有同名的命令对象，那Spring Web MVC内部如何处理的呢：
(1、首先执行@ModelAttribute注解的方法，准备视图展示时所需要的模型数据；@ModelAttribute注解方法形式参数规则和@RequestMapping规则一样，如可以有@RequestParam等；
（2、执行@RequestMapping注解方法，进行模型绑定时首先查找模型数据中是否含有同名对象，如果有直接使用，如果没有通过反射创建一个，因此②处的user将使用①处返回的命令对象。即②处的user等于①处的user。
三、暴露@RequestMapping方法返回值为模型数据
[java] view plain copy
public @ModelAttribute("user2")UserModel test3(@ModelAttribute("user2") UserModel user)
大家可以看到返回值类型是命令对象类型，而且通过@ModelAttribute("user2")注解，此时会暴露返回值到模型数据（名字为user2）中供视图展示使用。那哪个视图应该展示呢？此时Spring Web MVC会根据RequestToViewNameTranslator进行逻辑视图名的翻译
此时又有问题了，@RequestMapping注解方法的入参user暴露到模型数据中的名字也是user2，其实我们能猜到：
@ModelAttribute注解的返回值会覆盖@RequestMapping注解方法中的@ModelAttribute注解的同名命令对象。
四、匿名绑定命令参数
[java]
public String test4(@ModelAttributeUserModel user, Model model) 或 public String test5(UserModel user, Modelmodel)
此时我们没有为命令对象提供暴露到模型数据中的名字，此时的名字是什么呢？Spring Web MVC自动将简单类名（首字母小写）作为名字暴露，如“cn.javass.chapter6.model.UserModel”暴露的名字为“userModel”。
[java]
public @ModelAttribute List<String>test6() 或 public @ModelAttributeList<UserModel> test7()
对于集合类型（Collection接口的实现者们，包括数组），生成的模型对象属性名为“简单类名（首字母小写）”+“List”，如List<String>生成的模型对象属性名为“stringList”，List<UserModel>生成的模型对象属性名为“userModelList”。
其他情况一律都是使用简单类名（首字母小写）作为模型对象属性名，如Map<String,UserModel>类型的模型对象属性名为“map”。
@SessionAttributes绑定命令对象到session
有时候我们需要在多次请求之间保持数据，
一般情况需要我们明确的调用HttpSession的API来存取会话数据，如多步骤提交的表单。
Spring Web MVC提供了@SessionAttributes进行请求间透明的存取会话数据。
[java]
//1、在控制器类头上添加@SessionAttributes注解
@SessionAttributes(value = {"user"}) //①
public classSessionAttributeController
//2、@ModelAttribute注解的方法进行表单引用对象的创建
@ModelAttribute("user") //②
public UserModel initUser()
//3、@RequestMapping注解方法的@ModelAttribute注解
的参数进行命令对象的绑定
@RequestMapping("/session1") //③
public String session1(@ModelAttribute("user") UserModeluser)
//4、通过SessionStatus的setComplete()方法清除@SessionAttributes指定的会话数据
@RequestMapping("/session2") //③
public String session(@ModelAttribute("user") UserModel user,SessionStatus status) {
if(true) { //④
status.setComplete();
}
return "success";
}
@SessionAttributes(value = {"user"})含义：
@SessionAttributes(value ={"user"}) 标识将模型数据中的名字为“user”的对象存储到会话中（默认HttpSession），此处value指定将模型数据中的哪些数据（名字进行匹配）存储到会话中，此外还有一个types属性表示模型数据中的哪些类型的对象存储到会话范围内，如果同时指定value和types属性则那些名字和类型都匹配的对象才能存储到会话范围内。
包含@SessionAttributes的执行流程如下所示：
①首先根据@SessionAttributes注解信息查找会话内的对象放入到模型数据中；
②执行@ModelAttribute注解的方法：如果模型数据中包含同名的数据，则不执行@ModelAttribute注解方法进行准备表单引用数据，而是使用①步骤中的会话数据；如果模型数据中不包含同名的数据，执行@ModelAttribute注解的方法并将返回值添加到模型数据中；
③执行@RequestMapping方法，绑定@ModelAttribute注解的参数：查找模型数据中是否有@ModelAttribute注解的同名对象，如果有直接使用，否则通过反射创建一个；并将请求参数绑定到该命令对象
此处需要注意：如果使用@SessionAttributes注解控制器类之后，③步骤一定是从模型对象中取得同名的命令对象，如果模型数据中不存在将抛出HttpSessionRequiredException Expected session attribute ‘user’(Spring3.1
或HttpSessionRequiredException Session attribute ‘user’ required -not found in session(Spring3.0)异常。
④如果会话可以销毁了，如多步骤提交表单的最后一步，此时可以调用SessionStatus对象的setComplete()标识当前会话的@SessionAttributes指定的数据可以清理了，此时当@RequestMapping功能处理方法执行完毕会进行清理会话数据。