Spring MVC 框架学习第二节：MVC 的请求参数和常用注解

此博客用于个人学习，来源于ssm框架的书籍，对知识点进行一个整理。

2.1 请求参数的绑定：

---

2.1.1 绑定说明：

---

2.1.1.1 绑定的机制：

表单中请求参数都是基于 key=value 的。SpringMVC 绑定请求参数的过程是通过把表单提交请求参数，作为控制器中方法参数进行绑定的。

<a href="account/findAccount?accountId=10">查询账户</a>

中请求参数是：accountId=10，控制器方法如下：

/**
 * 查询账户
 * @return
*/
@RequestMapping("/findAccount")
public String findAccount(Integer accountId) {
	System.out.println("查询了账户。。。。"+accountId);
	return "success"; 
}

2.1.1.2 支持的数据类型：

• 基本类型参数：包括基本类型和 String 类型。
• POJO 类型参数：包括实体类，以及关联的实体类。
• 数组和集合类型参数：包括 List 结构和 Map 结构的集合（包括数组）。

SpringMVC 绑定请求参数是自动实现的，但是要想使用，必须遵循使用要求。

2.1.1.3 使用要求：

• 如果是基本类型或者 String 类型：要求我们的参数名称必须和控制器中方法的形参名称保持一致。(严格区分大小写)。
• 如果是 POJO 类型，或者它的关联对象：要求表单中参数名称和 POJO 类的属性名称保持一致。并且控制器方法的参数类型是 POJO 类型。
• 如果是集合类型,有两种方式：
  第一种：要求集合类型的请求参数必须在 POJO 中。在表单中请求参数名称要和 POJO 中集合属性名称相同——给 List 集合中的元素赋值，使用下标；给 Map 集合中的元素赋值，使用键值对。
  第二种：接收的请求参数是 json 格式数据。需要借助一个注解实现。

2.1.1.4 基本类型和 String 类型作为参数：

jsp 代码：

<!-- 基本类型示例 --> 
<a href="account/findAccount?accountId=10&accountName=zhangsan">查询账户</a>

控制器代码：

/**
* 查询账户
* @return
*/
@RequestMapping("/findAccount")
public String findAccount(Integer accountId,String accountName) {
	System.out.println("查询了账户。。。。"+accountId+","+accountName);
	return "success"; 
}

2.1.1.5 POJO 类型作为参数：

实体类代码：

/**
* 账户信息
* @author 黑马程序员
* @Company http://www.ithiema.com
* @Version 1.0
*/
public class Account implements Serializable {
	private Integer id;
	private String name;
	private Float money;
	private Address address;
	//getters and setters
}

/**
* 地址的实体类
* @author 黑马程序员
* @Company http://www.ithiema.com
* @Version 1.0
*/
public class Address implements Serializable {
	private String provinceName;
	private String cityName;
	//getters and setters
}

jsp 代码：

<!-- pojo 类型演示 --> 
<form action="account/saveAccount" method="post">
	账户名称：<input type="text" name="name" ><br/>
	账户金额：<input type="text" name="money" ><br/>
	账户省份：<input type="text" name="address.provinceName" ><br/>
	账户城市：<input type="text" name="address.cityName" ><br/>
	<input type="submit" value="保存">
</form>

控制器代码：

/**
* 保存账户
* @param account
* @return
*/
@RequestMapping("/saveAccount")
public String saveAccount(Account account) {
	System.out.println("保存了账户。。。。"+account);
	return "success"; 
}

2.1.1.6 POJO 类中包含集合类型参数：

实体类代码：

/**
* 用户实体类
* @author 黑马程序员
* @Company http://www.ithiema.com
* @Version 1.0
*/
public class User implements Serializable {
	private String username;
	private String password;
	private Integer age;
	private List<Account> accounts;
	private Map<String,Account> accountMap;
	
	//getters and setters
	@Override
	public String toString() {
		return "User [username=" + username + ", password=" + password + ", age="+ age + ",\n accounts=" + accounts + ",\n accountMap=" + accountMap + "]";
	} 
}

jsp 代码：

<!-- POJO 类包含集合类型演示 --> 
<form action="account/updateAccount" method="post">
	用户名称：<input type="text" name="username" ><br/>
	用户密码：<input type="password" name="password" ><br/>
	用户年龄：<input type="text" name="age" ><br/>
	账户 1 名称：<input type="text" name="accounts[0].name" ><br/>
	账户 1 金额：<input type="text" name="accounts[0].money" ><br/>
	账户 2 名称：<input type="text" name="accounts[1].name" ><br/>
	账户 2 金额：<input type="text" name="accounts[1].money" ><br/>
	账户 3 名称：<input type="text" name="accountMap['one'].name" ><br/>
	账户 3 金额：<input type="text" name="accountMap['one'].money" ><br/>
	账户 4 名称：<input type="text" name="accountMap['two'].name" ><br/>
	账户 4 金额：<input type="text" name="accountMap['two'].money" ><br/>
	<input type="submit" value="保存">
</form>

控制器代码：

/**
* 更新账户
* @return
*/
@RequestMapping("/updateAccount")
public String updateAccount(User user) {
	System.out.println("更新了账户。。。。"+user);
	return "success"; 
}

2.1.1.7 请求参数乱码问题：

post 请求方式：在 web.xml 中配置一个过滤器

<!-- 配置 springMVC 编码过滤器 --> 
<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> 
	<!-- 启动过滤器 --> 
	<init-param> 
		<param-name>forceEncoding</param-name> 
		<param-value>true</param-value> 
	</init-param> 
</filter> 

<!-- 过滤所有请求 --> 
<filter-mapping> 
	<filter-name>CharacterEncodingFilter</filter-name> 
	<url-pattern>/*</url-pattern> 
</filter-mapping>

在 springmvc 的配置文件中可以配置，静态资源不过滤：

<!-- location 表示路径，mapping 表示文件，**表示该目录下的文件以及子目录的文件 -->
<mvc:resources location="/css/" mapping="/css/**"/>
<mvc:resources location="/images/" mapping="/images/**"/>
<mvc:resources location="/scripts/" mapping="/javascript/**"/>

get 请求方式：tomacat 对 GET 和 POST 请求处理方式是不同的，GET 请求的编码问题，要改 tomcat 的 server.xml 配置文件，如下：

<Connector connectionTimeout="20000" port="8080" protocol="HTTP/1.1" redirectPort="8443"/>

改为：

<Connector connectionTimeout="20000" port="8080" protocol="HTTP/1.1" redirectPort="8443" useBodyEncodingForURI="true"/>

如果遇到 ajax 请求仍然乱码，请把：useBodyEncodingForURI="true"改为 URIEncoding=“UTF-8”

2.1.2 特殊情况：

有的时候我们需要自定义类型转化器，例如：
jsp 代码：

<!-- 特殊情况之：类型转换问题 --> 
<a href="account/deleteAccount?date=2018-01-01">根据日期删除账户</a>

控制器代码：

/**
* 删除账户
* @return
*/
@RequestMapping("/deleteAccount")
public String deleteAccount(String date) {
	System.out.println("删除了账户。。。。"+date);
	return "success"; 
}

这个时候控制台可以打印出 date 的信息，但如果我们把们把控制器中方法参数的类型改为 Date 时：

/**
* 删除账户
* @return
*/
@RequestMapping("/deleteAccount")
public String deleteAccount(Date date) {
	System.out.println("删除了账户。。。。"+date);
	return "success"; 
}

出现异常：Failed to convert value of type ‘java.lang.String’ to required type ‘java.util.Date’; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [java.util.Date] for value ‘2018-01-01’; nested exception is java.lang.IllegalArgumentException。

这个时候需要我们自定义转换器。

2.1.2.1 自定义类型转换器:

第一步：定义一个类，实现 Converter 接口，该接口有两个泛型。

public interface Converter<S, T> {
	//S:表示接受的类型，T：表示目标类型
	/**
	* 实现类型转换的方法
	*/
	@Nullable
	T convert(S source);
}

/**
* 自定义类型转换器
* @author 黑马程序员
* @Company http://www.ithiema.com
* @Version 1.0
*/
public class StringToDateConverter implements Converter<String, Date> {
	/**
	* 用于把 String 类型转成日期类型
	*/
	@Override
	public Date convert(String source) {
		DateFormat format = null;
		try {
			if(StringUtils.isEmpty(source)) {
				throw new NullPointerException("请输入要转换的日期");
			}
			format = new SimpleDateFormat("yyyy-MM-dd");
			Date date = format.parse(source);
			return date;
		} catch (Exception e) {
			throw new RuntimeException("输入日期有误");
		} 
	} 
}

第二步：在 spring 配置文件中配置类型转换器。
spring 配置类型转换器的机制是，将自定义的转换器注册到类型转换服务中去。

<!-- 配置类型转换器工厂 --> 
<bean id="converterService" class="org.springframework.context.support.ConversionServiceFactoryBean">
	 <!-- 给工厂注入一个新的类型转换器 -->
	 <property name="converters">
		 <array>
			 <!-- 配置自定义类型转换器 -->
			 <bean class="com.itheima.web.converter.StringToDateConverter"></bean>
		 </array>
	 </property>
</bean>

第三步：在 annotation-driven 标签中引用配置的类型转换服务。

<!-- 引用自定义类型转换器 --> 
<mvc:annotation-driven conversion-service="converterService"></mvc:annotation-driven>

2.1.2.2 使用 ServletAPI 对象作为方法参数：

SpringMVC 还支持使用原始 ServletAPI 对象作为控制器方法的参数。支持原始 ServletAPI 对象有：
HttpServletRequest，HttpServletResponse，HttpSession，java.security.Principal，Locale，InputStream，OutputStream，Reader，Writer。

我们可以把上述对象，直接写在控制的方法参数中使用。

jsp 代码：

<!-- 原始 ServletAPI 作为控制器参数 --> 
<a href="account/testServletAPI">测试访问 ServletAPI</a>

控制器中的代码：

/**
* 测试访问 testServletAPI
* @return
*/
@RequestMapping("/testServletAPI")
public String testServletAPI(HttpServletRequest request,HttpServletResponse response,HttpSession session) {
	System.out.println(request);
	System.out.println(response);
	System.out.println(session);
	return "success"; 
}

2.2 常用注解：

1. RequestParam注解
   1. 作用：把请求中的指定名称的参数传递给控制器中的形参赋值
   2. 属性
      1. value：请求参数中的名称
      2. required：请求参数中是否必须提供此参数，默认值是true，必须提供
   3. 代码如下

/***
 接收请求
* @return 
*/ 
@RequestMapping(path="/hello") 
public String sayHello(@RequestParam(value="username",required=false)String name) { 
	System.out.println("aaaa"); 
	System.out.println(name); 
	return "success"; 
}

2. RequestBody注解
   1. 作用：用于获取请求体的内容（注意：get方法不可以）
   2. 属性
      1. required：是否必须有请求体，默认值是true
   3. 代码如下

/*** 
接收请求 
* @return 
*/ 
@RequestMapping(path="/hello") 
public String sayHello(@RequestBody String body) { 
	System.out.println("aaaa"); 
	System.out.println(body); 
	return "success"; 
}

3. PathVariable注解
   1. 作用：拥有绑定url中的占位符的。例如：url中有/delete/{id}，{id}就是占位符
   2. 属性：
      1. value：指定url中的占位符名称
   3. Restful风格的URL：
      1. 请求路径一样，可以根据不同的请求方式去执行后台的不同方法
      2. restful风格的URL优点：
         1. 结构清晰
         2. 符合标准
         3. 易于理解
         4. 扩展方便
   4. 代码如下

<a href="user/hello/1">入门案例</a>

/*** 
接收请求 
* @return 
*/
@RequestMapping(path="/hello/{id}")
public String sayHello(@PathVariable(value="id") String id) { 
	System.out.println(id); 
	return "success"; 
}

4. RequestHeader注解
   1. 作用：获取指定请求头的值
   2. 属性
      1. value：请求头的名称
   3. 代码如下

@RequestMapping(path="/hello") 
public String sayHello(@RequestHeader(value="Accept") String header) { 
	System.out.println(header); 
	return "success"; 
}

5. CookieValue注解
   1. 作用：用于获取指定cookie的名称的值
   2. 属性
      1. value：cookie的名称
   3. 代码如下

@RequestMapping(path="/hello") 
public String sayHello(@CookieValue(value="JSESSIONID") String cookieValue) {
	System.out.println(cookieValue); 
	return "success"; 
}

6. ModelAttribute注解
   1. 作用
      1. 出现在方法上：表示当前方法会在控制器方法执行前线执行。
      2. 出现在参数上：获取指定的数据给参数赋值。
   2. 应用场景
      1. 当提交表单数据不是完整的实体数据时，保证没有提交的字段使用数据库原来的数据。
   3. 代码如下
      1. 修饰的方法有返回值

/*** 
作用在方法，先执行 
* @param name 
* @return 
*/ 
@ModelAttribute 
public User showUser(String name) { 
	System.out.println("showUser执行了..."); 
	// 模拟从数据库中查询对象 
	User user = new User(); 
	user.setName("哈哈"); 
	user.setPassword("123"); 
	user.setMoney(100d); 
	return user; 
}

/*** 
修改用户的方法 
* @param cookieValue 
* @return 
*/ 
@RequestMapping(path="/updateUser") 
public String updateUser(User user) { 
	System.out.println(user); 
	return "success"; 
}

2. 修饰的方法没有返回值

/*** 
作用在方法，先执行 
* @param name 
* @return 
*/ 
@ModelAttribute 
public void showUser(String name,Map<String, User> map) { 
	System.out.println("showUser执行了..."); 
	// 模拟从数据库中查询对象 
	User user = new User(); 
	user.setName("哈哈"); 
	user.setPassword("123"); 
	user.setMoney(100d); 
	map.put("abc", user); 
}

/*** 
修改用户的方法 
* @param cookieValue 
* @return 
*/
@RequestMapping(path="/updateUser") 
public String updateUser(@ModelAttribute(value="abc") User user) { 
	System.out.println(user); 
	return "success"; 
}

7. SessionAttributes注解
   1. 作用：用于多次执行控制器方法间的参数共享
   2. 属性
      1. value：指定存入属性的名称
   3. 代码如下

@Controller 
@RequestMapping(path="/user") 
@SessionAttributes(value= {"username","password","age"},types= {String.class,Integer.class}) 
// 把数据存入到session域对象中 
public class HelloController { 
	/*** 
	向session中存入值 
	* @return 
	*/ 
	@RequestMapping(path="/save") 
	public String save(Model model) { 
		System.out.println("向session域中保存数据"); 
		model.addAttribute("username", "root"); 
		model.addAttribute("password", "123"); 
		model.addAttribute("age", 20); 
		return "success"; 
	}
	
	/*** 
	从session中获取值 
	* @return 
	*/ 
	@RequestMapping(path="/find") 
	public String find(ModelMap modelMap) { 
		String username = (String) modelMap.get("username"); 
		String password = (String) modelMap.get("password"); 
		Integer age = (Integer) modelMap.get("age"); 
		System.out.println(username + " : "+password +" : "+age); 
		return "success"; 
	}
	
	/*** 
	清除值 
	* @return 
	*/ 
	@RequestMapping(path="/delete") 
	public String delete(SessionStatus status) {
		status.setComplete(); 
		return "success"; 
	} 
}