Spring 注解学习手札（七） 补遗——@ResponseBody，@RequestBody，@PathVariable

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

[b]相关参考：
[url=/blog/577989]Spring 注解学习手札（一） 构建简单Web应用[/url]
[url=/blog/578452]Spring 注解学习手札（二） 控制层梳理[/url]
[url=/blog/580194]Spring 注解学习手札（三） 表单页面处理[/url]
[url=/blog/583161]Spring 注解学习手札（四） 持久层浅析[/url]
[url=/blog/587602]Spring 注解学习手札（五） 业务层事务处理[/url]
[url=/blog/588351]Spring 注解学习手札（六） 测试[/url]
[url=/blog/1628861]Spring 注解学习手札（七） 补遗——@ResponseBody，@RequestBody，@PathVariable[/url]
[url=/blog/1636050]Spring 注解学习手札（八） 补遗——@ExceptionHandler[/url]
[/b]

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

[b][size=large]一、Spring注解@ResponseBody，@RequestBody和HttpMessageConverter[/size][/b]

Spring 3.X系列增加了新注解[b]@ResponseBody[/b]，[b]@RequestBody[/b]

[list]
[*][b]@RequestBody[/b] 将HTTP请求正文转换为适合的HttpMessageConverter对象。
[*][b]@ResponseBody[/b] 将内容或对象作为 HTTP 响应正文返回，并调用适合HttpMessageConverter的Adapter转换对象，写入输出流。
[/list]
[b]HttpMessageConverter[/b]接口，需要开启[b][/b]。
[b]AnnotationMethodHandlerAdapter[/b]将会初始化7个转换器，可以通过调用[b]AnnotationMethodHandlerAdapter[/b]的[b]getMessageConverts()[/b]方法来获取转换器的一个集合 List
[quote]ByteArrayHttpMessageConverter
StringHttpMessageConverter
ResourceHttpMessageConverter
SourceHttpMessageConverter
XmlAwareFormHttpMessageConverter
Jaxb2RootElementHttpMessageConverter
MappingJacksonHttpMessageConverter[/quote]

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

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

[b][size=large]二、servlet.xml配置[/size][/b]

Spring的配置文件，简洁到了极致，对于当前这个需求只需要三行核心配置：

[b][size=large]三、pom.xml配置[/size][/b]

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

	
			org.springframework
			spring-webmvc
			3.1.2.RELEASE
			jar
			compile
		
		
			org.codehaus.jackson
			jackson-mapper-asl
			1.9.8
			jar
			compile
		
		
			log4j
			log4j
			1.2.17
			compile
		

主要需要[b]spring-webmvc[/b]、[b]jackson-mapper-asl[/b]两个包，其余依赖包Maven会帮你完成。至于[b]log4j[/b]，我还是需要看日志嘛。 :D
包依赖图：
[img]http://dl.iteye.com/upload/attachment/0072/1228/b888d31f-df29-3db9-9ce5-ea92598b7d15.png[/img]
至于版本，看项目需要吧！

[b][size=large]四、代码实现[/size][/b]

域对象：

public class Person implements Serializable {

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

	public Person() {
		// do nothing
	}
}

[color=red][b]这里需要一个空构造，由Spring转换对象时，进行初始化。[/b][/color] :D

[b]@ResponseBody，@RequestBody，@PathVariable [/b]
控制器：

@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;
	}
}

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

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

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

做个页面测试下：
[b]JS[/b]

	$(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...');
			}
		});

[b]Table[/b]

	
















		
			
id
			
		
		
			
name
			
		
		
			
status
			
		
		
			
			
		
	

[b][size=large]四、简单测试[/size][/b]

Get方式测试：
[img]http://dl.iteye.com/upload/attachment/0072/1230/914df7a1-283d-356f-a2ee-36a032da88ad.png[/img]

[img]http://dl.iteye.com/upload/attachment/0072/1232/45c8d191-7b7f-30b2-ab59-aeb24cc00c9a.png[/img]

Post方式测试：
[img]http://dl.iteye.com/upload/attachment/0072/1235/1c456f07-f063-3a83-825d-132453c2e52c.png[/img]

[img]http://dl.iteye.com/upload/attachment/0072/1237/021062be-765e-3d3b-817e-afe06132ed9a.png[/img]

[size=large]五、常见错误[/size]
POST操作时，我用$.post()方式，屡次失败，一直报各种异常：
[img]http://dl.iteye.com/upload/attachment/0072/1243/4f3f8424-a5e1-3ec1-8be1-f44fa8a48341.png[/img]

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

	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');
	};

效果是一样！ :D

详见附件！ :D

[b]相关参考：
[url=/blog/577989]Spring 注解学习手札（一） 构建简单Web应用[/url]
[url=/blog/578452]Spring 注解学习手札（二） 控制层梳理[/url]
[url=/blog/580194]Spring 注解学习手札（三） 表单页面处理[/url]
[url=/blog/583161]Spring 注解学习手札（四） 持久层浅析[/url]
[url=/blog/587602]Spring 注解学习手札（五） 业务层事务处理[/url]
[url=/blog/588351]Spring 注解学习手札（六） 测试[/url]
[url=/blog/1628861]Spring 注解学习手札（七） 补遗——@ResponseBody，@RequestBody，@PathVariable[/url]
[url=/blog/1636050]Spring 注解学习手札（八） 补遗——@ExceptionHandler[/url]
[/b]