SpringMVC的 几个注解

Posted 2020-10-27 bulrush

[email protected]：

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

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

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

 1 @Controller
 2 //设置想要跳转的父路径
 3 @RequestMapping(value = "/Controllers")
 4 public class StatisticUserCtrl {
 5     //如需注入，则写入需要注入的类
 6     //@Autowired
 7 
 8             // 设置方法下的子路经
 9             @RequestMapping(value = "/method")
10             public String helloworld() {
11 
12                 return "helloWorld";
13 
14             }
15 }

路径是：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);
    });
}

 1 /**
 2 * @RequestMapping(value = "user/login/{id}/{name}/{status}") 中的 {id}/{name}/{status}
 3 * 与 @PathVariable int id、@PathVariable String name、@PathVariable boolean status
 4 * 一一对应，按名匹配。
 5 */
 6 
 7 @RequestMapping(value = "user/login/{id}/{name}/{status}")
 8 @ResponseBody
 9 //@PathVariable注解下的数据类型均可用
10 public User login(@PathVariable int id, @PathVariable String name, @PathVariable boolean status) {
11 //返回一个User对象响应ajax的请求
12     return new User(id, name, status);
13 }

3：@Responsebody

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

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

当页面发出异步请求：

 1 function login() {
 2     var datas = ‘{"username":"‘ + $(‘#username‘).val() + ‘","userid":"‘ + $(‘#userid‘).val() + ‘","status":"‘ + $(‘#status‘).val() + ‘"}‘;
 3     $.ajax({
 4         type : ‘POST‘,
 5         contentType : ‘application/json‘,
 6         url : "${pageContext.request.contextPath}/user/login",
 7         processData : false,
 8         dataType : ‘json‘,
 9         data : datas,
10         success : function(data) {
11             alert("userid: " + data.userid + "username: " + data.username + "status: "+ data.status);
12         },
13         error : function(XMLHttpRequest, textStatus, errorThrown) {
14             alert("出现异常，异常信息："+textStatus,"error");
15         }
16     });
17 };

例如：

@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指定；

例如：

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