strut2提供了支持json的插件 在项目中加入struts2-json-plugin-2.1.8.jar这个插件包。
在struts.xml中写package必须继承json-default、json-default继承自struts-default.
入下一个简单的示例:
<package name="fee" namespace="/fee" extends="json-default"> <action name="validateFee" class="com.tctoss.action.ValidateFeeAction"> <result name="success" type="json"> <!-- 指定root,会以指定的root为目标, 做json串,若不指定,默认Action为root。 --> <param name="root">pass</param> </result> </action> </package>
<action name="json" class="com.tctoss.action.LAction" > <result type="json" name="findData"> <param name="root">datas</param> <param name="includeProperties">success,totalcount</param> </result> <result type="json" name="findTree"> <param name="root">result</param> </result> </action>
1、result中type设置成json之后,容器会把action的属性自动封装到一个json对象中(json拦截器来做),然后调用ajax的callback方法. 返回json数据。
2、根对象在JSON中数据添加一个”root”标识。如果要使用它,Action必须遵循以下几点:
1)返回的页面类型中”content-type”必须是”application/json”;
2)JSON内容必须是符合格式要求的;
3)Action中field必须有public的set方法(是不是没有set方法就不会将field添加到JSON数据中,有待验证);
4)它支持的类型有: 基本类型(int,long...String), Date, List, Map, Primitive Arrays, 其它class, 对象数组;
5)在JSON中任何的Object会被封装在list或map中,数据会被封装程Long,如果是含有的数据则会被封装程Double,数组会被封装程List。
2、includeProperties 参数:输出结果中需要包含的属性值,这里正则表达式和属性名匹配,可以用“,”分割填充多个正则表达式。如:
<paramname="includeProperties">module.*,user\.userName</param>
表示是module的所有属性及用户的用户名。
3、excludeProperties 参数:输出结果需要排除的属性值,也支持正则表达式匹配属性名,可以用“,”分割填充多个正则表达式,类同includeProperties。
4、为什么要用includeProperties或excludeProperties参数:
主要是为了过滤掉接口,pojo的set、list、其它对象等不需要的数据防止循环取其它关联对象或找不到接口;
如果不配置,默认是处理 action中的所有属性,如果action中有接口注入,json拦截器可能找不到接口而返回不了结果;还有如果action中有一个对象,这个对象与好多对象都有关联,json拦截器会将相关联的所有对象的属性全部转换成json格式;如果其它对象有list、set,其返回结果相当庞大,有可能是死循环而无法返回。
如果不用<param name="includeProperties">或其他方式进行json数据过滤,通过debug你会发现前台返回的json字符串是把 action中的所有属性全部转化成json字符串返回给客户端(包括service接口、pojo所有属性及有关联的pojo。有时候根本返回不了结果,也不报错,后台执行了,但前台执行不到callback function,这主要是因为找不到接口或者关联的pojo太多,造成死循环),
一般情况下用的最多的就是root、 includeProperties 和excludeNullProperties参数。
当然还有其他的方法,如给pojo的属性加json注解。
5、result标签中的name属性,即表示是struts2中的action类中返回的名称如:
public String findUserById() throws Exception{ int id=Integer.parseInt( this.request.getParameter("id")); List<User> list=service.findById(id); return "findTree"; }
上面代码return "findTree"就会找到findTree的结果集,并将其封装起来,返回json给客户端。