Spring 返回json数据

 

参考：http://www.cnblogs.com/ssslinppp/p/4528892.html

 

《Spring学习笔记-MVC》系列文章，讲解返回json数据的文章共有3篇，分别为：

1. 【Spring学习笔记-MVC-3】SpringMVC返回Json数据-方式1：http://www.cnblogs.com/ssslinppp/p/4528892.html 
2. 【Spring学习笔记-MVC-4】返回Json数据-方式2：http://www.cnblogs.com/ssslinppp/p/4530002.html 
3. 【Spring学习笔记-MVC-3.1】SpringMVC返回Json数据-方式1-扩展：http://www.cnblogs.com/ssslinppp/p/4675495.html 

文章的内容主要如下：

1. 方式1：讲解如果返回单个对象的json；==>使用@ResponseBody来实现；注解方式
2. 方式2：讲解如果返回多个对象的json；==>使用MappingJacksonJsonView来实现；xml配置方式
3. 方式1-扩展：讲解如果返回多个对象的json；==>使用@ResponseBody来实现；注解方式

个人认为，使用@ResponseBody方式来实现json数据的返回比较方便，推荐使用。

---

 

摘要

---

使用Spring MVC，实现json数据的返回。

主要步骤：

1. 额外添加2个jar包；
2. 使用 @ResponseBody声明返回值；
3. 配置<mvc:annotation-driven />；==>需要引入：xmlns:mvc="http://www.springframework.org/schema/mvc"；

---

@ResponseBody：

作用： 

该注解用于将Controller方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后（如：json格式），写入到Response对象的body数据区。 

使用时机：

返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

---

<mvc:annotation-driven /> :

<mvc:annotation-driven /> 会自动注册

1. DefaultAnnotationHandlerMapping
2. AnnotationMethodHandlerAdapter 

两个bean，这两个bean是spring MVC为@Controllers分发请求所必须的。并提供了数据绑定支持，@NumberFormatannotation支持，@DateTimeFormat支持，@Valid支持，读写XML的支持（JAXB），读写JSON的支持（Jackson）。

---

 

需要的jar包

---

上面两个都是必须的。

 

 

 

项目结构

---

 

 

程序代码

---

Shop.java

---

1. package com.ll.model;
3. public class Shop {
4. String name;
5. String staffName[];
7. public String getName() {
8. return name;
9. }
10. public void setName(String name) {
11. this.name = name;
12. }
13. public String[] getStaffName() {
14. return staffName;
15. }
16. public void setStaffName(String[] staffName) {
17. this.staffName = staffName;
18. }
19. }

---

JSONController.java

---

1. package com.ll.controller;
3. import org.springframework.stereotype.Controller;
4. import org.springframework.web.bind.annotation.PathVariable;
5. import org.springframework.web.bind.annotation.RequestMapping;
6. import org.springframework.web.bind.annotation.RequestMethod;
7. import org.springframework.web.bind.annotation.ResponseBody;
8. import com.ll.model.Shop;
10. @Controller
11. @RequestMapping("/kfc/brands")
12. public class JSONController {
14. @RequestMapping(value="{name}", method = RequestMethod.GET)
15. public @ResponseBody Shop getShopInJSON(@PathVariable String name) {
16. System.out.println("-----请求json数据--------");
17. Shop shop = new Shop();
18. shop.setName(name);
19. shop.setStaffName(new String[]{"mkyong1", "mkyong2"});
21. return shop;
23. }
25. }

---

添加： @ResponseBody作为返回值。

---

web.xml

---

1. <web-appid="WebApp_ID"version="2.4"
2. xmlns="http://java.sun.com/xml/ns/j2ee"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3. xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
4. http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
6. <display-name>Spring Web MVC Application</display-name>
8. <context-param>
9. <param-name>contextConfigLocation</param-name>
10. <param-value>classpath:applicationContext.xml</param-value>
11. </context-param>
13. <listener>
14. <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
15. </listener>
17. <servlet>
18. <servlet-name>mvc-dispatcher</servlet-name>
19. <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
20. <load-on-startup>1</load-on-startup>
21. </servlet>
23. <servlet-mapping>
24. <servlet-name>mvc-dispatcher</servlet-name>
25. <url-pattern>/rest/*</url-pattern>
26. </servlet-mapping>
28. </web-app>

---

 

mvc-dispatcher-servlet.xml

---

1. <beansxmlns="http://www.springframework.org/schema/beans"
2. xmlns:context="http://www.springframework.org/schema/context"
3. xmlns:mvc="http://www.springframework.org/schema/mvc"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4. xsi:schemaLocation="
5. http://www.springframework.org/schema/beans
6. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
7. http://www.springframework.org/schema/context
8. http://www.springframework.org/schema/context/spring-context-3.0.xsd
9. http://www.springframework.org/schema/mvc
10. http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">
12. <context:component-scanbase-package="com.ll.controller"/>
14. <mvc:annotation-driven/>
16. </beans>

---

开启：<mvc:annotation-driven />

---

applicationContext.xml

---

1. <?xml version="1.0" encoding="UTF-8"?>
2. <beansxmlns="http://www.springframework.org/schema/beans"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:p="http://www.springframework.org/schema/p"
4. xmlns:context="http://www.springframework.org/schema/context"
5. xmlns:aop="http://www.springframework.org/schema/aop"xmlns:tx="http://www.springframework.org/schema/tx"
6. xsi:schemaLocation="http://www.springframework.org/schema/beans
7. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
8. http://www.springframework.org/schema/context
9. http://www.springframework.org/schema/context/spring-context-3.0.xsd
10. http://www.springframework.org/schema/tx
11. http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
12. http://www.springframework.org/schema/aop
13. http://www.springframework.org/schema/aop/spring-aop-3.0.xsd">
15. <!-- 扫描类包，将标注Spring注解的类自动转化Bean，同时完成Bean的注入 -->
16. <context:component-scanbase-package="com.ll.model"/>
18. </beans>

---

运行

---

参考网站

---

http://www.mkyong.com/spring-mvc/spring-3-mvc-and-json-example/ 

http://my.oschina.net/abian/blog/128028