`

Spring 注解学习手札(七) 补遗——@ResponseBody,@RequestBody,@PathVariable

阅读更多
最近需要做些接口服务,服务协议定为JSON,为了整合在Spring中,一开始确实费了很大的劲,经朋友提醒才发现,SpringMVC已经强悍到如此地步,佩服!

相关参考:
Spring 注解学习手札(一) 构建简单Web应用
Spring 注解学习手札(二) 控制层梳理
Spring 注解学习手札(三) 表单页面处理
Spring 注解学习手札(四) 持久层浅析
Spring 注解学习手札(五) 业务层事务处理
Spring 注解学习手札(六) 测试
Spring 注解学习手札(七) 补遗——@ResponseBody,@RequestBody,@PathVariable
Spring 注解学习手札(八) 补遗——@ExceptionHandler


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的配置文件,简洁到了极致,对于当前这个需求只需要三行核心配置:
	<context:component-scan base-package="org.zlex.json.controller" />
	<context:annotation-config />
	<mvc:annotation-driven />


三、pom.xml配置

闲言少叙,先说依赖配置,这里以Json+Spring为参考:
pom.xml
	<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
			<version>3.1.2.RELEASE</version>
			<type>jar</type>
			<scope>compile</scope>
		</dependency>
		<dependency>
			<groupId>org.codehaus.jackson</groupId>
			<artifactId>jackson-mapper-asl</artifactId>
			<version>1.9.8</version>
			<type>jar</type>
			<scope>compile</scope>
		</dependency>
		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.17</version>
			<scope>compile</scope>
		</dependency>

主要需要spring-webmvcjackson-mapper-asl两个包,其余依赖包Maven会帮你完成。至于log4j,我还是需要看日志嘛。
包依赖图:

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

四、代码实现

域对象:
public class Person implements Serializable {

	private int id;
	private String name;
	private boolean status;

	public Person() {
		// do nothing
	}
}


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

@ResponseBody,@RequestBody,@PathVariable
控制器:
@Controller
public class PersonController {

	/**
	 * 查询个人信息
	 * 
	 * @param id
	 * @return
	 */
	@RequestMapping(value = "/person/profile/{id}/{name}/{status}", method = RequestMethod.GET)
	public @ResponseBody
	Person 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 @ResponseBody
	Person 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式风格。
如果映射名称有所不一,可以参考如下方式:

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


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


做个页面测试下:
JS
	$(document).ready(function() {
		$("#profile").click(function() {
			profile();
		});
		$("#login").click(function() {
			login();
		});
	});
	function profile() {
		var url = 'http://localhost:8080/spring-json/json/person/profile/';
		var query = $('#id').val() + '/' + $('#name').val() + '/'
				+ $('#status').val();
		url += query;
		alert(url);
		$.get(url, function(data) {
			alert("id: " + data.id + "\nname: " + data.name + "\nstatus: "
					+ data.status);
		});
	}
	function login() {
		var mydata = '{"name":"' + $('#name').val() + '","id":"'
				+ $('#id').val() + '","status":"' + $('#status').val() + '"}';
		alert(mydata);
		$.ajax({
			type : 'POST',
			contentType : 'application/json',
			url : 'http://localhost:8080/spring-json/json/person/login',
			processData : false,
			dataType : 'json',
			data : mydata,
			success : function(data) {
				alert("id: " + data.id + "\nname: " + data.name + "\nstatus: "
						+ data.status);
			},
			error : function() {
				alert('Err...');
			}
		});

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
	function login() {
		var mydata = '{"name":"' + $('#name').val() + '","id":"'
				+ $('#id').val() + '","status":"' + $('#status').val() + '"}';
		alert(mydata);
		$.ajaxSetup({
			contentType : 'application/json'
		});
		$.post('http://localhost:8080/spring-json/json/person/login', mydata,
				function(data) {
					alert("id: " + data.id + "\nname: " + data.name
							+ "\nstatus: " + data.status);
				}, 'json');
	};

效果是一样!

详见附件!

相关参考:
Spring 注解学习手札(一) 构建简单Web应用
Spring 注解学习手札(二) 控制层梳理
Spring 注解学习手札(三) 表单页面处理
Spring 注解学习手札(四) 持久层浅析
Spring 注解学习手札(五) 业务层事务处理
Spring 注解学习手札(六) 测试
Spring 注解学习手札(七) 补遗——@ResponseBody,@RequestBody,@PathVariable
Spring 注解学习手札(八) 补遗——@ExceptionHandler
  • 大小: 92 KB
  • 大小: 58.5 KB
  • 大小: 53.8 KB
  • 大小: 52.2 KB
  • 大小: 51.6 KB
  • 大小: 30.3 KB
38
5
分享到:
评论
25 楼 ypcheng 2016-10-25  
  学习啦~~
23 楼 小样样 2015-07-22  
设置字符集的话好像可以在 后面添加 contentType: "application/json; charset=utf-8",
22 楼 AllInNature 2015-07-10  
不太管用啊,只能弹出第一个来,get后面弹不出来,post来了个err
21 楼 nbvghost 2015-07-01  
我在配置  @RequestBody json 转java 对象时,一直是提示:
415 (Unsupported Media Type)
我的问题是:
1、
@RequestMapping(value = "mail",method = RequestMethod.POST,consumes ="")
    @ResponseBody
    public CompanyVO changeCompanyVO(@RequestBody CompanyVO companyVO, Model model) {
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.setViewName("manager/mail");

        return companyVO;
    }
我添加了  consumes = "application/json"  在客户端没有针对这个类型进行提交。

2、 我的spring 配制。
<bean id="contentNegotiationManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
              <property name="mediaTypes">
                     <map>
                            <entry key="json" value="application/json"/>
                            <entry key="xml" value="application/xml"/>
                            <entry key="html" value="text/html"/>
                     </map>
              </property>
       </bean>

20 楼 redcoatjk 2015-04-22  
使用自动的转换器感觉容易出错. 比如乱码. json格式问题之类的.
如果直接用Jackson 将obj->string 直接返回write 貌似比较简单直接方便.
19 楼 zp6361688 2015-04-05  
 
18 楼 shenkun58 2015-03-02  
谢谢哈 啥也不说了  干
17 楼 pcaopeng 2014-10-08  
HTTP Status 404 - /spring-json/json/person/login   没有出现像你那样的预期效果  只出来了
例如你 讲的 四、简单测试 Get方式测试:的第一张图片;   Post方式测试:里的第一张图片 第二张图片显示
16 楼 pcaopeng 2014-10-08  
HTTP Status 404 - /spring-json/json/person/profile/100222/snowolf222/true
15 楼 红色幽丿默 2014-09-16  
想请教一下 如果是复合类型的类
比如  User 中有  Role 对象

我查询User  但是不并不需要 Role 但是直接返回  User 就会报错 ,因为 Role对象还是空的,  能提供下   这方面的API么。。  想过滤一个对象的某些属性。
14 楼 liu_rui_ 2014-06-25  
index.html中的
var mydata = '{"name":"' + $('#name').val() + '","id":"' + $('#id').val() + '","status":"' + $('#status').val() + '"}';
可以改成:
var mydata= JSON.stringify({ name: $('#name').val(), id: $('#id').val(), status: $('#status').val() });
13 楼 倔强的土豆 2014-03-18  
很不错的系列,谢谢lz
12 楼 baoqianglang 2014-03-05  
灰常好,必须学习...
11 楼 schy_hqh 2014-02-23  
10 楼 dazhou600 2013-07-02  
学习学习
9 楼 carrotzizi 2013-04-20  
  
8 楼 D.Z 2013-04-12  
nice...
7 楼 zhouguoqing917 2013-03-12  
 
6 楼 枫箫子 2013-01-22  
啊   精华

相关推荐

    Spring 注解学习手札(二) 控制层梳理

    这篇“Spring注解学习手札(二)控制层梳理”主要聚焦于如何利用注解来构建和理解Spring MVC的控制层,即Controller。Spring MVC是Spring框架的一部分,专门用于处理Web应用程序的请求和响应。 一、@RestController...

    Spring 注解学习手札(一) 构建简单Web应用

    在本篇《Spring注解学习手札(一)构建简单Web应用》中,我们将深入探讨如何使用Spring框架的注解来构建一个基本的Web应用程序。Spring框架是Java开发中的核心工具,尤其在企业级应用中广泛应用。它简化了依赖注入、...

    Spring 注解学习手札

    【Spring注解学习手札】 在现代Java Web开发中,Spring框架因其强大的功能和灵活性而备受推崇。Spring注解的引入极大地简化了配置文件,提高了开发效率。本篇将聚焦于Spring MVC中的注解,通过构建一个简单的Web...

    Spring 注解学习手札(四) 持久层浅析

    在本篇《Spring注解学习手札(四)持久层浅析》中,我们将深入探讨Spring框架在持久层的应用,特别是如何通过注解简化数据库操作。Spring作为一个强大的轻量级框架,提供了丰富的功能来处理数据访问,使得开发者可以...

    Spring 注解学习手札(三) 表单页面处理

    在本篇《Spring注解学习手札(三)表单页面处理》中,我们将深入探讨Spring框架中关于处理Web表单的关键注解和技术。在实际的Web开发中,表单处理是用户交互的重要组成部分,Spring提供了强大的支持,使得开发者能够...

    Spring 注解学习手札(六) 测试

    在本篇《Spring注解学习手札(六)——测试》中,我们将深入探讨Spring框架中的测试支持,尤其是如何利用注解进行单元测试和集成测试。Spring为开发者提供了丰富的注解,使得测试代码更加简洁、易读且易于维护。本文...

    Spring 注解学习手札(五) 业务层事务处理

    这篇“Spring注解学习手札(五)——业务层事务处理”深入探讨了如何使用注解来管理应用程序中的事务,确保数据的一致性和完整性。Spring提供了声明式事务管理,使得开发者无需编写繁琐的事务控制代码,只需在方法上...

    Perl_学习手札

    这份"Perl学习手札"是为那些想要深入理解Perl语言特性和应用的初学者或有一定经验的开发者准备的宝贵资源。 首先,Perl的核心特性在于其灵活性和表达力。Perl语法受到了C、sed、awk等多种语言的影响,这使得它在...

    spring 的详细使用

    - "spring-reference.pdf" 和 "Spring注解手札.pdf" 可能是详细的 Spring 参考文档和注解指南,对于深入学习 Spring 极为有用。 以上内容只是 Spring 框架的冰山一角,想要精通 Spring,还需要通过阅读文档、实践...

    perl学习手札中文

    "Perl学习手札中文"是一份专为初学者设计的学习资料,旨在帮助读者快速掌握Perl语言的基础和高级特性。以下是对这些文件内容的概览: 1. **word.css**: 这个文件可能是样式表,用于定义文档中的排版和格式。在学习...

    perl学习手札(简体中文)_简信昌

    关于作者: 简信昌 “傲尔网”专案经理 博仲法律事务所资讯部门 台北Perl推广组 (Taipei.pm) 召集人 Newzilla召集人 目前专案: Open Source Foundry (OSSF) Newzilla 线上杂志 ...“Perl学习手札”

    Perl学习手札.chm

    Perl学习手札.chmPerl学习手札.chmPerl学习手札.chm

    hibernate学习手札.z03

    hibernate学习手札.z03

    hibernate学习手札.z01

    hibernate学习手札.z01

    高级Perl编程(黑豹书)+学习手札

    "高级Perl编程(黑豹书)"和"Perl_学习手札"这两本书籍是深入理解并掌握Perl编程的重要资源。 《高级Perl编程》(黑豹书)是Perl编程领域的经典之作,它不仅适合初学者作为进阶读物,也对有经验的Perl程序员提供了...

    Perl 学习手札

    通过深入学习“Perl学习手札”,你可以系统地掌握这些概念,并逐步成长为一个熟练的Perl程序员。记住,实践是检验知识的最好方式,所以不仅要理解理论,还要动手编写代码,解决实际问题。祝你在Perl的学习之旅中取得...

Global site tag (gtag.js) - Google Analytics