最近须要作些接口服务,服务协议定为JSON,为了整合在Spring中,一开始确实费了很大的劲,经朋友提醒才发现,SpringMVC已经强悍到如此地步,佩服!
相关参考:
Spring 注解学习手札(一) 构建简单Web应用
Spring 注解学习手札(二) 控制层梳理
Spring 注解学习手札(三) 表单页面处理
Spring 注解学习手札(四) 持久层浅析
Spring 注解学习手札(五) 业务层事务处理
Spring 注解学习手札(六) 测试
Spring 注解学习手札(七) 补遗——@ResponseBody,@RequestBody,@PathVariable
Spring 注解学习手札(八) 补遗——@ExceptionHandler
SpringMVC层跟JSon结合,几乎不须要作什么配置,代码实现也至关简洁。不再用为了组装协议而劳烦辛苦了!
1、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
能够理解为,只要有对应协议的解析器,你就能够经过几行配置,几个注解完成协议——对象的转换工做!
PS:Spring默认的json协议解析由Jackson完成。
2、servlet.xml配置
Spring的配置文件,简洁到了极致,对于当前这个需求只须要三行核心配置:
Xml代码
- <context:component-scan base-package="org.zlex.json.controller" />
- <context:annotation-config />
- <mvc:annotation-driven />
3、pom.xml配置
闲言少叙,先说依赖配置,这里以Json+Spring为参考:
pom.xml
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-webmvc
、
jackson-mapper-asl
两个包,其他依赖包Maven会帮你完成。至于
log4j
,我仍是须要看日志嘛。
包依赖图:
至于版本,看项目须要吧!
4、代码实现
域对象:
Java代码
- public class Person implements Serializable {
-
- private int id;
- private String name;
- private boolean status;
-
- public Person() {
- // do nothing
- }
- }
这里须要一个空构造,由Spring转换对象时,进行初始化。
@ResponseBody,@RequestBody,@PathVariable
控制器:
Java代码
- @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式风格。
若是映射名称有所不一,能够参考以下方式:
Java代码
- @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
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
Html代码
- <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>
4、简单测试
Get方式测试:
Post方式测试:
5、常见错误
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代码
- 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');
- };
效果是同样!
详见附件!