Struts2-Json-Plugin 的使用_第1页
Struts2-Json-Plugin 的使用_第2页
Struts2-Json-Plugin 的使用_第3页
Struts2-Json-Plugin 的使用_第4页
Struts2-Json-Plugin 的使用_第5页
已阅读5页，还剩6页未读， 继续免费阅读

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

1、Struts2-Json-Plugin 的使用在 Struts2 中要使用 Ajax 获得 Json 数据我认为目前还是 struts2-json-plugin 了。当然你你可以用手工用像 XStream、Google Gson、Jackson 这样的工具手工把 Java 对象转换成 Json 字符串再写往 Response 去，要写的代码自然多不了，还得留心字符集与 content type。而 struts2-json-plugin 毫无疑问是与 Struts2 最亲近了，只需你配置一些属性就能得到你想的结果。本想分几篇逐步介绍如何使用 struts2-json-plugin 的，然而就在

2、现在发现官方的 struts2-json-plugin 指南已经很详细了，所以干脆翻译一下 //docs/json-plugin.html，同时自己加深对它的理解。JSON 插件提供了一个 "json" 结果类型来把 action 序列化成 JSON. 这一序列化的过程是递归的, 意即整个对象图，从 action 类开始 (未包括基类) 将会被序列化 (可以用 "root" 属性来指定自己的根对象). 如果使用了 json 拦截器, action 将可通过请求中的 JSON 内容组装出来, 该拦

3、截器遵循以下几条规则:"content-type" 必须为 "application/json"JSON 内容必须是格式良好的, 参考 中的语法.Action 里必须有欲获取值的属性的相应 public 的 "setter" 方法.所支持的类型有: 原始类型 (int,long.String), Date, List, Map, 原始类型数组, 其他的类 (将会支持更多), 和其他类型的数组.JSON 中的任何将要被填入到 list 或 map 中的对象会是 Map 类型(属性映射到值), 任何整数都是 Long 类

4、型, 任何小数会是 Double 类型, 任何数组会是 List 类型.给定下面的 JSON 字符串: "doubleValue": 10.10, "nestedBean": "name": "Mr Bean" , "list": "A", 10, 20.20, "firstName": "El Zorro" , "array": 10, 20 action 中必须有一个 "setDoubleValue&q

5、uot; 方法, 参数为 "float" 或者 "double"(拦截器将会把值转换为相应的类型). 还必须有一个 "setNestedBean" 方法，它的参数类型可以为任何类类型, 其中含有参数为 "String" 的 "setName" 方法. 还必须有一个参数为 "List" 的 "setList" 方法, 这个 List 中将会包含: "A" (String), 10 (Long), 20.20 (Double), Map (

6、"firstName" -> "El Zorro"). "setArray" 方法可以是 "List", 或任何数字类型数组作参数的.序列化你的对象成 javascript 的 JSON, 参考 json2安装本插件可通过把插件 jar 包到你的应用的 /WEB-INF/lib 目录来完成安装. 没有别的文件需要拷贝或被创建.使用 maven 的话, 加入下列到你的 pom 中:<dependencies> . <dependency> <groupId>org.apach

7、e.struts</groupId> <artifactId>struts2-json-plugin</artifactId> <version>STRUTS_VERSION</version> </dependency> .</dependencies> 定制化序列化和反序列化使用 JSON 注解来达到定制序列化和反序列化过程. 可用的 JSON 注解如下:名称描述默认值序列化反序列化name定制字段名emptyyesnoserialize标识为可被序列化trueyesnodeserialize标识为可被反序

8、列化truenoyesformat用于格式化或解析 Date 字段的格式"yyyy-MM-dd'T'HH:mm:ss"yesyes排除属性逗号分隔的正则表达式列表可传递给 JSON Result 和 Interceptor(拦截器), 被任何 一个正则表达式匹配的属性将会在序列化过程时忽略掉:<!- Result fragment -><result type="json"> <param name="excludeProperties"> login.password, stude

9、ntList.*.sin </param></result> <!- Interceptor fragment -><interceptor-ref name="json"> <param name="enableSMD">true</param> <param name="excludeProperties"> login.password, studentList.*.sin </param></interceptor-ref&g

10、t;包含属性逗号分隔的正则表达式列表可被传递给 JSON Result, 用于限制哪些属性可用于序列化. 只有当能够匹配任何一个正则表达式的属性才会包含在序列化输出中.注：排除属性表达式优先于包含属性的表达式. 那就是说, 如果包含和排除表达式应用于同一个结果, 包含表达式对于被排除表达式匹配到的属性是不起作用的.<!- Result fragment -><result type="json"> <param name="includeProperties"> entriesd+.clientNumber, entr

11、iesd+.scheduleNumber, entriesd+.createUserId </param></result>根对象使用 "root" 属性(OGNL 表达式) 指定被用于序列化的根对象.<result type="json"> <param name="root"> person.job </param></result>"root" 属性(OGNL 表达式) 也可以用于拦截器来指定被组装的对象, 确保这个对象不会是 null.

12、<interceptor-ref name="json"> <param name="root">bean1.bean2</param></interceptor-ref>包装可能会有某些原因，你想要用些文本对 JSON 输出包装一下, 像用注释包裹, 加上前缀, 或使用文件上载让结果显示在 textarea 之中. 用 wrapPrefix 在开始处加上内容，wrapPostfix 添加内容在尾端. 这两个参数优先使用，而 "wrapWithComments" 和 "pref

13、ix" 自从 0.34 后就不推荐使用. 例子:进行注释:<result type="json"> <param name="wrapPrefix">/*</param> <param name="wrapSuffix">*/</param></result>添加前缀:<result type="json"> <param name="wrapPrefix">&&</p

14、aram></result> 包裹上传的文件内容:<result type="json"> <param name="wrapPrefix"><!CDATA<html><body><textarea>></param> <param name="wrapSuffix"><!CDATA</textarea></body></html>></param></re

15、sult>包裹以注释wrapWithComments 自 0.34 不推荐使用, 建议用 wrapPrefix 和 wrapSuffix.wrapWithComments 可使得安全的 JSON 文本变得不安全. 例如,"*/ alert('XSS'); /*"谢谢 Douglas Crockford 的提示! 应考虑用 prefix.假如被序列化的 JSON 是 name: 'El Zorro'. 那么此时输出就会是: && (name: 'El Zorro'假如 "wrapWithComme

16、nts" (默认为 false) 属性被设为 true, 生成的被包裹上注释的 JSON 就如下:/* "doubleVal": 10.10, "nestedBean": "name": "Mr Bean" , "list": "A", 10, 20.20, "firstName": "El Zorro" , "array": 10, 20 */ 欲取消上面的注释，可用:var responseObject

17、 = eval("("+data.substring(data.indexOf("/*")+2, data.lastIndexOf("*/")+")");前缀prefix 从 0.34 后不建议用, 请用 wrapPrefix 和 wrapSuffix.假如参数 prefix 被设置为 true, 生成的 JSON 将被附上前缀 "&& ". 这有助于防止被劫持. 详细内容请看 this Dojo Ticket:<result type="json"&g

18、t; <param name="prefix">true</param></result>基类默认时，定义在 "root" 对象的基类中的属性不会被序列化, 要序列化来自于所有基类(直到 Object) 中的属性，需在 JSON result 里设置 "ignoreHierarchy" 为 false:<result type="json"> <param name="ignoreHierarchy">false</param&g

19、t;</result>枚举类型默认的, Enum 被序列化为 name=value 对，这里的 value = name(). public enum AnEnum ValueA, ValueB JSON: "myEnum":"ValueA"使用 result 的参数 "enumAsBean" 可使得 Enum 像一个 bean 一样的被序列化，特定的属性为 _name，值为 name(). 所有的枚举属性都会被序列化. public enum AnEnum ValueA("A"), ValueB(&q

20、uot;B"); private String val; public AnEnum(val) this.val = val; public getVal() return val; JSON: myEnum: "_name": "ValueA", "val": "A" 在 struts.xml 中启用该参数:<result type="json"> <param name="enumAsBean">true</param><

21、;/result>压缩输出.设置 enableGZIP 属性为 true 可用 gzip 压缩响应输出. 在请求后 "Accept-Encoding" 头中必须包含 "gzip" 才能正常工作.<result type="json"> <param name="enableGZIP">true</param></result>防止浏览器缓存响应数据noCache 设置为 true(默认为 false) 会设置如下响应头:Cache-Control: no-cac

22、heExpires: 0Pragma: No-cache<result type="json"> <param name="noCache">true</param></result>排除值为 null 的属性默认的，为 null 的字段也被序列化，生成像 property_name: null. 这能够通过设置 excludeNullProperties 为 true 来防止.<result type="json"> <param name="exclude

23、NullProperties">true</param></result>状态和错误代码使用 statusCode 来设置响应状态代码:<result type="json"> <param name="statusCode">304</param></result>同时可用 errorCode 来发送一个错误(the server might end up sending something to the client which is not the serial

24、ized JSON):<result type="json"> <param name="errorCode">404</param></result>JSONPTo enable JSONP, set the parameter callbackParameter in either the JSON Result or the Interceptor. A parameter with that name will be read from the request, and it value will

25、be used as the JSONP function. Assuming that a request is made with the parameter "callback"="exec":<result type="json"> <param name="callbackParameter">callback</param></result>And that the serialized JSON is name: 'El Zorro'.

26、Then the output will be: exec(name: 'El Zorro')Content TypeContent type will be set to application/json-rpc by default if SMD is being used, or application/json otherwise. Sometimes it is necessary to set the content type to something else, like when uploading files with Dojo and YUI. Use th

27、e contentType parameter in those cases.<result type="json"> <param name="contentType">text/html</param></result>ExampleSetup ActionThis simple action has some fields:Example:import java.util.HashMap;import java.util.Map; import com.opensymphony.xwork2.Acti

28、on; public class JSONExample private String field1 = "str" private int ints = 10, 20; private Map map = new HashMap(); private String customName = "custom" /'transient' fields are not serialized private transient String field2; /fields without getter method are not serial

29、ized private String field3; public String execute() map.put("John", "Galt"); return Action.SUCCESS; public String getField1() return field1; public void setField1(String field1) this.field1 = field1; public int getInts() return ints; public void setInts(int ints) s = ints

30、; public Map getMap() return map; public void setMap(Map map) this.map = map; JSON(name="newName") public String getCustomName() return this.customName; Write the mapping for the actionAdd the map inside a package that extends "json-default"Add a result of type "json"Ex

31、ample:<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE struts PUBLIC "-/Apache Software Foundation/DTD Struts Configuration 2.0/EN" "/dtds/struts-2.0.dtd"> <struts> <package name="example" extends="jso

32、n-default"> <action name="JSONExample"> <result type="json"/> </action> </package> </struts>JSON example output "field1" : "str", "ints": 10, 20, "map": "John":"Galt" , "newName

33、": "custom"JSON RPCThe json plugin can be used to execute action methods from JavaScript and return the output. This feature was developed with Dojo in mind, so it uses Simple Method Definition to advertise the remote service. Let's work it out with an example(useless as most exam

34、ples).First write the action:package smd; import com.googlecode.jsonplugin.annotations.SMDMethod;import com.opensymphony.xwork2.Action; public class SMDAction public String smd() return Action.SUCCESS; SMDMethod public Bean doSomething(Bean bean, int quantity) bean.setPrice(quantity * 10); return be

35、an; Methods that will be called remotely must be annotated with the SMDMethod annotation, for security reasons. The method 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 c

36、an be annotated with SMDMthodParameter. As you can see, we have a "dummy", smd method. This method will be used to generate the Simple Method Definition (a definition of all the services provided by this class), using the "json" result.The bean class:package smd; public class Bea

37、n private String type; private int price; public String getType() return type; public void setType(String type) this.type = type; public int getPrice() return price; public void setPrice(int price) this.price = price; The mapping:<package name="RPC" namespace="/nodecorate" ext

38、ends="json-default"> <action name="SMDAction" method="smd"> <interceptor-ref name="json"> <param name="enableSMD">true</param> </interceptor-ref> <result type="json"> <param name="enableSMD&quo

39、t;>true</param> </result> </action></package>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:<s:url id="smdUrl" namespace="/nod

40、ecorate" action="SMDAction" /><script type="text/javascript"> /load dojo RPC dojo.require("dojo.rpc.*"); /create service object(proxy) using SMD (generated by the json result) var service = new dojo.rpc.JsonService("$smdUrl"); /function called wh

41、en remote method returns var callback = function(bean) alert("Price for " + bean.type + " is " + bean.price); ; /parameter var bean = type: "Mocca" /execute remote method var defered = service.doSomething(bean, 5); /attach callback to defered object defered.addCallback(callback);</script>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 available remote methods, using that information Dojo creates a "proxy" for those methods. Because of the hronous nature of the re

人人文库> 全部分类> 教育资料 > 辅导培训

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论