5分钟弄懂Spring MVC常用注解，不信你来看

一、@RequestMapping注解

查看@RequestMapping注解的源码，我们可以了解到该注解作用的范围以及常用的属性。

1、作用：用于建立请求 URL 和处理请求方法之间的对应关系。

2、出现的位置

• 类上：请求 URL 的第一级访问目录。此处不写的话，就相当于应用的根目录。
  它出现的目的是为了使我们的 URL 可以按照模块化管理。
  例如：在账户模块上有如下请求：/account/add；/account/update；/account/delete；
  其中/account表示请求URL的第一级访问目录，这样写的好处可以方便的进行模块化管理。
• 方法上：请求 URL 的第二级访问目录。上述中的/add；/update；/delete属于第二级访问目录。

3、属性

• value：用于指定请求的 URL。它和 path 属性的作用是一样的。

• method：用于指定请求的方式。（GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS, TRACE;）
  使用方式：RequestMethod.请求方式

• params：用于指定限制请求参数的条件。它支持简单的表达式。要求请求参数的 key 和 value 必须和配置的一模一样。
  例如：params = {“username=zhangsan”}，表示请求参数中必须有username并且值相同。
  如果username的值不一样，将会出现如下的400请求错误。
  

• headers 发送的请求中必须包含的请求头。

<a href="user/testRequestMapping?username=zhangsan">RequestMapping注解</a>

@Controller
@RequestMapping(path = "user")
public class HelloController {

    @RequestMapping(value = "/testRequestMapping", method = {RequestMethod.GET}, params = {"username=zhangsan"}, headers = {"Accept"})
    public String testRequestMapping() {
        System.out.println("testRequestMapping......");
        return "success";
    }
}

二、@RequestParam注解

1、作用：把请求中的指定名称的参数传递给控制器中的形参赋值

2、属性

• value：请求参数中的名称。和name属性作用相同。
• required：请求参数中是否必须提供此参数。默认值：true。表示必须提供，如果不提供将报错。

<a href="anno/testRequestParam?username=chuzhuyong">@RequestParam注解</a>

	@RequestMapping(value = "/testRequestParam")
    public String testRequestParam(@RequestParam(name = "username") String name,@RequestParam(name = "age",required = false) Integer age) {
        System.out.println(name + "," + age);
        return "success";
    }

三、@RequestBody注解

1、作用

用于获取请求体内容。直接使用得到是 key=value&key=value…结构的数据。
get 请求方式不适用。

2、属性

required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false，get 请求得到是 null。

<form action="anno/testRequestBody" method="post">
        用户名：<input type="text" name="name"><br>
        密码：<input type="password" name="age"><br>
        <input type="submit" value="提交">
</form>

四、@PathVariable注解

1、 作用

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

2、属性

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

<a href="anno/testPathVariable/10">@PathVariable注解</a>

	@RequestMapping(value = "/testPathVariable/{uid}")
    public String testPathVariable(@PathVariable(name = "uid") String id) {
        System.out.println("执行了......");
        System.out.println(id);
        return "success";
    }

五、@RequestHeader注解

1、作用

用于获取请求消息头。

2、属性：

value：提供消息头名称
required：是否必须有此消息头

<a href="anno/testRequestHeader">@RequestHeader注解</a>

	@RequestMapping(value = "/testRequestHeader")
    public String testRequestHeader(@RequestHeader(name = "Accept") String header) {
        System.out.println("执行了......");
        System.out.println(header);
        return "success";
    }

六、@CookieValue注解

1、作用

用于把指定 cookie 名称的值传入控制器方法参数。

2、属性

value：指定 cookie 的名称。
required：是否必须有此 cookie。

<a href="anno/testCookieValue">@CookieValue注解</a>

	@RequestMapping(value = "/testCookieValue")
    public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue) {
        System.out.println("执行了......");
        System.out.println(cookieValue);
        return "success";
    }

七、@ModelAttribute注解

1、作用

该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。
出现在参数上，获取指定的数据给参数赋值。

2、属性

• value：用于获取数据的 key。key 可以是 POJO 的属性名称，也可以是 map 结构的 key。

3、应用场景

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

<form action="anno/testModelAttribute" method="post">
        姓名：<input type="text" name="name"><br>
        年龄：<input type="password" name="age"><br>
        <input type="submit" value="提交">
</form>

	@RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("abc") User user) {
        System.out.println("testModelAttribute()执行了......");
        System.out.println(user);
        return "success";
    }
    @ModelAttribute
    public void ModelAttribute(String name, Map<String,User> map) {
        System.out.println("ModelAttribute()方法执行了......");
        // 模拟查询数据库
        User user = new User();
        user.setName(name);
        user.setAge(22);
        user.setDate(new Date());
        map.put("abc",user);
    }

八、@SessionAttributes注解

1、作用

用于多次执行控制器方法间的参数共享。

2、属性

value：用于指定存入的属性名称
type：用于指定存入的数据类型。

3、示例

<a href="anno/testSessionAttributes">@SessionAttributes注解</a><br>
<a href="anno/getSessionAttributes">getSessionAttributes</a><br>
<a href="anno/delSessionAttributes">delSessionAttributes</a>

@Controller
@RequestMapping(path = "anno")
@SessionAttributes(value = {"msg"})        // 把msg=成功存入到session域中
public class AnnoController {
/**
     * 向session中存入值
     */
    @RequestMapping(value = "/testSessionAttributes")
    public String testSessionAttributes(Model model) {
        System.out.println("testSessionAttributes执行了......");
        // 底层会存储到request域对象中
        model.addAttribute("msg","成功");

        System.out.println(model);
        return "success";
    }

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

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

}

success.jsp

	<h1>欢迎你的到来！</h1>
    ${requestScope.msg}
    ${sessionScope}