是甚么？

JSON 的全稱是 JavaScript Object Notation，是1種輕量級的數據交換格式。JSO N 與 XML 具有相同的特性，例如易于人編寫和瀏覽，易于機器生成和解析。但是 JSON 比 XML 數據傳輸的有效性要高出很多。JSON 完全獨立與編程語言，使用文本格式保存。

JSON 數據有兩種結構：

Name-Value 對構成的集合，類似于 Java 中的 Map。

Value 的有序列表，類似于 Java 中的 Array。

1個 JSON 格式的數據示例： 

更多關于 JSON 數據格式的說明參看 JSON 官方網站：http://www.json.org（中文 內容看：http://www.json.org/json-zh.html）

GWT 與 JSON

GWT 中支持的客戶端服務器端方法調用和數據傳遞的標準格式是 RPC。 JSON 其實不 是 GWT 支持的標準的數據傳遞格式。那末如何使用 JSON 來作為 GWT 的數據傳遞格式 呢？需要以下幾步。 

第1，援用 HTTP 和 JSON 支持。 第2，在客戶端創建 JSON 數據，提交到服務器

第3，在服務器上重寫數據格式解析的代碼，使之支持 JSON 格式的數據 第4，在服務器上組織 JSON 格式的數據，返回給客戶端。 第5，客戶端解析服務器傳回的 JSON 數據，正確的顯示

援用 HTTP 和 JSON 支持

找到.gwt.xml文件，在其中的

在以后添加以下的內容：

其中 com.google.gwt.json.JSON 指的是要使用 JSON，com.google.gwt.http.H TTP 值得是通過 HTTP 調用服務器上的服務方法。

客戶端構造 JSON 數據

客戶端需要使用 com.google.gwt.json.client 包內的類來組裝 JSON 格式的數據， 數據格式以下：

數據類型                                    說明

JSONArray                   JSONValue 構成的數組類型

JSONBoolean              JSON boolean的值

JSONException           訪問 JSON 結構的數據出錯的情況下可以拋出此異常

JSONNull                     JSON Null根式的數據

JSONNumber              JSON Number 類型的數據

JSONObject                 JSON Object 類型的數據

JSONParser                將 String 格式的 JSON 數據解析為 JSONValue 類 型的數據

JSONString                 JSON String 類型的數據

JSONValue                 所有 JSON 類型值的超級類型

組合1個簡單的 JSON 數據：

JSON 數據格式為：{name: "mazhao"}

組合1個包括數組類型的復雜 JSON 數據：

JSON 數據格式為：

注意上述的 JSON 類型的數據，使用的都是 com.google.gwt.json.client 包內的類 型。這些類型終究會被編譯為JavaScrip t 履行。

服務端重寫數據解析代碼，支持 JSON 格式的數據

在服務器上，需要使用 JSON Java 支持類才能將 JSON 格式的數據轉換為各種類型 的數據，固然也能夠自己寫1些解析用的代碼。這里我們使用了 www.json.org上的代碼 來完成。這組代碼與 com.google.gwt.json.client 的代碼很類似，只是在 org.json 包內部。

怎樣解析 JSON 術訣呢？針對上述中的復雜的 JSON 數據：

可使用以下的方式解析：

其中 payload 指的是上述的JSON 格式的數據。

那末如何寫 GWT 的 Service 來得到 Payload 的數據呢？需要兩點，第1，需要建立 1個Service 類，第2，覆蓋父類的 processCall 方法。

示例代碼：

在服務器上組織 JSON 格式的數據，返回給客戶端

同上

客戶端解析服務器傳回的 JSON 數據，正確的顯示 同上

包需求

Struts2返回json需要jsonplugin-0[1].25的包

Java 代碼

然后我們的配置文件中需要繼承 json-default

然后我們的 Action 中需要返回的 json 信息需要加上注解

Java 代碼

JSON Plugin的說明

Overview 

The JSON plugin provides a "json"result type that serializes actions into JSON. The serializa tion process is recursive, meaning that the whole object graph, starting on the action class (base class not included) will be serialized (root object can be customized using the "root" attribute). If the interceptor is used, the action will be populated from the JSON content in the request, these are the rules of the interceptor: 

1. The "content-type" must be "application/json"

2. The JSON content must be well formed, see json.org  for grammar.

3. Action must have a public "setter" method for fields that must be populated.

4. Supported types for population are: Primitives (int,long...String), Date, List,Map, Primitive Arrays, Other class (more on this later), and Array of Other class.

5. Any object in JSON, that is to be populated inside a list, or a map, will be of type Map

(mapping from properties to values), any whole number will be of type Long, any decimal number will be of type Double, and any array of typeList.

Given this JSON string:

The action must have a "setDoubleValue" method, taking either a "float" or a "double" argument (the interceptor will convert the value to the right one). There must be a "setNestedBean" whose argument type can be any class, that has a "setName" method taking as argument an "String". There must be a "setList" method thattakes a "List" as argument, that list will contain: "A" (String), 10 (Long), 20.20 (Double), Map ("firstName" -> "ElZorro"). The "setArray" method can take as parameter either a "List", or any numeric array.

Installation

This plugin can be installed by copying the plugin jar into your application's /WEB-INF/lib

directory. No other files need to be copied or created.

To use maven, add this to your pom:

Customizing Serialization and Deserialization 

Use the JSON annotation to customize the serializa tion/deseriali za tion process. Available JSON annotation fields:

Excluding properties

A comma-delimited list of regular expressions can be passed to the JSON Result and Interceptor, properties matching any of these regular expressions will be ignored on the serializa tion process:

Including properties

A comma-delimited list of regular expressions can be passed to the JSON Result to restrict which properties will be serialized. ONLY properties matchingany of these regular expressions will be included in the serialized output.

Note 

Exclude property expressions take precedence over includeproperty expressions. That is, if you use include and excludeproperty expressions on the same result, include property expressions will not be applied if an exclude excludeproperty expression matches a propertyfirst.

Root Object

Use the "root" attribute(OGNL expression) to specify the root object to be serialized.

The "root" attribute(OGNL expression) can also be used on the interceptor to specifytheobject that must be populated,make sure thisobject is not null.

Wrap with Comments

wrapWithComments can  turn safe  JSON text  into dangerous  text.  For example, 

["*/ alert('XSS'); /*"] 

Thanks to Douglas Crockford for the tip!

If the "wrapWithC omments" (false by default) attribute is set to true, the generated JSON is wrapped with comments like:

This can be used to avoid potential Javascript Hijacks.To strip those comments use:

varresponseObject = eval("("+data.substring(data.indexOf("\/\*")+2,data.lastIndexOf("\*\/"))+")");

Base Classes

By default properties defined on base classes of the "root" object won't be serialized, to serialize properties in all base classes (up to Object) set "ignoreHierarchy" to false in the JSON result:

Enumerations

By default, an Enum is serialized as a name=value pair where value = name().

Use the "enumAsBean" result parameter to serialize Enum's as a bean with a special property

_name with value name(). All properties of the enum are also serialized 

JSON: myEnum:{ "_name":"ValueA", "val": "A" }

Enable this parameter through struts.xml:

Compressing the output

Set the enableGZIP attribute to true to gzip the generated json response. The request must

include "gzip "in the "Accept-Encoding" header for this to work.

Example

Setup Action

This simple action has some fields:

Example:

Write the mapping for the action 

1. Add the map inside a package that extends "json-default"

2. Add a result of type "json" 

Example:

JSON example output

JSON RPC

First write the action:

package smd;

import com.googlecode.jsonplugin.annotations.SMDMethod;

import com.opensymphony.xwork2.Action;

Methods that will be called remotely must be annotated with the SMDMethodannotation, for security reasons. Themethod will take a bean object, modify its price and return it. The action can be annotated with the SMD annotation to customize the generated SMD (more on that soon), and parameters can be annotated with SMDMethodParameter. As you can see, we have a "dummy", smd method. This method will be used to generatethe Simple Method Definition (a definition of all the servicesprovided by this class), using the "json" result. 

The bean class: 

The mapping: 

Nothing special here, except that both the interceptor and the result must be applied to the action, and "enableSMD" must be enabled for both.

Now the javascript code:

Dojo's JsonService will make a request to the action to load the SMD, which will return a JSON object with the definition of the availableremote methods, using that information Dojo createsa "proxy" for those methods. Because of the asynchronous natureof the request, when the method is executed, a deferred object is returned, to which a callback functioncan be attached. The callback function will receive as a parameterthe object returned from your action. That's it.

Proxied objects

(V0.20) As annotations are not inherited in Java, some user might experienceproblems while trying to serialize objects that are proxied.eg. when you have attached AOP interceptors to your action.

In this situation, the plugin will not detect the annotations on methods in your action.

To overcome this, set the "ignoreInterfaces" result parameter to false (true by default) to request that the plugin inspects all interfacesand superclasses of the action for annotations on the action's methods.

NOTE: This parameter should only be set to false if your action could be a proxy as there is a performance cost caused by recursion through the interfaces

<action name="contact"class="package.ContactAction"method="smd">

<interceptor-ref name="json">

<param name="enableSMD">true</param>

<param name="ignoreSMDMethodInterfaces">false</param>

</interceptor-ref>

<result type="json">

<param name="enableSMD">true</param>

<param name="ignoreInterfaces">false</param>

</result>

<interceptor-ref name="default"/>

</action>

在 Struts2 中使用JSonajax支持

JSON 插件提供了1種名為 json 的 ResultType，1旦為某個 Action 指定了1個類型為 json 的 Result，則該 Result 無需映照到任何視圖資源。由于 JSON 插件會負責將 Action 里的狀態信息序列化成 JSON 格式的數據，并將該數據返 回給客戶端頁面的 JavaScr ipt 。

簡 單 地 說 ，JSON 插件允許我們在JavaScript 中異步調用 Action，而 且 Action 不再需要使用視圖資源來顯示該 Action 里的狀態信息，而是由 JSON 插件負責 將 Action 里的狀態信息返回給調用頁面——通過這類方式，就可以夠完成 Ajax 交互。

Struts2 提供了1種可插拔方式來管理插件，安裝 Struts2 的 JSON插件和安 裝普通插件并沒有太大的區分，相同只需要將 Struts2 插件的 JAR 文檔復制到 Web 利用的 WEB-INF/lib 路徑下便可。

安裝 JSON 插件按以下步驟進行：

（1）登 陸 http://code.google.com/p/jsonplugin/dow nloads/ list 站點，下載 Struts2 的 JSON 插件的最新版本，當前最新版本是 0.7，我們能夠下載該版本的 JSON 插件。

（2）將下載到的 jsonplugin-0.7.jar 文檔復制到 Web 利用的 WEB-INF 路徑下，便可完成 JSON 插件的安裝。 實現 Actio 邏輯假定 wo,en 輸入頁面中包括了3個表單域，這3個表單域對3個要求參 數，因此應當使用Action 來封裝這3個要求參數。3個表單域的 name 分別為 field1 、field2 和 field3 。

處理該要求的 Action 類代碼以下：

在上面代碼中，使用了 JSON 注釋，注釋時指定了 name 域，name 域指定 Action屬性被序列化成 JSON對象的屬性名。除此以外，JSON注釋還支持以下幾個域：

serialize ：配置是不是序列化該屬性。                           

deserialize ：配置是不是反序列化該屬性。 

format：配置用于格式化輸出、解析日期表單域的格式。例如"yyyy-MM-dd'T'HH:mm:ss"。

配置該 Action 和配置普通 Action存在小小的區分，應當為該 Action 配置 類型為 json 的 Result。而這個 Result 無需配置任何視圖資源。

配置該 Action 的 struts.xml 文檔代碼以下：

在上面配置文檔中有兩個值得注意的地方：

第1個地方是配置 struts.i18n.encod ing 常量時，不再是使用 GBK 編碼，而 是 UTF⑻ 編碼，這是由于 Ajax的 POST 要求都是以 UTF⑻的方式進行編碼的。