早在我剛學(xué)Struts2之初的時(shí)候,就想寫一篇文章來闡述Struts2如何返回JSON數(shù)據(jù)的原理和具體應(yīng)用了,但苦于一直忙于工作難以抽身,漸漸的也淡忘了此事。直到前兩天有同事在工作中遇到這個(gè)問題,來找我詢問,我又細(xì)細(xì)地給他講了一遍之后,才覺得無論如何要抽一個(gè)小時(shí)的時(shí)間來寫這篇文章,從頭到尾將Struts2與JSON的關(guān)系說清楚。
其實(shí)網(wǎng)絡(luò)中,關(guān)于這個(gè)問題的答案已是海量,我當(dāng)初也是從這海量的答案中吸收精華,才將“Struts2返回JSON數(shù)據(jù)”這個(gè)問題搞清楚的。但是這些海量的答案,有一個(gè)共同的缺陷,就是作者們只關(guān)注問題核心,即“如何在具體的Struts2應(yīng)用中返回JSON數(shù)據(jù)到客戶端”如何實(shí)現(xiàn),而對于"為何要這樣實(shí)現(xiàn)"以及實(shí)現(xiàn)的本質(zhì)卻解釋的不甚了了,在筆者看來這只是“授人以魚”而非筆者所推崇的“授人以魚的同時(shí),授人以漁”。在這篇文章中,筆者將總結(jié)前輩們的經(jīng)驗(yàn),并結(jié)合自己的理解,來從理論到實(shí)踐由淺入深的說明“Struts2返回JSON數(shù)據(jù)”這一問題。
JSON(JavaScript Object Notation)
首先來看一下JSON官方對于“JSON”的解釋:
JSON(JavaScript Object Notation) 是一種輕量級的數(shù)據(jù)交換格式。易于人閱讀和編寫。同時(shí)也易于機(jī)器解析和生成。它基于JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999的一個(gè)子集。 JSON采用完全獨(dú)立于語言的文本格式,但是也使用了類似于C語言家族的習(xí)慣(包括C, C++, C#, Java, JavaScript, Perl, Python等)。這些特性使JSON成為理想的數(shù)據(jù)交換語言。(更多內(nèi)容請參見JSON官網(wǎng)http:///json-zh.html)
JSON建構(gòu)于兩種結(jié)構(gòu):
“名稱/值”對的集合(A collection of name/value pairs)。不同的語言中,它被理解為對象(object),紀(jì)錄(record),結(jié)構(gòu)(struct),字典(dictionary),哈希表(hash table),有鍵列表(keyed list),或者關(guān)聯(lián)數(shù)組 (associative array)。
值的有序列表(An ordered list of values)。在大部分語言中,它被理解為數(shù)組(array)。
因?yàn)镴SON中的值(value)可以是雙引號括起來的字符串(string)、數(shù)值(number)、true、false、 null、對象(object)或者數(shù)組(array),且這些結(jié)構(gòu)可以嵌套,這種特性給予JSON表達(dá)數(shù)據(jù)以無限的可能:它既可以表達(dá)一個(gè)簡單的key/value,也可以表達(dá)一個(gè)復(fù)雜的Map或List,而且它是易于閱讀和理解的。
Struts2中JSON的用武之地
因?yàn)镴SON是脫離語言的理想的數(shù)據(jù)交換格式,所以它被頻繁的應(yīng)用在客戶端與服務(wù)器的通信過程中,這一點(diǎn)是毋庸置疑的。而在客戶端與服務(wù)器的通信過程中,JSON數(shù)據(jù)的傳遞又被分為服務(wù)器向客戶端傳送JSON數(shù)據(jù),和客戶端向服務(wù)器傳送JSON數(shù)據(jù),前者的核心過程中將對象轉(zhuǎn)換成JSON,而后者的核心是將JSON轉(zhuǎn)換成對象,這是本質(zhì)的區(qū)別。另外,值得一提的是,JSON數(shù)據(jù)在傳遞過程中,其實(shí)就是傳遞一個(gè)普通的符合JSON語法格式的字符串而已,所謂的“JSON對象”是指對這個(gè)JSON字符串解析和包裝后的結(jié)果,這一點(diǎn)請牢記,因?yàn)橄旅娴膬?nèi)容會依賴這一點(diǎn)。
Struts2返回JSON數(shù)據(jù)到客戶端
這是最常見的需求,在AJAX大行其道的今天,向服務(wù)器請求JSON數(shù)據(jù)已成為每一個(gè)WEB應(yīng)用必備的功能。拋開Struts2暫且不提,在常規(guī)WEB應(yīng)用中由服務(wù)器返回JSON數(shù)據(jù)到客戶端有兩種方式:一是在Servlet中輸出JSON串,二是在JSP頁面中輸出JSON串。上文提到,服務(wù)器像客戶端返回JSON數(shù)據(jù),其實(shí)就是返回一個(gè)符合JSON語法規(guī)范的字符串,所以在上述兩種 方法中存在一個(gè)共同點(diǎn),就是將需要返回的數(shù)據(jù)包裝稱符合JSON語法規(guī)范的字符串后在頁面中顯示。如下所示
使用Servlet返回JSON數(shù)據(jù)到客戶端:
- package cn.ysh.studio.struts2.json.demo.servlet;
-
- import java.io.IOException;
- import java.io.PrintWriter;
-
- import javax.servlet.ServletException;
- import javax.servlet.http.HttpServlet;
- import javax.servlet.http.HttpServletRequest;
- import javax.servlet.http.HttpServletResponse;
-
- import net.sf.json.JSONObject;
-
- import cn.ysh.studio.struts2.json.demo.bean.User;
-
- public class JSON extends HttpServlet {
-
-
-
-
- private static final long serialVersionUID = 1L;
-
-
-
-
-
-
-
-
-
-
-
- public void doGet(HttpServletRequest request, HttpServletResponse response)
- throws ServletException, IOException {
-
- response.setContentType("text/html");
- PrintWriter out = response.getWriter();
-
- User user=new User();
- user.setId("123");
- user.setName("JSONServlet");
- user.setPassword("JSON");
- user.setSay("Hello , i am a servlet !");
- JSONObject json=new JSONObject();
- json.accumulate("success", true);
- json.accumulate("user", user);
- out.println(json.toString());
-
-
-
-
- out.flush();
- out.close();
- }
-
-
-
-
-
-
-
-
-
-
-
- public void doPost(HttpServletRequest request, HttpServletResponse response)
- throws ServletException, IOException {
- doGet(request, response);
- }
-
- }
結(jié)果在意料之中,如下圖所示:
使用JSP(或html等)返回JSON數(shù)據(jù)到客戶端:
- <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
- {"user":{"id":"123","name":"JSONJSP","say":"Hello , i am a JSP !","password":"JSON"},"success":true}
這個(gè)就不用去看結(jié)果了吧。
再回到Struts,在Struts的MVC模型中,Action替代Servlet擔(dān)當(dāng)了Model的角色,所以對于Struts而言,返回JSON數(shù)據(jù)到客戶端,跟傳統(tǒng)的WEB應(yīng)用一樣,存在兩種方式,即在Action中輸出JSON數(shù)據(jù),和在視圖資源中輸出JSON數(shù)據(jù)。再往下細(xì)分的話,在Action中輸出JSON數(shù)據(jù)又分為兩種方式,一是使用傳統(tǒng)方式輸出自己包裝后的JSON數(shù)據(jù),二是使用Struts自帶的JSON數(shù)據(jù)封裝功能來自動包裝并返回JSON數(shù)據(jù)。
在視圖資源中輸出JSON數(shù)據(jù)
Action處理完用戶請求后,將數(shù)據(jù)存放在某一位置,如request中,并返回視圖,然后Struts將跳轉(zhuǎn)至該視圖資源,在該視圖中,我們需要做的是將數(shù)據(jù)從存放位置中取出,然后將其轉(zhuǎn)換為JSON字符串,輸出在視圖中。這跟傳統(tǒng)WEB應(yīng)用中在JSP頁面輸出JSON數(shù)據(jù)的做法如出一轍:
- public String testByJSP() {
- User user = new User();
- user.setId("123");
- user.setName("Struts2");
- user.setPassword("123");
- user.setSay("Hello world !");
- JSONObject jsonObject=new JSONObject();
- jsonObject.accumulate("user", user);
-
- ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());
- return SUCCESS;
- };
因?yàn)槭浅R?guī)的Struts流程配置,所以配置內(nèi)容就不再展示了。
JSP代碼就非常簡單了,
- <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
- ${data }
結(jié)果如圖所示:
在Action中以傳統(tǒng)方式輸出JSON數(shù)據(jù)
這一點(diǎn)跟傳統(tǒng)的Servlet的處理方式基本上一模一樣,代碼如下
- public void doAction() throws IOException{
- HttpServletResponse response=ServletActionContext.getResponse();
-
- response.setContentType("text/html");
- PrintWriter out;
- out = response.getWriter();
-
- User user=new User();
- user.setId("123");
- user.setName("JSONActionGeneral");
- user.setPassword("JSON");
- user.setSay("Hello , i am a action to print a json!");
- JSONObject json=new JSONObject();
- json.accumulate("success", true);
- json.accumulate("user", user);
- out.println(json.toString());
-
-
-
-
- out.flush();
- out.close();
- }
struts.xml中的配置:
- <package name="default" extends="struts-default" namespace="/">
- <action name="testJSONFromActionByGeneral" class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction">
- </action>
- </package>
注意:這個(gè)action沒有result,且doAction方法沒有返回值!
就不再貼圖了,因?yàn)榻Y(jié)果可想而知!
在Action中以Struts2的方式輸出JSON數(shù)據(jù)
本著“不重復(fù)發(fā)明輪子”的原則,我們將轉(zhuǎn)換JSON數(shù)據(jù)的工作交給Struts2來做,那么相對于在Action中以傳統(tǒng)方式輸出JSON不同的是,Action是需要將注意力放在業(yè)務(wù)處理上,而無需關(guān)心處理結(jié)果是如何被轉(zhuǎn)換成JSON被返回客戶端的——這些 工作通過簡單的配置,Struts2會幫我們做的更好。
- public String testByAction() {
-
- dataMap.clear();
- User user = new User();
- user.setId("123");
- user.setName("JSONActionStruts2");
- user.setPassword("123");
- user.setSay("Hello world !");
- dataMap.put("user", user);
-
- dataMap.put("success", true);
-
- return SUCCESS;
- }
struts.xml中action的配置:
- <package name="json" extends="json-default" namespace="/test">
- <action name="testByAction"
- class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByAction">
- <result type="json">
- <!-- 這里指定將被Struts2序列化的屬性,該屬性在action中必須有對應(yīng)的getter方法 -->
- <param name="root">dataMap</param>
- </result>
- </action>
- </package>
凡是使用Struts2序列化對象到JSON的action,所在的package必須繼承自json-default,注意,這里唯一的result,沒有指定name屬性。
結(jié)果如下圖所示:
上面很詳細(xì)的說明了在WEB應(yīng)用中如何返回JSON數(shù)據(jù)到客戶端,講了那么多種方式,涉及的技術(shù)核心無非只有兩點(diǎn):
1、將對象轉(zhuǎn)換成符合JSON語法格式的字符串;
2、將符合JSON語法格式的字符串返回客戶端;
第二點(diǎn)是整個(gè)實(shí)現(xiàn)過程的本質(zhì),但卻不難做到;第一點(diǎn)其實(shí)也不難,他甚至有兩種做法,一是通過字符串拼接方式,而是通過JSONObject以對象方式轉(zhuǎn)換。看下面的一個(gè)例子:
- package cn.ysh.studio.struts2.json.demo.test;
-
- import cn.ysh.studio.struts2.json.demo.bean.User;
- import net.sf.json.JSONObject;
-
- public class JSONTest {
-
-
-
-
-
- public JSONObject bean2json() {
- User user = new User();
- user.setId("JSONTest");
- user.setName("JSONTest");
- user.setPassword("JSON");
- user.setSay("Hello,i am JSONTest.java");
- JSONObject jsonObject = new JSONObject();
- jsonObject.accumulate("user", user);
- System.out.println("User轉(zhuǎn)換后的字符串:"+jsonObject.toString());
- return jsonObject;
- }
-
-
-
-
-
- public void json2bean(JSONObject jsonObject) {
- User user=(User)JSONObject.toBean((JSONObject)jsonObject.get("user"),User.class);
- System.out.println("轉(zhuǎn)換得到的User對象的Name為:"+user.getName());
- }
-
- public static void main(String[] s) {
- JSONTest tester=new JSONTest();
- tester.json2bean(tester.bean2json());
- }
- }
JSON格式的字符串返回到客戶端后,客戶端會將其解析并封裝成真正的JSON對象,以供JS調(diào)用。
總結(jié)上述,其實(shí)只要明白了服務(wù)器返回JSON數(shù)據(jù)到客戶端的原理,做起來就游刃有余了,他甚至有非常多的可選方案,但既然是基于Struts2的實(shí)現(xiàn),那么肯定還是要用Struts2的方式來做啦,因?yàn)檫@樣確實(shí)可以省很多事。另外,在文章的最后,說明一下返回JSON數(shù)據(jù)時(shí)在result中配置的參數(shù)的含義及其常見常見配置吧:
- <result type="json">
- <!-- 這里指定將被Struts2序列化的屬性,該屬性在action中必須有對應(yīng)的getter方法 -->
- <!-- 默認(rèn)將會序列所有有返回值的getter方法的值,而無論該方法是否有對應(yīng)屬性 -->
- <param name="root">dataMap</param>
- <!-- 指定是否序列化空的屬性 -->
- <param name="excludeNullProperties">true</param>
- <!-- 這里指定將序列化dataMap中的那些屬性 -->
- <param name="includeProperties">
- userList.*
- </param>
- <!-- 這里指定將要從dataMap中排除那些屬性,這些排除的屬性將不被序列化,一半不與上邊的參數(shù)配置同時(shí)出現(xiàn) -->
- <param name="excludeProperties">
- SUCCESS
- </param>
- </result>
值得一提的是通過Struts2來返回JSON數(shù)據(jù),在IE中會提示下載,這個(gè)不用關(guān)心,換個(gè)瀏覽器就能正常展示JSON數(shù)據(jù),而在JS調(diào)用中,更是毫無影響。
下面是整個(gè)Action的完整代碼:
- package cn.ysh.studio.struts2.json.demo.action;
-
- import java.io.IOException;
- import java.io.PrintWriter;
- import java.util.HashMap;
- import java.util.Map;
-
- import javax.servlet.http.HttpServletResponse;
-
- import org.apache.struts2.ServletActionContext;
-
- import net.sf.json.JSONObject;
-
- import cn.ysh.studio.struts2.json.demo.bean.User;
-
- import com.opensymphony.xwork2.ActionSupport;
-
- public class UserAction extends ActionSupport {
-
-
-
-
- private static final long serialVersionUID = 1L;
-
-
- private Map<String, Object> dataMap;
-
-
-
-
- public UserAction() {
-
- dataMap = new HashMap<String, Object>();
- }
-
-
-
-
-
- public String testByJSP() {
- User user = new User();
- user.setId("123");
- user.setName("JSONActionJSP");
- user.setPassword("123");
- user.setSay("Hello world !");
- JSONObject jsonObject=new JSONObject();
- jsonObject.accumulate("user", user);
- jsonObject.accumulate("success", true);
-
- ServletActionContext.getRequest().setAttribute("data", jsonObject.toString());
- return SUCCESS;
- };
-
-
-
-
-
- public String testByAction() {
-
- dataMap.clear();
- User user = new User();
- user.setId("123");
- user.setName("JSONActionStruts2");
- user.setPassword("123");
- user.setSay("Hello world !");
- dataMap.put("user", user);
-
- dataMap.put("success", true);
-
- return SUCCESS;
- }
-
-
-
-
-
- public void doAction() throws IOException{
- HttpServletResponse response=ServletActionContext.getResponse();
-
- response.setContentType("text/html");
- PrintWriter out;
- out = response.getWriter();
-
- User user=new User();
- user.setId("123");
- user.setName("JSONActionGeneral");
- user.setPassword("JSON");
- user.setSay("Hello , i am a action to print a json!");
- JSONObject json=new JSONObject();
- json.accumulate("success", true);
- json.accumulate("user", user);
- out.println(json.toString());
-
-
-
-
- out.flush();
- out.close();
- }
-
-
-
-
-
- public Map<String, Object> getDataMap() {
- return dataMap;
- }
-
- }
完整的struts.xml配置文件如下:
- <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
- "http://struts./dtds/struts-2.0.dtd">
- <struts>
- <package name="json" extends="json-default" namespace="/test">
- <action name="testByAction"
- class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByAction">
- <result type="json">
-
-
- <param name="root">dataMap</param>
-
-
-
-
-
- <!--
- <param name="includeProperties">
- userList.*
- </param>
- -->
-
- <!--
- <param name="excludeProperties">
- SUCCESS
- </param>
- -->
- </result>
- </action>
- </package>
- <package name="default" extends="struts-default" namespace="/">
- <action name="testJSONFromActionByGeneral"
- class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="doAction">
- </action>
- <action name="testByJSP"
- class="cn.ysh.studio.struts2.json.demo.action.UserAction" method="testByJSP">
- <result name="success">/actionJSP.jsp</result>
- </action>
- </package>
- </struts>
最后,附上整個(gè)范例工程(一個(gè)MyEclipse工程)源碼。
原創(chuàng)文章,轉(zhuǎn)載請注明出處:http://yshjava./blog/1333104