SpringMVC 常用注解

1 RequestParam

1.1 使用说明

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

1.2 使用示例

jsp 中的代码:

<!-- requestParams 注解的使用 -->
<a href="anno/testRequestParam?name=哈哈">RequestParam注解</a>

控制器中的代码:

 @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。

2.2 使用示例

post 请求 jsp 代码:
<form action="anno/testRequestBody" method="post">

    用户姓名: <input type="text" name="username"><br/>
    用户年龄: <input type="text" name="age"><br/>
    <input type="submit" value="提交"><br/>
</form>

控制器中的代码:

    @RequestMapping("/testRequestBody")
    public String testRequestBody(@RequestBody String body){
        System.out.println("执行了...");
        System.out.println(body);
        return "success";
    }

结果:

    执行了...
    username=haha&age=34

3 PathVaribale

3.1 使用说明

作用:
  用于绑定 url中的占位符。例如:请求 url中 /delete/{id},这个{id}就是 url 占位符。
  url支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest风格 URL 的一个重要标志。
属性:
  value:用于指定 url 中占位符名称。
  required:是否必须提供占位符。

3.2 使用示例

jsp 代码:
<a href="anno/testPathVariable/12">PathVariable注解</a>

控制器代码:
@RequestMapping("/testPathVariable/{id}")
public String testPathVariable(@PathVariable("id") String id){
    System.out.println("执行了...");
    System.out.println(id);
    return "success";
}

结果:
    执行了...
    12

4 RequestHeader

4.1 使用说明

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

4.2 使用示例

jsp 中代码:
<a href="anno/testRequestHeader">RequestHeader注解</a>

控制器中代码:
    @RequestMapping("/testRequestHeader")
    public String testRequestHeader(@RequestHeader(value = "Accept") String header){
        System.out.println("执行了...");
        System.out.println(header);
        return "success";
    }

5 CookieValue

5.1 使用说明

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

5.2 使用示例

jsp 中的代码:
<a href="anno/testCookieValue">CookieValue注解</a><br/>

控制器中的代码:

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

6 ModelAttribute

6.1 使用说明

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

6.2 使用示例

1.基于 POJO 属性的基本使用: 修饰的方法有返回值

/**
* 作用在方法,先执行
* @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. 基于 Map 的应用场景示例:修饰的方法没有返回值

/**
* 作用在方法,先执行
* @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 SessionAttribute

7.1 使用说明

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

7.2 使用示例

jsp 中的代码:
<!-- SessionAttribute 注解的使用 -->
<a href="springmvc/testPut">存入 SessionAttribute</a>
<hr/>
<a href="springmvc/testGet">取出 SessionAttribute</a>
<hr/>
<a href="springmvc/testClean">清除 SessionAttribute</a>

控制器中的代码:

@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";
    }
}