深入了解Struts2返回JSON数据的原理及具体应用范例
早在我刚学Struts2之初的时候,就想写一篇文章来阐述Struts2如何返回JSON数据的原理和具体应用了,但苦于一直忙于工作难以抽身,渐渐的也淡忘了此事。直到前两天有同事在工作中遇到这个问题,来找我询问,我又细细地给他讲了一遍之后,才觉得无论如何要抽一个小时的时间来写这篇文章,从头到尾将Struts2与JSON的关系说清楚。
其实网络中,关于这个问题的答案已是海量,我当初也是从这海量的答案中吸收精华,才将“Struts2返回JSON数据”这个问题搞清楚的。但是这些海量的答案,有一个共同的缺陷,就是作者们只关注问题核心,即“如何在具体的Struts2应用中返回JSON数据到客户端”如何实现,而对于"为何要这样实现"以及实现的本质却解释的不甚了了,在笔者看来这只是“授人以鱼”而非笔者所推崇的“授人以鱼的同时,授人以渔”。在这篇文章中,笔者将总结前辈们的经验,并结合自己的理解,来从理论到实践由浅入深的说明“Struts2返回JSON数据”这一问题。
JSON(JavaScript Object Notation)
首先来看一下JSON官方对于“JSON”的解释:
JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999的一个子集。 JSON采用完全独立于语言的文本格式,但是也使用了类似于C语言家族的习惯(包括C, C++, C#, Java, JavaScript, Perl, Python等)。这些特性使JSON成为理想的数据交换语言。(更多内容请参见JSON官网http://json.org/json-zh.html)
JSON建构于两种结构:
“名称/值”对的集合(A collection of name/value pairs)。不同的语言中,它被理解为对象(object),纪录(record),结构(struct),字典(dictionary),哈希表(hash table),有键列表(keyed list),或者关联数组 (associative array)。
值的有序列表(An ordered list of values)。在大部分语言中,它被理解为数组(array)。
因为JSON中的值(value)可以是双引号括起来的字符串(string)、数值(number)、true、false、 null、对象(object)或者数组(array),且这些结构可以嵌套,这种特性给予JSON表达数据以无限的可能:它既可以表达一个简单的 key/value,也可以表达一个复杂的Map或List,而且它是易于阅读和理解的。
Struts2中JSON的用武之地
因为JSON是脱离语言的理想的数据交换格式,所以它被频繁的应用在客户端与服务器的通信过程中,这一点是毋庸置疑的。而在客户端与服务器的通信过程中,JSON数据的传递又被分为服务器向客户端传送JSON数据,和客户端向服务器传送JSON数据,前者的核心过程中将对象转换成JSON,而后者的核心是将JSON转换成对象,这是本质的区别。另外,值得一提的是,JSON数据在传递过程中,其实就是传递一个普通的符合JSON语法格式的字符串而已,所谓的“JSON对象”是指对这个JSON字符串解析和包装后的结果,这一点请牢记,因为下面的内容会依赖这一点。
Struts2返回JSON数据到客户端
这是最常见的需求,在AJAX大行其道的今天,向服务器请求JSON数据已成为每一个WEB应用必备的功能。抛开Struts2暂且不提,在常规WEB应用中由服务器返回JSON数据到客户端有两种方式:一是在Servlet中输出JSON串,二是在JSP页面中输出JSON串。上文提到,服务器像客户端返回JSON数据,其实就是返回一个符合JSON语法规范的字符串,所以在上述两种 方法中存在一个共同点,就是将需要返回的数据包装称符合JSON语法规范的字符串后在页面中显示。如下所示
使用Servlet返回JSON数据到客户端:
01 package cn.ysh.studio.struts2.json.demo.servlet;
02
03 import java.io.IOException;
04 import java.io.PrintWriter;
05
06 import javax.servlet.ServletException;
07 import javax.servlet.http.HttpServlet;
08 import javax.servlet.http.HttpServletRequest;
09 import javax.servlet.http.HttpServletResponse;
10
11 import net.sf.json.JSONObject;
12
13 import cn.ysh.studio.struts2.json.demo.bean.User;
14
15 public class JSON extends HttpServlet {
16
17 /**
18 *
19 */
20 private static final long serialVersionUID = 1L;
21
22 /**
23 * The doGet method of the servlet. <br>
24 *
25 * This method is called when a form has its tag value method equals to get.
26 *
27 * @param request the request send by the client to the server
28 * @param response the response send by the server to the client
29 * @throws ServletException if an error occurred
30 * @throws IOException if an error occurred
31 */
32 public void doGet(HttpServletRequest request, HttpServletResponse response)
33 throws ServletException, IOException {
34
35 response.setContentType("text/html");
36 PrintWriter out = response.getWriter();
37 //将要被返回到客户端的对象
38 User user=new User();
39 user.setId("123");
40 user.setName("JSONServlet");
41 user.setPassword("JSON");
42 user.setSay("Hello , i am a servlet !");
43 JSONObject json=new JSONObject();
44 json.accumulate("success", true);
45 json.accumulate("user", user);
46 out.println(json.toString());
47 // 因为JSON数据在传递过程中是以普通字符串形式传递的,所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端
48 // 以下这两句的作用与38-46行代码的作用是一样的,将向客户端返回一个User对象,和一个success字段
49 // String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONServlet\",\"say\":\"Hello , i am a servlet !\",\"password\":\"JSON\"},\"success\":true}";
50 // out.println(jsonString);
51 out.flush();
52 out.close();
53 }
54
55 /**
56 * The doPost method of the servlet. <br>
57 *
58 * This method is called when a form has its tag value method equals to post.
59 *
60 * @param request the request send by the client to the server
61 * @param response the response send by the server to the client
62 * @throws ServletException if an error occurred
63 * @throws IOException if an error occurred
64 */
65 public void doPost(HttpServletRequest request, HttpServletResponse response)
66  
补充:web前端 , JavaScript ,