常用注解

RequestParam

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

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

RequestBody

@RequestBody注解用于读取http请求的内容(字符串)，通过springmvc提供的HttpMessageConverter接口将读到的内容（json数据）转换为java对象并绑定到Controller方法的参数上。

@RequestBody注解实现接收http请求的json数据，将json数据转换为java对象进行绑定

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

@RequestMapping("/useRequestBody") 
public String useRequestBody(@RequestBody(required=false) String body){ 
 System.out.println(body); 
 return "success"; 
} 

后端@RequestBody注解对应的类在将HTTP的输入流(含请求体)装配到目标类(即：@RequestBody后面的类)时，会根据json字符串中的key来匹配对应实体类的属性，如果匹配一致且json中的该key对应的值符合(或可转换为)

ResponseBody

• 作用：
  ResponseBody注解用于将Controller的方法返回的对象，通过springmvc提供的HttpMessageConverter接口转换为指定格式的数据如：json,xml等，通过Response响应给客户端。

PathVaribale

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

<a href="springmvc/usePathVariable/100">pathVariable 注解</a>

@RequestMapping("/usePathVariable/{id}") 
public String usePathVariable(@PathVariable("id") Integer id){ 
 System.out.println(id); 
 return "success"; 
} 

100

RequestHeader

• 作用：
  用于获取请求消息头。
• 属性：
  value：提供消息头名称
  required：是否必须有此消息头
• 注：
  在实际开发中一般不怎么用。

CookieValue

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

@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，此时就可以使用此注解解决问题。

<a href="springmvc/testModelAttribute?username=test">测试 modelattribute</a> 
控制器代码： 
 /** 
 * 被 ModelAttribute 修饰的方法 
 * @param user 
 */ 
 @ModelAttribute 
 public void showModel(User user) { 
 System.out.println("执行了 showModel 方法"+user.getUsername()); 
 } 
 
 /** 
 * 接收请求的方法 
 * @param user 
 * @return 
 */ 
 @RequestMapping("/testModelAttribute") 
 public String testModelAttribute(User user) { 
 System.out.println("执行了控制器的方法"+user.getUsername()); 
 return "success"; 
 } 

SessionAttribute

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

@Controller("sessionAttributeController")
@RequestMapping("/springmvc") 
@SessionAttributes(value ={"username","password"},types={Integer.class})  
public class SessionAttributeController { 
 
 /** 
 * 把数据存入 SessionAttribute 
 * @param model 
 * @return 
 * Model 是 spring 提供的一个接口，该接口有一个实现类 ExtendedModelMap 
 * 该类继承了 ModelMap，而 ModelMap 就是 LinkedHashMap 子类 
 */ 
 @RequestMapping("/testPut") 
 public String testPut(Model model){ 
        model.addAttribute("username", "泰斯特");   
        model.addAttribute("password","123456");   
        model.addAttribute("age", 31);   
 //跳转之前将数据保存到 username、password 和 age 中，因为注解@SessionAttribute 中有
这几个参数   
        return "success";   
    }   
 
@RequestMapping("/testGet")   
public String testGet(ModelMap model){   
        
	System.out.println(model.get("username")+";"+model.get("password")+";"+model.get("a
ge"));   
        return "success";   
    }   
 
 @RequestMapping("/testClean") 
 public String complete(SessionStatus sessionStatus){ 
 sessionStatus.setComplete(); 
 return "success"; 
 } 
}