程序博客网 > 网络宣传的趋势

深入了解Struts2返回JSON数据的原理及具体应用范例,从servlet 说起

来源：互联网 发布：网络宣传的趋势 编辑：程序博客网 时间：2024/04/29 08:37

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数据到客户端：

 

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
packagecn.ysh.studio.struts2.json.demo.servlet;
 
importjava.io.IOException;
importjava.io.PrintWriter;
 
importjavax.servlet.ServletException;
importjavax.servlet.http.HttpServlet;
importjavax.servlet.http.HttpServletRequest;
importjavax.servlet.http.HttpServletResponse;
 
importnet.sf.json.JSONObject;
 
importcn.ysh.studio.struts2.json.demo.bean.User;
 
publicclass JSON extendsHttpServlet {
 
    /**
     *
     */
    privatestatic final long serialVersionUID = 1L;
 
    /**
     * The doGet method of the servlet. <br>
     *
     * This method is called when a form has its tag value method equals to get.
     *
     * @param request the request send by the client to the server
     * @param response the response send by the server to the client
     * @throws ServletException if an error occurred
     * @throws IOException if an error occurred
     */
    publicvoid doGet(HttpServletRequest request, HttpServletResponse response)
            throwsServletException, IOException {
 
        response.setContentType("text/html");
        PrintWriter out = response.getWriter();
        //将要被返回到客户端的对象
        User user=newUser();
        user.setId("123");
        user.setName("JSONServlet");
        user.setPassword("JSON");
        user.setSay("Hello , i am a servlet !");
        JSONObject json=newJSONObject();
        json.accumulate("success", true);
        json.accumulate("user", user);
        out.println(json.toString());
//      因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端
//      以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段
//      String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONServlet\",\"say\":\"Hello , i am a servlet !\",\"password\":\"JSON\"},\"success\":true}";
//      out.println(jsonString);
        out.flush();
        out.close();
    }
 
    /**
     * The doPost method of the servlet. <br>
     *
     * This method is called when a form has its tag value method equals to post.
     *
     * @param request the request send by the client to the server
     * @param response the response send by the server to the client
     * @throws ServletException if an error occurred
     * @throws IOException if an error occurred
     */
    publicvoid doPost(HttpServletRequest request, HttpServletResponse response)
            throwsServletException, IOException {
        doGet(request, response);
    }
 
}

结果在意料之中，如下图所示:

 

 a1.jpg

 

 

使用JSP（或html等）返回JSON数据到客户端：

?
1
2
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
{"user":{"id":"123","name":"JSONJSP","say":"Hello , i am a JSP !","password":"JSON"},"success":true}

这个就不用去看结果了吧。

 

再回到Struts，在Struts的MVC模型中，Action替代Servlet担当了Model的角色，所以对于Struts而言，返回 JSON数据到客户端，跟传统的WEB应用一样，存在两种方式，即在Action中输出JSON数据，和在视图资源中输出JSON数据。再往下细分的话，在Action中输出JSON数据又分为两种方式，一是使用传统方式输出自己包装后的JSON数据，二是使用Struts自带的JSON数据封装功能来自动包装并返回JSON数据。

 

在视图资源中输出JSON数据


Action处理完用户请求后，将数据存放在某一位置，如request中，并返回视图，然后Struts将跳转至该视图资源，在该视图中，我们需要做的是将数据从存放位置中取出，然后将其转换为JSON字符串，输出在视图中。这跟传统WEB应用中在JSP页面输出JSON数据的做法如出一辙:

?
1
2
3
4
5
6
7
8
9
10
11
12
publicString testByJSP() {
        User user = newUser();
        user.setId("123");
        user.setName("Struts2");
        user.setPassword("123");
        user.setSay("Hello world !");
        JSONObject jsonObject=newJSONObject();
        jsonObject.accumulate("user", user);
        //这里在request对象中放了一个data，所以struts的result配置中不能有type="redirect"
        ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());
        returnSUCCESS;
    };

因为是常规的Struts流程配置，所以配置内容就不再展示了。

 

JSP代码就非常简单了,

?
1
2
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
${data }

结果如图所示:

 

 a2.jpg

 

在Action中以传统方式输出JSON数据


这一点跟传统的Servlet的处理方式基本上一模一样，代码如下

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
publicvoid doAction() throwsIOException{
        HttpServletResponse response=ServletActionContext.getResponse();
        //以下代码从JSON.java中拷过来的
        response.setContentType("text/html");
        PrintWriter out;
        out = response.getWriter();
        //将要被返回到客户端的对象
        User user=newUser();
        user.setId("123");
        user.setName("JSONActionGeneral");
        user.setPassword("JSON");
        user.setSay("Hello , i am a action to print a json!");
        JSONObject json=newJSONObject();
        json.accumulate("success", true);
        json.accumulate("user", user);
        out.println(json.toString());
//      因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端
//      以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段
//      String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONActionGeneral\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}";
//      out.println(jsonString);
        out.flush();
        out.close();
    }
struts.xml中的配置:
?
1
2
3
4
<packagename="default"extends="struts-default"namespace="/">
    <actionname="testJSONFromActionByGeneral"class="cn.ysh.studio.struts2.json.demo.action.UserAction"method="doAction">
    </action>
</package>

注意:这个action没有result，且doAction方法没有返回值!

 

就不再贴图了，因为结果可想而知!

 

 

在Action中以Struts2的方式输出JSON数据

本着“不重复发明轮子”的原则，我们将转换JSON数据的工作交给Struts2来做，那么相对于在Action中以传统方式输出JSON不同的是，Action是需要将注意力放在业务处理上，而无需关心处理结果是如何被转换成JSON被返回客户端的——这些 工作通过简单的配置，Struts2会帮我们做的更好。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
publicString testByAction() {
        // dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据
        dataMap.clear();
        User user = newUser();
        user.setId("123");
        user.setName("JSONActionStruts2");
        user.setPassword("123");
        user.setSay("Hello world !");
        dataMap.put("user", user);
        // 放入一个是否操作成功的标识
        dataMap.put("success", true);
        // 返回结果
        returnSUCCESS;
    }
struts.xml中action的配置:
?
1
2
3
4
5
6
7
8
9
<packagename="json"extends="json-default"namespace="/test">
        <actionname="testByAction"
            class="cn.ysh.studio.struts2.json.demo.action.UserAction"method="testByAction">
            <resulttype="json">
                <!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法 -->
                <paramname="root">dataMap</param>
            </result>
        </action>
</package>

凡是使用Struts2序列化对象到JSON的action，所在的package必须继承自json-default，注意，这里唯一的result，没有指定name属性。

 

结果如下图所示:

 

a3.jpg

 

 

上面很详细的说明了在WEB应用中如何返回JSON数据到客户端，讲了那么多种方式，涉及的技术核心无非只有两点：


1、将对象转换成符合JSON语法格式的字符串；
2、将符合JSON语法格式的字符串返回客户端；


第二点是整个实现过程的本质，但却不难做到；第一点其实也不难，他甚至有两种做法，一是通过字符串拼接方式，而是通过JSONObject以对象方式转换。看下面的一个例子：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
packagecn.ysh.studio.struts2.json.demo.test;
 
importcn.ysh.studio.struts2.json.demo.bean.User;
importnet.sf.json.JSONObject;
 
publicclass JSONTest {
 
    /**
     * 将普通的pojo转换成JSON字符串
     * @return
     */
    publicJSONObject bean2json() {
        User user = newUser();
        user.setId("JSONTest");
        user.setName("JSONTest");
        user.setPassword("JSON");
        user.setSay("Hello,i am JSONTest.java");
        JSONObject jsonObject = newJSONObject();
        jsonObject.accumulate("user", user);
        System.out.println("User转换后的字符串:"+jsonObject.toString());
        returnjsonObject;
    }
 
    /**
     * 从JSONObject对象中反向解析出User对象
     * @param jsonObject
     */
    publicvoid json2bean(JSONObject jsonObject) {
        User user=(User)JSONObject.toBean((JSONObject)jsonObject.get("user"),User.class);
        System.out.println("转换得到的User对象的Name为:"+user.getName());
    }
 
    publicstatic void main(String[] s) {
        JSONTest tester=newJSONTest();
        tester.json2bean(tester.bean2json());
    }
}

JSON格式的字符串返回到客户端后，客户端会将其解析并封装成真正的JSON对象，以供JS调用。

 


总结上述，其实只要明白了服务器返回JSON数据到客户端的原理，做起来就游刃有余了，他甚至有非常多的可选方案，但既然是基于 Struts2的实现，那么肯定还是要用Struts2的方式来做啦，因为这样确实可以省很多事。另外，在文章的最后，说明一下返回JSON数据时在 result中配置的参数的含义及其常见常见配置吧：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<resulttype="json">
                <!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法 -->
                <!-- 默认将会序列所有有返回值的getter方法的值，而无论该方法是否有对应属性 -->
                <paramname="root">dataMap</param>
                <!-- 指定是否序列化空的属性 -->
                <paramname="excludeNullProperties">true</param>
                <!-- 这里指定将序列化dataMap中的那些属性 -->
                <paramname="includeProperties">
                    userList.*
                </param>
                <!-- 这里指定将要从dataMap中排除那些属性，这些排除的属性将不被序列化，一半不与上边的参数配置同时出现 -->
                <paramname="excludeProperties">
                    SUCCESS
                </param>
</result>

值得一提的是通过Struts2来返回JSON数据，在IE中会提示下载，这个不用关心，换个浏览器就能正常展示JSON数据，而在JS调用中，更是毫无影响。

 

下面是整个Action的完整代码:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
packagecn.ysh.studio.struts2.json.demo.action;
 
importjava.io.IOException;
importjava.io.PrintWriter;
importjava.util.HashMap;
importjava.util.Map;
 
importjavax.servlet.http.HttpServletResponse;
 
importorg.apache.struts2.ServletActionContext;
 
importnet.sf.json.JSONObject;
 
importcn.ysh.studio.struts2.json.demo.bean.User;
 
importcom.opensymphony.xwork2.ActionSupport;
 
publicclass UserAction extendsActionSupport {
 
    /**
     *
     */
    privatestatic final long serialVersionUID = 1L;
 
    //将会被Struts2序列化为JSON字符串的对象
    privateMap<String, Object> dataMap;
 
    /**
     * 构造方法
     */
    publicUserAction() {
        //初始化Map对象
        dataMap = newHashMap<String, Object>();
    }
 
    /**
     * 测试通过action以视图方式返回JSON数据
     * @return
     */
    publicString testByJSP() {
        User user = newUser();
        user.setId("123");
        user.setName("JSONActionJSP");
        user.setPassword("123");
        user.setSay("Hello world !");
        JSONObject jsonObject=newJSONObject();
        jsonObject.accumulate("user", user);
        jsonObject.accumulate("success", true);
        //这里在request对象中放了一个data，所以struts的result配置中不能有type="redirect"
        ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());
        returnSUCCESS;
    };
 
    /**
     * 测试通过action以Struts2默认方式返回JSON数据
     * @return
     */
    publicString testByAction() {
        // dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据
        dataMap.clear();
        User user = newUser();
        user.setId("123");
        user.setName("JSONActionStruts2");
        user.setPassword("123");
        user.setSay("Hello world !");
        dataMap.put("user", user);
        // 放入一个是否操作成功的标识
        dataMap.put("success", true);
        // 返回结果
        returnSUCCESS;
    }
 
    /**
     * 通过action是以传统方式返回JSON数据
     * @throws IOException
     */
    publicvoid doAction() throwsIOException{
        HttpServletResponse response=ServletActionContext.getResponse();
        //以下代码从JSON.java中拷过来的
        response.setContentType("text/html");
        PrintWriter out;
        out = response.getWriter();
        //将要被返回到客户端的对象
        User user=newUser();
        user.setId("123");
        user.setName("JSONActionGeneral");
        user.setPassword("JSON");
        user.setSay("Hello , i am a action to print a json!");
        JSONObject json=newJSONObject();
        json.accumulate("success", true);
        json.accumulate("user", user);
        out.println(json.toString());
//      因为JSON数据在传递过程中是以普通字符串形式传递的，所以我们也可以手动拼接符合JSON语法规范的字符串输出到客户端
//      以下这两句的作用与38-46行代码的作用是一样的，将向客户端返回一个User对象，和一个success字段
//      String jsonString="{\"user\":{\"id\":\"123\",\"name\":\"JSONActionGeneral\",\"say\":\"Hello , i am a action to print a json!\",\"password\":\"JSON\"},\"success\":true}";
//      out.println(jsonString);
        out.flush();
        out.close();
    }
     
    /**
     * Struts2序列化指定属性时，必须有该属性的getter方法，实际上，如果没有属性，而只有getter方法也是可以的
     * @return
     */
    publicMap<String, Object> getDataMap() {
        returndataMap;
    }
 
}
完整的struts.xml配置文件如下:
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<?xmlversion="1.0"encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
    <packagename="json"extends="json-default"namespace="/test">
        <actionname="testByAction"
            class="cn.ysh.studio.struts2.json.demo.action.UserAction"method="testByAction">
            <resulttype="json">
                <!-- 这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法 -->
                <!-- 默认将会序列所有有返回值的getter方法的值，而无论该方法是否有对应属性 -->
                <paramname="root">dataMap</param>
                <!-- 指定是否序列化空的属性 -->
                <!--
                <param name="excludeNullProperties">true</param>
                -->
                <!-- 这里指定将序列化dataMap中的那些属性 -->
                <!--
                <param name="includeProperties">
                    userList.*
                </param>
                 -->
                <!--指定内容类型，默认为application/json，IE浏览器会提示下载-->
<!--<param name= "contentType">text/html</param> -->
                <!-- 这里指定将要从dataMap中排除那些属性，这些排除的属性将不被序列化，一半不与上边的参数配置同时出现 -->
                <!--
                <param name="excludeProperties">
                    SUCCESS
                </param>
                -->
            </result>
        </action>
    </package>
    <packagename="default"extends="struts-default"namespace="/">
        <actionname="testJSONFromActionByGeneral"
            class="cn.ysh.studio.struts2.json.demo.action.UserAction"method="doAction">
        </action>
        <actionname="testByJSP"
            class="cn.ysh.studio.struts2.json.demo.action.UserAction"method="testByJSP">
            <resultname="success">/actionJSP.jsp</result>
        </action>
    </package>
</struts>
 原创文章，转载请注明出处: http://yshjava.iteye.com/blog/1333104
0 0
网络宣传的趋势 网络宣传的趋势
原创粉丝点击
热门IT博客
淘宝服务商窦娥淘宝服务商窦娥
充了淘宝q币怎么退款充了淘宝q币怎么退款
2015年装备制造业数据
sql2005如何导入数据库
蜂窝移动数据网络apn
二分法查找c语言
code.org软件
电信网络测速软件
剑网三叶英捏脸数据
angular js 跨域访问
php源码 微信企业号
淘宝忙碌自动回复语句
锁屏解锁软件
华南师范大学网络登录
java程序员简历包装
美国就业数据公布网站
淘宝买抱枕
openwrt源码架构分析
js文字展开折叠效果
蒲公英刷商务通软件
热门问题 老师的惩罚 人脸识别 我在镇武司摸鱼那些年 重生之率土为王 我在大康的咸鱼生活 盘龙之生命进化 天生仙种 凡人之先天五行 春回大明朝 姑娘不必设防，我是瞎子 安全生产演讲稿 关于安全的手抄报 关于安全的知识 安全的重要性和意义 防溺水安全知识 安全是什么演讲稿 校园安全知识顺口溜 有关安全的作文 安全的定义是什么 安全市场下载 小学生安全知识 手机安全中心 安全中心手机版下载 安全英语怎么说 学校安全知识 安全常识教育 生产安全知识 安全中心首页 关于安全的名言 安全知识教育 安全培训内容 安全警示标语图片 施工安全警示标语 安全警示标语 无线网络安全技术 消防安全的重要性 安全生产事故应急预案 房屋安全鉴定收费标准 安全期避孕安全吗 工业安全与环保期刊 环境健康安全管理体系 网络与信息安全工程师 安全期安全吗 计算机网络安全工程师 信息系统安全等级保护 身边的安全隐患 内存怎么清理 内存如何清理 一键清 手机体检 清理内存垃圾

程序博客网，程序员的互联网技术博客家园。csdn论坛精品 msdn技术资料都在这里