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 中支持的客户端服务器端方法调用和数据传递的标准格式是 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 调用服务器上的服务方法。
客户端需要使用 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 代码
Name | JSON Plugin |
Publisher |
MusachyBarroso |
License |
Open Source (ASL2) |
Version | 0.30 |
Compatibility |
Struts 2.0.6 or later |
Homepage |
http:/ /code.google.com/p/jsonplugin/ |
Download |
http:/ /code.google.com/p/jsonplugin/downloads/list |
Name |
JSON Plugin |
Publisher |
MusachyBarroso |
License |
Open Source (ASL2) |
Version | 0.30 |
Compatibility |
Struts 2.0.6 or later |
Homepage |
http:/ /code.google.com/p/jsonplugin/ |
Download |
http:/ /code.google.com/p/jsonplugin/downloads/list
|
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.
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:
Name |
Description |
Default Value |
Serialization |
Deserialization |
name |
Customize field name |
empty |
yes |
no |
serialize |
Include in serializa tion |
true |
yes |
no |
deserialize |
Include in deserializa tion |
true |
no |
yes |
format |
Format used to format/parse a Date field |
"yyyy-MM-dd'T'HH:mm:ss" |
yes |
yes |
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.
(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>
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⑻的方式进行编码的。
第2个地方是配置包时,自己的包继承了 json-default 包,而不再继承默许 的 default 包,这是由于只有在该包下才有 json 类型的 Result。
Json的对象的作用远不止于此,个人初步理解程度,demo中展现的只是json部份理解,欢迎交换学习。