struts2+hibernate+spring+jquery返回json List列表

浏览数：25 / 时间：2015年06月08日

1.引入包：struts2-json-plugin-2.1.8.1.jar json-lib-2.1.jar commons-collections-3.2.1.jar commons-beanutils-1.8.2.jar commons-lang-2.4.jar
ezmorph-1.0.6.jar,其他的包略，这几个包是返回json形式的数据必须的
2.<package name="default" extends="json-default">
3.<action name="test" class="com.TestAction" method="test">
<interceptor-ref name="json" />
<result type="json" />
</action>
4.只要继承extends="json-default"，json拦截器是默认配置上的，可以不配。result设置成json之后，容器会把action的属性自动封装到一个json对象中（json拦截器来做），然后调用js的callback方法. 返回json数据
5.如果按照3中的配置。你会发现前台返回的json字符串，是把action中的所有属性全部转化为json字符串返回给浏览器了（甚至有时候返回不了结果，也不报错，后台执行了，但前台执行不到callback function），但是我们有时候需要根据实际情况返回部分结果，如何对json的结果进行定制输出呢？result提供了一些参数替你解决这个问题，一般情况下用的最多的就是includeProperties 参数和excludeNullProperties参数。当然还有其他的方法，如给pojo的属性加json注解。
6.includeProperties 参数：输出结果中需要包含的属性值，这里正则表达式和属性名匹配，可以用“,”分割填充多个正则表达式。这个参数直接返回对象的json数据，前台不需要eval转换，<param name="root">result</param>则不同，需要前台进行eval转换
如：输出person的所有属性
<result type="json">
<param name="includeProperties">person.*, person\.name</param>
</result>
7.excludeProperties 参数：输出结果需要剔除的属性值，也支持正则表达式匹配属性名，可以用“,”分割填充多个正则表达式，类同includeProperties
8.输出一个JSON List列表
<action name="list" class="testAction" method="list">
<result name="success" type="json">
<param name="includeProperties">
list\[\d+\]\.Id,list\[\d+\]\.user\.userName
</param>
</result>
</action>
其中list是action中的一个List类型的属性
list\[\d+\]\.Id表示，list中存储的对象0..end的Id属性（list中存储的对象必须有Id属性）。
list\[\d+\]\.user\.userName就表示list中的对象中的user对象的userName属性
9.为什么要用includeProperties或者excludeProperties 参数：
主要是为了过滤掉接口，pojo的set、list、其他对象等不需要的数据防止循环取其他对象或找不到。如果不配置,默认是处理action中的所有属性，如果action中有接口注入，json拦截器可能找不到返回不了结果，还有如果action中有一个对象，这个对象与好多对象都有关联，json拦截器会将相关联的所有对象的属性全部转换成json格式，如果其他对象有list、set,其返回结果...有可能是死循环，无法返回
10.总结：
action中避免使用get开头的action方法,去掉action中的接口的get方法
为json类型的result配置includeProperties, excludeProperties等参数.

还有：http://cqjava.iteye.com/blog/465495

为了方便ajax调用传输数据，在struts2中加入的json插件用来做对象的序列化和反序列化，json插件的下载地址

http://code.google.com/p/jsonplugin/

1. 下载json插件包，将jar包拷贝到WEB-INF/lib目录

注：struts2的json插件有两个版本0.32和0.34，我用的struts2的版本是2.0.11，在加入0.34版本json插件时启动发生异常，提示找不到相关方法，后来就换成了低版本的0.32一切OK，仔细查看文档后发现struts2的2.0.*版本的对应插件的0.32版本，struts2.1.*版本对应0.34版本

2.json插件执行原理时序图

点击查看原图

3.将struts.xml里面的

Xml代码

<package name="default" extends="struts-default">

改为

Xml代码

<package name="default" extends="json-default">

4.Action中的配置

Xml代码

<action name="testAction" class="com.json.action.TestAction" method="testMethod">
<interceptor-ref name="json" />
<result type="json" />
</action>

注：根据需要选择interceptor和result配置

5. 你会发现前台返回的json字符串，是把action中的所有属性全部转化为json字符串返回给浏览器了，但是我有时候需要根据实际情况返回部分结果，如何对json的结果进行定制输出呢？result提供了一些参数替你解决这个问题

5.1. root参数：从返回结果中根据ognl表达式取出你需要输出的结果

如：

action类

Java代码

public class BaseAction extends ActionSupport implements {
private Person person = null;
...
}

bean类

Java代码

public class Person {
private String name;
private int age;
...
}

我们只要输出person对象的name属性值，配置如下

Xml代码

<result type="json">
<param name="root">person.name</param>
</result>

5.2. excludeNullProperties 参数：表示是否去掉空值，默认值是false，如果设置为true会自动将为空的值过滤，只输出不为空的值。

Xml代码

<result type="json">
<param name="excludeNullProperties">true</param>
</result>

5.3. ignoreHierarchy 参数：表示是否忽略等级，也就是继承关系，比如：TestAction继承于BaseAction，那么TestAction中返回的json字符串默认是不会包含父类BaseAction的属性值，ignoreHierarchy值默认为true，设置为false后会将父类和子类的属性一起返回。

Xml代码

<result type="json">
<param name="ignoreHierarchy">false</param>
</result>

5.4. includeProperties 参数：输出结果中需要包含的属性值，这里正则表达式和属性名匹配，可以用“,”分割填充多个正则表达式。

如：输出person的所有属性

Xml代码

<result type="json">
<param name="includeProperties">person.*, person\.name</param>
</result>

5.5. excludeProperties 参数：输出结果需要剔除的属性值，也支持正则表达式匹配属性名，可以用“,”分割填充多个正则表达式，类同5.4.

JSON（Java Script Object Notation），是一种语言无关的数据交换格式。
JSON插件是Structs 2 的Ajax插件，通过利用JSON插件，开发者可以很方便，灵活的利用Ajax进行开发。
Json是一种轻量级的数据交换格式，JSon插件提供了一种名为json的Action ResultType 。
一旦为Action指定了该结果处理类型，JSON插件就会自动将Action里的数据序列化成JSON格式的数据，
并返回给客户端物理视图的JavaScript。简单的说，JSON插件允许我们在JavaScript中异步的调用Action，
而且Action不需要指定视图来显示Action的信息显示。
而是由JSON插件来负责具体将Action里面具体的信息返回给调用页面。
Json的数据格式可简单如下形式： person = { name: ‘Jim‘,age: 18,gender: ‘man‘}。
如果action的属性很多，我们想要从Action返回到调用页面的数据。
这个时候配置includeProperties或者excludeProperties拦截器即可。
而这2个拦截器的定义都在struts2的json-default包内，所以要使用该拦截器的包都要继承自json-default。
<struts>
    <constant name="struts.objectFactory" value="spring"/>
    <include file="struts-admin.xml"></include>
    <package name="default" extends="json-default">
        <action name="person" class="com.person.PersonAction" method="view">
        <result type="json">
           <param name="includeProperties">
            person\.name,persoon\.age,person\.gender
           </param>>
        </result>
        </action>
    </package>
</struts>
利用Struts 2的支持的可配置结果，可以达到过滤器的效果。Action的处理结果配置支持正则表达式。
但是如果返回的对象是一个数组格式的Json数据。比如peson Bean中有对象persion1...person9，而我只要person1的json数据，
则可以用如下的正则表达式。
<struts>
    <constant name="struts.objectFactory" value="spring"/>
    <include file="struts-admin.xml"></include>
    <package name="default" extends="json-default">
        <action name="person" class="com.person.PersonAction" method="view">
        <result type="json">
           <param name="includeProperties">
            person\[\d+\]\.person1
           </param>>
        </result>
        </action>
    </package>
</struts>
excludeProperties拦截器的用法与此类同，如果拦截的仅仅是一个对象，如果拦截掉person Bean的整个对象。
<struts>
    <constant name="struts.objectFactory" value="spring"/>
    <include file="struts-admin.xml"></include>
    <package name="default" extends="json-default">
        <action name="person" class="com.person.PersonAction" method="view">
        <result type="json">
           <param name="excludeProperties">
            person
           </param>>
        </result>
        </action>
    </package>
</struts>

需要注意的是,如果用JSON插件把返回结果定为JSON。而JSON的原理是在ACTION中的get方法都会序列化，
所以前面是get的方法只要没指定不序列化，都会执行。
如果该方法一定要命名为get*（比如实现了什么接口），
那么可以在该方法的前面加注解声明该方法不做序列化。
注解的方式为：@JSON(serialize=false)

除此之外，JSON注释还支持如下几个域：
　　serialize：设置是否序列化该属性
　　deserialize：设置是否反序列化该属性。
　　format：设置用于格式化输出、解析日期表单域的格式。例如"yyyy-MM-dd‘T‘HH:mm:ss"。

//使用注释语法来改变该属性序列化后的属性名
　@JSON(name="newName")
　public String getName()
　{
　　return this.name;
　}
需要引入 import com.googlecode.jsonplugin.annotations.JSON;

@JSON(serialize=false)
public User getUser() {
    return this.User;
}

@JSON(format="yyyy-MM-dd")
public Date getStartDate() {
    return this.startDate;
}