SpringMVC的 几个注解

1.@RequestMapping：

是一个用来处理请求地址映射的注解，可用于类或方法上。

1）：用在类上：是父路径。

2）：用在方法上：是子路径。

 @Controller
 //设置想要跳转的父路径
 @RequestMapping(value = "/Controllers")
 public class StatisticUserCtrl {
     //如需注入，则写入需要注入的类
     //@Autowired

             // 设置方法下的子路经
             @RequestMapping(value = "/method")
             public String helloworld() {

                 return "helloWorld";

             }
 }

路径是：http://localhost:8080/controller/method   就会跳转到helloWorld.jsp

2：@PathVariable

用来获取请求路径（URL）中的动态参数。

function login() {
    var url = "${pageContext.request.contextPath}/person/login/";
    var query = $('#id').val() + '/' + $('#name').val() + '/' + $('#status').val();
    url += query;
    $.get(url, function(data) {
        alert("id: " + data.id + "name: " + data.name + "status: "
                + data.status);
    });
}

 /**
 * @RequestMapping(value = "user/login/{id}/{name}/{status}") 中的 {id}/{name}/{status}
 * 与 @PathVariable int id、@PathVariable String name、@PathVariable boolean status
 * 一一对应，按名匹配。
 */

 @RequestMapping(value = "user/login/{id}/{name}/{status}")
 @ResponseBody
 //@PathVariable注解下的数据类型均可用
 public User login(@PathVariable int id, @PathVariable String name, @PathVariable boolean status) {
 //返回一个User对象响应ajax的请求
     return new User(id, name, status);
 }

3：@Responsebody

表示该方法的返回的结果直接写入 HTTP 响应正文（ResponseBody）中，一般在异步获取数据时使用，通常是在使用 @RequestMapping 后，返回值通常解析为跳转路径，加上 @Responsebody 后返回结果不会被解析为跳转路径，而是直接写入HTTP 响应正文中。

作用： 
该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。 
使用时机： 
返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

当页面发出异步请求：

 function login() {
     var datas = '{"username":"' + $('#username').val() + '","userid":"' + $('#userid').val() + '","status":"' + $('#status').val() + '"}';
     $.ajax({
         type : 'POST',
         contentType : 'application/json',
         url : "${pageContext.request.contextPath}/user/login",
         processData : false,
         dataType : 'json',
         data : datas,
         success : function(data) {
             alert("userid: " + data.userid + "username: " + data.username + "status: "+ data.status);
         },
         error : function(XMLHttpRequest, textStatus, errorThrown) {
             alert("出现异常，异常信息："+textStatus,"error");
         }
     });
 };

例如：

@RequestMapping(value = "user/login")
@ResponseBody
// 将ajax（datas）发出的请求写入 User 对象中,返回json对象响应回去
public User login(User user) {
    User user = new User();
    user .setUserid(1);
    user .setUsername("MrF");
    user .setStatus("1");
    return user ;
}

异步获取 json 数据，加上 @Responsebody 注解后，就会直接返回 json 数据。

4：@RequestBody

作用则是将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。

1) 该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上； 
2) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机：

A) GET、POST方式提时， 根据request header Content-Type的值来判断:

application/x-www-form-urlencoded， 可选（即非必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）；
multipart/form-data, 不能处理（即使用@RequestBody不能处理这种格式的数据）；
其他格式， 必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使用@RequestBody来处理）；

B) PUT方式提交时， 根据request header Content-Type的值来判断:

application/x-www-form-urlencoded， 必须；multipart/form-data, 不能处理；其他格式， 必须；

说明：request的body部分的数据编码格式由header部分的Content-Type指定；

例如：

 @RequestMapping(value = "user/login")
 @ResponseBody
 // 将ajax（datas）发出的请求写入 User 对象中
 public User login(@RequestBody User user) {
 // 这样就不会再被解析为跳转路径，而是直接将user对象写入 HTTP 响应正文中
     return user;
 }

5：@Controller

标记在类上，说明这个类是一个控制器类。但是只写这个，Spring还不认识它，需要让Spring认识它。

< context:component-scan base-package = "com.Spring" />

6：@CookieValue

作用：用来获取Cookie中的值；

　　参数： value：参数名称   required：是否必须  defaultValue：默认值

使用案例：

 /**
      * 获取 Session
      * JSESSIONID=411A032E02A2594698F6E3F4458B9CE4
      */
     @RequestMapping("/testCookieValue")
     public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) {
         System.out.println("JSESSIONID = " + sessionId);
         return "success";
     }

7：@RequestParam

作用：用于将请求参数区数据映射到功能处理方法的参数上

@RequestParam 和 @PathVariable 注解是用于从request中接收请求的，两个都可以接收参数，关键点不同的是@RequestParam 是从request里面拿取值，而 @PathVariable 是从一个URI模板里面来填充

/**
     * @RequestParam("id") 带参映射
     * @param id
     * @return
     */
    @RequestMapping("/testRequestParam")
    public String testRequestParam(@RequestParam("id") int id) {
        System.out.println("testRequestParam  " + id);
        return "success";
    }

8：@SessionAttributes

　　将值放到session作用域中，写在class上面。　　

　　@SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外（value 属性值），

还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中（types 属性值）

 package com.cqvie.yjq;

 import java.util.Map;

 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.SessionAttributes;

 import com.cqvie.model.User;

 @SessionAttributes(value = {"user"}, types = {String.class})
 @RequestMapping("/springmvc")
 @Controller
 public class SessionAttributesTest {

     /**
      * @SessionAttributes
      *         除了可以通过属性名指定需要放到会话中的属性外（value 属性值），
      *         还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中（types 属性值）。
      * 注意： 该注解只能放在类的上面，不能放在方法上面
      *
      * @return
      */
     @RequestMapping("/testSessionAttributes")
     public String testSessionAttributes(Map<String, Object> map) {
         User user = new User(1, "刘邦", "qwe", "123", "辽宁");
         map.put("user", user);
         map.put("school", "重庆");
         return "success";
     }
 }

9：@ModelAttribute

代表的是：该Controller的所有方法在调用前，先执行此@ModelAttribute方法，可用于注解和方法参数中，可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@ModelAttribute方法。

 package com.cqvie.yjq;

 import java.util.Map;

 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.ModelAttribute;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;

 import com.cqvie.model.User;

 @Controller
 @RequestMapping("/springmvc")
 public class ModelAttributeTest {

     private static final String SUCCESS = "success";

     /**
      * 1.有 @ModelAttribute 标记的方法，会在每个目标方法执行之前被 SpringMVC 调用
      * 2.@ModelAttribute注解也可以修饰目标方法POJO类形的入参，其value的属性值有如下作用：
      *     1）SpringMVC会使用value属性值在implicitModel中查找对应的对象，若存在则直接传入到目标方法的入参中
      *     2）SpringMVC会以value为key,POJO类型的对象为value，存入的request中
      *
      * @param id
      * @param map
      */
     @ModelAttribute
     public void getUser(@RequestParam(value = "id", required = false) int id,
             Map<String, Object> map) {
         //模拟数据库中获取对象
         User user = new User(1, "刘邦", "123", "023", "重庆");
         System.out.println("从数据库中获取一个对象：" + user);
         map.put("abc", user);
     }

     /**
      * 运行流程：
      *         1.执行@ModelAttribute注解修饰的方法，从数据库中取出对象，把对象放入Map中，键为：user；
      *         2.SpringMVC从Map中取出User对象，并把表单的请求参数赋值给该User对象的对应属性；
      *         3.SpringMVC把上述对象传入目标方法的参数。
      *
      * 注意：在@ModelAttribute修饰的方法中，放入到Map时的键需要和目标方法入参类型的第一个字母小写的字符串一致
      *
      * @param user
      * @return
      */
     @RequestMapping("/testModelAttribute")
     public String testModelAttribute(@ModelAttribute("abc") User user) {
         System.out.println("修改：" + user);
         return SUCCESS;
     }
 }