Spring MVC中常用注解之@ResponseBody，@RequestBody，@PathVariable详解

àì夳堔傛蜴生んèń 2022-07-17 02:11 243阅读 0赞

一、Spring注解@ResponseBody，@RequestBody和HttpMessageConverter    
  
Spring 3.X系列增加了新注解 @ResponseBody ， @RequestBody

*  **@RequestBody** 将HTTP请求正文转换为适合的HttpMessageConverter对象。
 *  **@ResponseBody** 将内容或对象作为 HTTP 响应正文返回，并调用适合HttpMessageConverter的Adapter转换对象，写入输出流。

HttpMessageConverter 接口，需要开启 <mvc:annotation-driven  /> 。   
AnnotationMethodHandlerAdapter 将会初始化7个转换器，可以通过调用 AnnotationMethodHandlerAdapter 的 getMessageConverts() 方法来获取转换器的一个集合 List<HttpMessageConverter>

引用

ByteArrayHttpMessageConverter   
StringHttpMessageConverter   
ResourceHttpMessageConverter   
SourceHttpMessageConverter   
XmlAwareFormHttpMessageConverter   
Jaxb2RootElementHttpMessageConverter   
MappingJacksonHttpMessageConverter

可以理解为，只要有对应协议的解析器，你就可以通过几行配置，几个注解完成协议——对象的转换工作！ ![icon_biggrin.gif][]    
  
PS:Spring默认的json协议解析由Jackson完成。   
  
二、servlet.xml配置    
  
Spring的配置文件，简洁到了极致，对于当前这个需求只需要三行核心配置：

Xml代码   ![收藏代码][icon_star.png]

1.  **<****context:component-scan** base-package="org.zlex.json.controller" **/>**  
2.  **<****context:annotation-config** **/>**  
3.  **<****mvc:annotation-driven** **/>**

三、pom.xml配置    
  
闲言少叙，先说依赖配置，这里以Json+Spring为参考：   
pom.xml

Xml代码   ![收藏代码][icon_star.png]

1.  **<****dependency****>**  
2.          **<****groupId****>**org.springframework**</****groupId****>**  
3.          **<****artifactId****>**spring-webmvc**</****artifactId****>**  
4.          **<****version****>**3.1.2.RELEASE**</****version****>**  
5.          **<****type****>**jar**</****type****>**  
6.          **<****scope****>**compile**</****scope****>**  
7.      **</****dependency****>**  
8.      **<****dependency****>**  
9.          **<****groupId****>**org.codehaus.jackson**</****groupId****>**  
10.         **<****artifactId****>**jackson-mapper-asl**</****artifactId****>**  
11.         **<****version****>**1.9.8**</****version****>**  
12.         **<****type****>**jar**</****type****>**  
13.         **<****scope****>**compile**</****scope****>**  
14.     **</****dependency****>**  
15.     **<****dependency****>**  
16.         **<****groupId****>**log4j**</****groupId****>**  
17.         **<****artifactId****>**log4j**</****artifactId****>**  
18.         **<****version****>**1.2.17**</****version****>**  
19.         **<****scope****>**compile**</****scope****>**  
20.     **</****dependency****>**

主要需要 spring-webmvc 、 jackson-mapper-asl 两个包，其余依赖包Maven会帮你完成。至于 log4j ，我还是需要看日志嘛。 ![icon_biggrin.gif][]    
包依赖图：   
![点击查看原始大小图片][b888d31f-df29-3db9-9ce5-ea92598b7d15.png]   
至于版本，看项目需要吧！   
  
四、代码实现    
  
域对象：

Java代码   ![收藏代码][icon_star.png]

1.  **public** **class** Person **implements** Serializable \{  
2.    
3.      **private** **int** id;  
4.      **private** String name;  
5.      **private** **boolean** status;  
6.    
7.      **public** Person() \{  
8.          // do nothing  
9.      \}  
10. \}

**这里需要一个空构造，由Spring转换对象时，进行初始化。** ![icon_biggrin.gif][]    
  
@ResponseBody，@RequestBody，@PathVariable    
控制器：

Java代码   ![收藏代码][icon_star.png]

1.  @Controller  
2.  **public** **class** PersonController \{  
3.    
4.      /\*\* 
5.       \* 查询个人信息 
6.       \*  
7.       \* @param id 
8.       \* @return 
9.       \*/  
10.     @RequestMapping(value = "/person/profile/\{id\}/\{name\}/\{status\}", method = RequestMethod.GET)  
11.     **public** @ResponseBody  
12.     Person porfile(@PathVariable **int** id, @PathVariable String name,  
13.             @PathVariable **boolean** status) \{  
14.         **return** **new** Person(id, name, status);  
15.     \}  
16.   
17.     /\*\* 
18.      \* 登录 
19.      \*  
20.      \* @param person 
21.      \* @return 
22.      \*/  
23.     @RequestMapping(value = "/person/login", method = RequestMethod.POST)  
24.     **public** @ResponseBody  
25.     Person login(@RequestBody Person person) \{  
26.         **return** person;  
27.     \}  
28. \}

备注： @RequestMapping(value = "/person/profile/\{id\}/\{name\}/\{status\}", method = RequestMethod.GET) 中的 \{id\}/\{name\}/\{status\} 与 @PathVariable int id, @PathVariable String name,@PathVariable boolean status 一一对应，按名匹配。 ![icon_smile.gif][]  这是restful式风格。   
如果映射名称有所不一，可以参考如下方式：

Java代码   ![收藏代码][icon_star.png]

1.  @RequestMapping(value = "/person/profile/\{id\}", method = RequestMethod.GET)  
2.  **public** @ResponseBody  
3.  Person porfile(@PathVariable("id") **int** uid) \{  
4.      **return** **new** Person(uid, name, status);  
5.  \}

*  GET模式下，这里使用了**@PathVariable**绑定输入参数，非常适合Restful风格。因为隐藏了参数与路径的关系，可以提升网站的安全性，静态化页面，降低恶意攻击风险。![icon_smile.gif][]
 *  POST模式下，使用**@RequestBody**绑定请求对象，Spring会帮你进行协议转换，将Json、Xml协议转换成你需要的对象。
 *  **@ResponseBody**可以标注任何对象，由Srping完成对象——协议的转换。

做个页面测试下：   
JS

Js代码   ![收藏代码][icon_star.png]

1.  $(document).ready(**function**() \{  
2.      $("\#profile").click(**function**() \{  
3.          profile();  
4.      \});  
5.      $("\#login").click(**function**() \{  
6.          login();  
7.      \});  
8.  \});  
9.  **function** profile() \{  
10.     **var** url = 'http://localhost:8080/spring-json/json/person/profile/';  
11.     **var** query = $('\#id').val() + '/' + $('\#name').val() + '/'  
12.             + $('\#status').val();  
13.     url += query;  
14.     alert(url);  
15.     $.get(url, **function**(data) \{  
16.         alert("id: " + data.id + "\\nname: " + data.name + "\\nstatus: "  
17.                 + data.status);  
18.     \});  
19. \}  
20. **function** login() \{  
21.     **var** mydata = '\{"name":"' + $('\#name').val() + '","id":"'  
22.             + $('\#id').val() + '","status":"' + $('\#status').val() + '"\}';  
23.     alert(mydata);  
24.     $.ajax(\{  
25.         type : 'POST',  
26.         contentType : 'application/json',  
27.         url : 'http://localhost:8080/spring-json/json/person/login',  
28.         processData : **false**,  
29.         dataType : 'json',  
30.         data : mydata,  
31.         success : **function**(data) \{  
32.             alert("id: " + data.id + "\\nname: " + data.name + "\\nstatus: "  
33.                     + data.status);  
34.         \},  
35.         error : **function**() \{  
36.             alert('Err...');  
37.         \}  
38.     \});

Table

Html代码   ![收藏代码][icon_star.png]

1.  **<****table****>**  
2.      **<****tr****>**  
3.          **<****td****>**id**</****td****>**  
4.          **<****td****>****<****input** id="id" value="100" **/>****</****td****>**  
5.      **</****tr****>**  
6.      **<****tr****>**  
7.          **<****td****>**name**</****td****>**  
8.          **<****td****>****<****input** id="name" value="snowolf" **/>****</****td****>**  
9.      **</****tr****>**  
10.     **<****tr****>**  
11.         **<****td****>**status**</****td****>**  
12.         **<****td****>****<****input** id="status" value="true" **/>****</****td****>**  
13.     **</****tr****>**  
14.     **<****tr****>**  
15.         **<****td****>****<****input** type="button" id="profile" value="Profile——GET" **/>****</****td****>**  
16.         **<****td****>****<****input** type="button" id="login" value="Login——POST" **/>****</****td****>**  
17.     **</****tr****>**  
18. **</****table****>**

四、简单测试    
  
Get方式测试：   
![点击查看原始大小图片][914df7a1-283d-356f-a2ee-36a032da88ad.png]   
  
![点击查看原始大小图片][45c8d191-7b7f-30b2-ab59-aeb24cc00c9a.png]   
  
Post方式测试：   
![点击查看原始大小图片][1c456f07-f063-3a83-825d-132453c2e52c.png]   
  
![点击查看原始大小图片][021062be-765e-3d3b-817e-afe06132ed9a.png]   
  
五、常见错误    
POST操作时，我用$.post()方式，屡次失败，一直报各种异常：   
![点击查看原始大小图片][4f3f8424-a5e1-3ec1-8be1-f44fa8a48341.png]

引用

org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported   
org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported   
org.springframework.web.HttpMediaTypeNotSupportedException: Content type 'application/x-www-form-urlencoded;charset=UTF-8' not supported

直接用$.post()直接请求会有点小问题，尽管我标识为 json 协议，但实际上提交的 ContentType 还是 application/x-www-form-urlencoded 。需要使用$.ajaxSetup()标示下 ContentType 。

Js代码

1.  **function** login() \{  
2.      **var** mydata = '\{"name":"' + $('\#name').val() + '","id":"'  
3.              + $('\#id').val() + '","status":"' + $('\#status').val() + '"\}';  
4.      alert(mydata);  
5.      $.ajaxSetup(\{  
6.          contentType : 'application/json'  
7.      \});  
8.      $.post('http://localhost:8080/spring-json/json/person/login', mydata,  
9.              **function**(data) \{  
10.                 alert("id: " + data.id + "\\nname: " + data.name  
11.                         + "\\nstatus: " + data.status);  
12.             \}, 'json');  
13.   
    
14. \};

原文链接地址： [点击打开链接][Link 1]

**以下属于本人的个人观点，不属于转载内容：**

关于@ResponseBody，@RequestBody，@PathVariable比较通俗的解释就是：

@PathVariable主要是用来处理URl路径的问题，利用@PathVariable可以是实现在URL路径中实现参数的隐藏效果。

@RequestBody主要是用来处理请求类型转换问题，例如可以把json字符串通过配置自动转换为对象之类的。

@ResponseBody主要是用来处理返回类型转换问题，例如可以把json字符串通过配置自动转换为对象之类的。

一般@ResponseBody，@RequestBody都是用来处理json和xml数据类型，不能用于传统的html解析，因为@ResponseBody，@RequestBody都只是获取内容而已，并不是整个html，所以在有用到json或者xml数据类型传输的时候才可以考虑使用@ResponseBody，@RequestBody这两个注解，否则不要使用。

**如博客内容有问题或有疑义，请及时提出，不甚感谢。本人QQ：208017534**

[icon_biggrin.gif]: /images/20220717/6ab40b09a09f40c49cf3a150d336adc8.png
[icon_star.png]: /images/20220717/43d966a3615d468e954fa259227a34bd.png
[b888d31f-df29-3db9-9ce5-ea92598b7d15.png]: /images/20220717/ff97c8263ef34ebbbb55d14ecd25f3ce.png
[icon_smile.gif]: /images/20220717/cabae7d0830c452c834012517c95f72d.png
[914df7a1-283d-356f-a2ee-36a032da88ad.png]: /images/20220717/c301cb95de2147d88339f755631e1c89.png
[45c8d191-7b7f-30b2-ab59-aeb24cc00c9a.png]: /images/20220717/6689d99931d3407894c2cfb574a9c02c.png
[1c456f07-f063-3a83-825d-132453c2e52c.png]: /images/20220717/fd1d3559c41742d5adab72a374b9dc2d.png
[021062be-765e-3d3b-817e-afe06132ed9a.png]: /images/20220717/d9f393635b5e4f89b9bfd5dac00dd987.png
[4f3f8424-a5e1-3ec1-8be1-f44fa8a48341.png]: /images/20220717/5bd88ce7864748cb8085e5d46582822f.png
[Link 1]: http://snowolf.iteye.com/blog/1628861/