一篇文章带你学会 SpringMVC 的常用注解

一、RequestParam

作用：把请求中指定名称的参数给控制器中的形参赋值。
属性：
	value： 请求参数中的名称。
	required：请求参数中是否必须提供此参数。 默认值： true。表示必须提供，如果不提供将报错。

正常情况下，接收的参数username必须和传递参数name的名字对应，才能正确接收，但是通过@RequestParam，可以保持它与引入参数时的name 一致，而参数username这里可以用其他的名字。

jsp 中的代码：
<!-- requestParams 注解的使用 -->
<a href="springmvc/useRequestParam?name=test">requestParam 注解</a>

二、RequestBody

作用：用于获取请求体内容。 直接使用得到是 key=value&key=value...结构的数据。
get 请求方式不适用。
属性：
	required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值
为 false， get 请求得到是 null。

三、PathVaribale

作用：
用于绑定 url 中的占位符。 例如：请求 url 中 /delete/{id}， 这个{id}就是 url 占位符。
url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。

属性：
value： 用于指定 url 中占位符名称。
required：是否必须提供占位符。

四、RequestHeader

注：在实际开发中一般不怎么用。

作用：用于获取请求消息头。
属性：
	value：提供消息头名称
	required：是否必须有此消息头

jsp 中代码：
<!-- RequestHeader 注解 -->
<a href="springmvc/useRequestHeader">获取请求消息头</a>
控制器中代码：
/**
* RequestHeader 注解
* @param user
* @return
*/
@RequestMapping("/useRequestHeader")
public String useRequestHeader(@RequestHeader(value="Accept-Language",
	required=false)String requestHeader){
	System.out.println(requestHeader);
	return "success";
}

五、CookieValue

作用：用于把指定 cookie 名称的值传入控制器方法参数。
属性：
	value：指定 cookie 的名称。
	required：是否必须有此 cookie。

jsp 中的代码：
<!-- CookieValue 注解 -->
<a href="springmvc/useCookieValue">绑定 cookie 的值</a>
控制器中的代码：
/**
* Cookie 注解注解
* @param user
* @return
*/
@RequestMapping("/useCookieValue")
public String useCookieValue(@CookieValue(value="JSESSIONID",required=false)
String cookieValue){
	System.out.println(cookieValue);
	return "success";
}

六、ModelAttribute

作用：该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
	出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可
以修饰有具体返回值的方法。
	出现在参数上，获取指定的数据给参数赋值。
	
属性：
	value：用于获取数据的 key。 key 可以是 POJO 的属性名称，也可以是 map 结构的 key。
	
应用场景：当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。

例如：
我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。 
在提交表单数据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。

（1）ModelAttribute 修饰方法带返回值

<!-- request body 注解 -->
<form action="anno/testModelAttribute" method="post">
    用户姓名：<input type="text" name="uname" /><br/>
    用户年龄：<input type="text" name="age" /><br/>
    <input type="submit" value="提交" />
</form>

可以看到 form 表单中只传入了两个值，并未对 Date 数据赋值

@Controller
@RequestMapping("/anno")
public class AnnoController {
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(User user){
        System.out.println("执行了...");
        System.out.println(user);
        return "success";
    }
    @ModelAttribute
    public User showModel(String uname) {
        System.out.println("showUser执行了...");
        // 通过用户查询数据库（模拟）
        User user = new User();
        user.setUname(uname);
        user.setAge(20);
        user.setBirthday(new Date());
        return user;
    }
}

（2）ModelAttribute 修饰方法不带返回值

jsp 中的代码：
<!-- 修改用户信息 -->
<form action="springmvc/updateUser" method="post">
用户名称： <input type="text" name="username" ><br/>
用户年龄： <input type="text" name="age" ><br/>
<input type="submit" value="保存">
</form>

@Controller
@RequestMapping("/anno")
public class AnnoController {

    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("key") User user){
        System.out.println("执行了...");
        System.out.println(user);
        return "success";
    }
    @ModelAttribute
    public void showModel(String uname, Map<String, User> map) {
        System.out.println("showUser执行了...");
        // 通过用户查询数据库（模拟）
        User user = new User();
        user.setUname(uname);
        user.setAge(20);
        user.setBirthday(new Date());
        map.put("key",user);
    }
}

七、SessionAttribute

作用：用于多次执行控制器方法间的参数共享。
属性：
	value：用于指定存入的属性名称
	type：用于指定存入的数据类型。

jsp 中的代码：
<!-- SessionAttribute 注解的使用 -->
<a href="anno/testSessionAttributes">testSessionAttributes</a>
<a href="anno/getSessionAttributes">getSessionAttributes</a>
<a href="anno/delSessionAttributes">delSessionAttributes</a>

/**
 * 常用注解
 */
@Controller
@RequestMapping("/anno")
// 把数据存入到session域对象中
@SessionAttributes(value= {"username","password","age"},types= {String.class,Integer.class})
public class AnnoController {

    @RequestMapping("/testSessionAttributes")
    public String testSessionAttributes(Model model) {
        System.out.println("testSessionAttributes...");
        // 底层会存储到request域对象中
        model.addAttribute("username", "泰斯特");
        model.addAttribute("password","123456");
        model.addAttribute("age", 31);
        return "success";
    }
    /**
     * 获取值
     * @param modelMap
     * @return
     */
    @RequestMapping(value = "/getSessionAttributes")
    public String getSessionAttributes(ModelMap modelMap) {
        System.out.println("getSessionAttributes...");
        String msg = (String) modelMap.get("username");
        System.out.println(msg);
        return "success";
    }

    /**
     * 清除
     * @param status
     * @return
     */
    @RequestMapping(value = "/delSessionAttributes")
    public String delSessionAttributes(SessionStatus status) {
        System.out.println("delSessionAttributes...");
        status.setComplete();
        return "success";
    }
}