Spring注解学习 @ResponseBode @RequestBody @PathVariable

2024-02-23 12:08

本文主要是介绍Spring注解学习 @ResponseBode @RequestBody @PathVariable,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

SpringMVC层跟JSon结合,几乎不需要做什么配置,代码实现也相当简洁。再也不用为了组装协议而劳烦辛苦了!

一、Spring注解@ResponseBody,@RequestBody和HttpMessageConverter

Spring 3.X系列增加了新注解 @ResponseBody@RequestBody

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

HttpMessageConverter接口,需要开启 <mvc:annotation-driven  />
AnnotationMethodHandlerAdapter将会初始化7个转换器,可以通过调用 AnnotationMethodHandlerAdaptergetMessageConverts()方法来获取转换器的一个集合 List<HttpMessageConverter>
引用
ByteArrayHttpMessageConverter
StringHttpMessageConverter
ResourceHttpMessageConverter
SourceHttpMessageConverter
XmlAwareFormHttpMessageConverter
Jaxb2RootElementHttpMessageConverter
MappingJacksonHttpMessageConverter


可以理解为,只要有对应协议的解析器,你就可以通过几行配置,几个注解完成协议——对象的转换工作!

PS:Spring默认的json协议解析由Jackson完成。

二、servlet.xml配置

Spring的配置文件,简洁到了极致,对于当前这个需求只需要三行核心配置:
Xml代码   收藏代码
  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代码   收藏代码
  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-webmvcjackson-mapper-asl两个包,其余依赖包Maven会帮你完成。至于 log4j,我还是需要看日志嘛。
包依赖图:

至于版本,看项目需要吧!

四、代码实现

域对象:
Java代码   收藏代码
  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. }  
public class Person implements Serializable {private int id;private String name;private boolean status;public Person() {// do nothing}
}


这里需要一个空构造,由Spring转换对象时,进行初始化。

@ResponseBody,@RequestBody,@PathVariable
控制器:
Java代码   收藏代码
  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. }  
@Controller
public class PersonController {/*** 查询个人信息* * @param id* @return*/@RequestMapping(value = "/person/profile/{id}/{name}/{status}", method = RequestMethod.GET)public @ResponseBodyPerson porfile(@PathVariable int id, @PathVariable String name,@PathVariable boolean status) {return new Person(id, name, status);}/*** 登录* * @param person* @return*/@RequestMapping(value = "/person/login", method = RequestMethod.POST)public @ResponseBodyPerson login(@RequestBody Person person) {return person;}
}


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

Java代码   收藏代码
  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. }  
	@RequestMapping(value = "/person/profile/{id}", method = RequestMethod.GET)public @ResponseBodyPerson porfile(@PathVariable("id") int uid) {return new Person(uid, name, status);}


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


做个页面测试下:
JS
Js代码   收藏代码
  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代码   收藏代码
  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>  
	<table><tr><td>id</td><td><input id="id" value="100" /></td></tr><tr><td>name</td><td><input id="name" value="snowolf" /></td></tr><tr><td>status</td><td><input id="status" value="true" /></td></tr><tr><td><input type="button" id="profile" value="Profile——GET" /></td><td><input type="button" id="login" value="Login——POST" /></td></tr></table>


四、简单测试

Get方式测试:




Post方式测试:




五、常见错误
POST操作时,我用$.post()方式,屡次失败,一直报各种异常:


引用
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. };  

效果是一样!

这篇关于Spring注解学习 @ResponseBode @RequestBody @PathVariable的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/738572

相关文章

SpringBoot整合liteflow的详细过程

《SpringBoot整合liteflow的详细过程》:本文主要介绍SpringBoot整合liteflow的详细过程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋...  liteflow 是什么? 能做什么?总之一句话:能帮你规范写代码逻辑 ,编排并解耦业务逻辑,代码

JavaSE正则表达式用法总结大全

《JavaSE正则表达式用法总结大全》正则表达式就是由一些特定的字符组成,代表的是一个规则,:本文主要介绍JavaSE正则表达式用法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录常用的正则表达式匹配符正则表China编程达式常用的类Pattern类Matcher类PatternSynta

Spring Security中用户名和密码的验证完整流程

《SpringSecurity中用户名和密码的验证完整流程》本文给大家介绍SpringSecurity中用户名和密码的验证完整流程,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定... 首先创建了一个UsernamePasswordAuthenticationTChina编程oken对象,这是S

java实现docker镜像上传到harbor仓库的方式

《java实现docker镜像上传到harbor仓库的方式》:本文主要介绍java实现docker镜像上传到harbor仓库的方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 前 言2. 编写工具类2.1 引入依赖包2.2 使用当前服务器的docker环境推送镜像2.2

Java easyExcel实现导入多sheet的Excel

《JavaeasyExcel实现导入多sheet的Excel》这篇文章主要为大家详细介绍了如何使用JavaeasyExcel实现导入多sheet的Excel,文中的示例代码讲解详细,感兴趣的小伙伴可... 目录1.官网2.Excel样式3.代码1.官网easyExcel官网2.Excel样式3.代码

Java MQTT实战应用

《JavaMQTT实战应用》本文详解MQTT协议,涵盖其发布/订阅机制、低功耗高效特性、三种服务质量等级(QoS0/1/2),以及客户端、代理、主题的核心概念,最后提供Linux部署教程、Sprin... 目录一、MQTT协议二、MQTT优点三、三种服务质量等级四、客户端、代理、主题1. 客户端(Clien

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Spring 框架之Springfox使用详解

《Spring框架之Springfox使用详解》Springfox是Spring框架的API文档工具,集成Swagger规范,自动生成文档并支持多语言/版本,模块化设计便于扩展,但存在版本兼容性、性... 目录核心功能工作原理模块化设计使用示例注意事项优缺点优点缺点总结适用场景建议总结Springfox 是

在Spring Boot中集成RabbitMQ的实战记录

《在SpringBoot中集成RabbitMQ的实战记录》本文介绍SpringBoot集成RabbitMQ的步骤,涵盖配置连接、消息发送与接收,并对比两种定义Exchange与队列的方式:手动声明(... 目录前言准备工作1. 安装 RabbitMQ2. 消息发送者(Producer)配置1. 创建 Spr

java向微信服务号发送消息的完整步骤实例

《java向微信服务号发送消息的完整步骤实例》:本文主要介绍java向微信服务号发送消息的相关资料,包括申请测试号获取appID/appsecret、关注公众号获取openID、配置消息模板及代码... 目录步骤1. 申请测试系统2. 公众号账号信息3. 关注测试号二维码4. 消息模板接口5. Java测试