SpringMVC学习（二）：参数的绑定及常用注解

三、请求参数的绑定

1、绑定说明

绑定机制

我们都知道，表单中请求参数都是基于 key=value 的。
SpringMVC 绑定请求参数的过程是通过把表单提交请求参数，作为控制器中方法参数进行绑定的。
	例如：
		<a href="account/findAccount?accountId=10">查询账户</a>
中请求参数是：
		accountId=10
@RequestMapping("/findAccount")
public String findAccount(Integer accountId) {
	System.out.println("查询了账户。。。。"+accountId);
	return "success"; 
}

支持的数据类型

基本类型参数：
	包括基本类型和 String 类型
POJO 类型参数：
		包括实体类，以及关联的实体类
数组和集合类型参数：
		包括 List 结构和 Map 结构的集合（包括数组）
	SpringMVC 绑定请求参数是自动实现的，但是要想使用，必须遵循使用要求。

使用要求

如果是基本类型或者 String 类型：
	要求我们的参数名称必须和控制器中方法的形参名称保持一致。(严格区分大小写)
如果是 POJO 类型，或者它的关联对象：
	要求表单中参数名称和 POJO 类的属性名称保持一致。并且控制器方法的参数类型是 POJO 类型。
如果是集合类型,有两种方式：
	第一种：
		要求集合类型的请求参数必须在 POJO 中。在表单中请求参数名称要和 POJO 中集合属性名称相同。
		给 List 集合中的元素赋值，使用下标。
		给 Map 集合中的元素赋值，使用键值对。
	第二种：
		接收的请求参数是 json 格式数据。需要借助一个注解实现。
注意:
	它还可以实现一些数据类型自动转换。内置转换器全都在：
org.springframework.core.convert.support 包下。有：
java.lang.Boolean -> java.lang.String : ObjectToStringConverter
java.lang.Character -> java.lang.Number : CharacterToNumberFactory
java.lang.Character -> java.lang.String : ObjectToStringConverter
java.lang.Enum -> java.lang.String : EnumToStringConverter
java.lang.Number -> java.lang.Character : NumberToCharacterConverter
java.lang.Number -> java.lang.Number : NumberToNumberConverterFactory
java.lang.Number -> java.lang.String : ObjectToStringConverter
java.lang.String -> java.lang.Boolean : StringToBooleanConverter
java.lang.String -> java.lang.Character : StringToCharacterConverter
java.lang.String -> java.lang.Enum : StringToEnumConverterFactory
java.lang.String -> java.lang.Number : StringToNumberConverterFactory
java.lang.String -> java.util.Locale : StringToLocaleConverter
java.lang.String -> java.util.Properties : StringToPropertiesConverter
java.lang.String -> java.util.UUID : StringToUUIDConverter
java.util.Locale -> java.lang.String : ObjectToStringConverter
java.util.Properties -> java.lang.String : PropertiesToStringConverter
java.util.UUID -> java.lang.String : ObjectToStringConverter
......
如遇特殊类型转换要求，需要我们自己编写自定义类型转换器。

案例分析

jsp 代码：
<!-- 基本类型示例 --> <a href="account/findAccount?accountId=10&accountName=zhangsan">查询账户</a>
控制器代码：
//查询账户
@RequestMapping("/findAccount")
public String findAccount(Integer accountId,String accountName) {
	System.out.println("查询了账户。。。。"+accountId+","+accountName);
	return "success"; 
}

POJO类型作为参数

POJO类中包含集合类型参数

	private String username;
    private String password;
    private Double money;

    //private User user;
    private List<User> list;
    private Map<String,User> map;
    
   @Override
    public String toString() {
        return "Account{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", money=" + money +
                ", list=" + list +
                ", map=" + map +
                '}';
    }     

请求参数乱码问题

<web-app>
    <display-name>Archetype Created Web Application</display-name>
    <!--配置前端控制器-->
    <servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!--配置解决中文乱码的过滤器-->
    <filter>
        <filter-name>characterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

</web-app>

2、自定义类型转换器

使用场景

在Spring配置文件中配置类型转换器：

使用ServletAPI对象作为方法参数

<a href="param/testServlet">Servlet原生的API</a>

四、常用注解

（1）RequestParam注解

作用：
	把请求中指定名称的参数给控制器中的形参赋值。
属性：
	value：请求参数中的名称。
	required：请求参数中是否必须提供此参数。默认值：true。表示必须提供，如果不提供将报错。
------------------------------------------------------------
@RequestMapping("/testRequestParam")
public String testRequestParam(@RequestParam(name = "name") String username){
    System.out.println("执行了......");
    System.out.println(username);
    return "success";
}

（2）RequestBody注解

作用：
	用于获取请求体内容。直接使用得到是 key=value&key=value...结构的数据。
	get请求方式不适用。
属性：
	required:是否必须有请求体。默认值是:true。当取值为true时,get请求方式会报错。如果取值为false，get 请求得到是 null。
--------------------------------------------------------------
//获取到请求体的内容
@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String body){
    System.out.println("执行了......");
    System.out.println(body);
    return "success";
}

（3）PathVariable注解

作用：
	用于绑定url中的占位符。例如：请求url中/delete/{id}，这个{id}就是url占位符。
	url支持占位符是spring3.0之后加入的。是springmvc支持rest风格URL的一个重要标志。
属性：
    value：用于指定url中占位符名称。
	required：是否必须提供占位符。
-------------------------------------------------------
//PathVariable注解
@RequestMapping("/testPathVariable/{sid}")
public String testPathVariable(@PathVariable(name = "sid") String id){
    System.out.println("执行了......");
    System.out.println(id);
    return "success";
}
--------------------------------------------------------
<a href="anno/testPathVariable/10">RequestParam</a>

（4）RequestHeader注解

作用：
	用于获取请求消息头。
属性：
	value：提供消息头名称
	required：是否必须有此消息头
注：
	在实际开发中一般不怎么用。
------------------------------------------------------
@RequestMapping(value = "/testRequestHeader")
public String testRequestHeader(@RequestHeader(value = "Accept") String header){
    System.out.println("执行了......");
    System.out.println(header);
    return "success";
}
-------------------------------------------------------
<a href="anno/testRequestHeader">RequestHeader</a>

（5）CookieValue注解

作用：
	用于把指定cookie名称的值传入控制器方法参数。
属性：
	value：指定cookie的名称。
	required：是否必须有此cookie。
------------------------------------------------------
//获得cookie的值
@RequestMapping(value = "/testCookieValue")
public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue){
    System.out.println("执行了......");
    System.out.println(cookieValue);
    return "success";
}
-------------------------------------------------------
<a href="anno/testCookieValue">CookieValue</a>

（6）ModelAttribute注解

作用：
	该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
	出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。
	出现在参数上，获取指定的数据给参数赋值。
属性：
	value：用于获取数据的 key。key 可以是 POJO 的属性名称，也可以是 map 结构的 key。
应用场景：
	当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。
例如：
	我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。
------------------------------------------------------
//ModelAttribute注解
@RequestMapping(value = "/testModelAttribute")
public String testModelAttribute(@ModelAttribute("abc") User user){
    System.out.println("testModelAttribute执行了......");
    System.out.println(user);
    return "success";
}

（7）SessionAttribute注解

作用：
	用于多次执行控制器方法间的参数共享。
属性：
	value：用于指定存入的属性名称
	type：用于指定存入的数据类型。
--------------------------------------------------------------
//SessionAttributes注解
@RequestMapping(value = "/testSessionAttributes")
public String testSessionAttributes(Model model){
    System.out.println("testSessionAttributes执行了......");
    //底层会存储到request域对象中
    model.addAttribute("msg","杨健");
    return "success";
}

//获取值
@RequestMapping(value = "/getSessionAttributes")
public String getSessionAttributes(ModelMap modelMap){
    System.out.println("getSessionAttributes执行了......");
    String msg = (String) modelMap.get("msg");
    System.out.println(msg);
    return "success";
}

//清除
@RequestMapping(value = "/deleteSessionAttributes")
public String deleteSessionAttributes(SessionStatus status){
    System.out.println("deleteSessionAttributes执行了......");
    status.setComplete();
    return "success";
}