struts2的json插件配置详解

为了方便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代码  

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

  改为

Xml代码  

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

 

4.Action中的配置

Xml代码  

1. <action name="testAction" class="com.json.action.TestAction" method="testMethod">  
2.     <interceptor-ref name="json" /><!--处理以JSON文本提交的请求-->  
3.     <result type="json" /> <!--将action的bean属性以json字符串返回浏览器-->  
4. </action>  

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

 

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

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

         如：

    action类

Java代码  

1. public class BaseAction extends ActionSupport implements  {  
2.     private Person person = null;  
3.                 ...  
4. }  

    bean类  

Java代码  

1. public class Person {  
2.     private String name;  
3.     private int age;  
4.     ...  
5. }  

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

Xml代码  

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

 

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

Xml代码  

1. <result type="json">  
2.     <param name="excludeNullProperties">true</param>  
3. </result>  

 

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

Xml代码  

1. <result type="json">  
2.     <param name="ignoreHierarchy">false</param>  
3. </result>  

 

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

   如：输出person的所有属性 

Xml代码  

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

 

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

注意：当设置方法的type为json时，返回给页面的contentType为“application／json”，但在文件上传中，我们一般要求服务器端返回的contentType为“text／html”，此时我们就要设置response的contentType为“text／html”，有网友给出的方法是，调用方法

response．setContentType（＂text／html＂），但在实际测试中，发现不起作用，不知道是不是我在测试用使用的是注解配置，于是，为了解决该问题，还是通过注解配置来解决，代码如下：

@Action(value = "/uploadFile", results={ @Result(name="success",type="json",params={"contentType","text/html"}) })
public String uploadDeviceFile() {
   @SuppressWarnings("unused")
File newFile = file.get(0);
   HttpServletResponse response = ServletActionContext.getResponse(); 
  // response.setContentType("text/html");
  try {
  //当设置值后返回的json数据格式不对，不设置值时，不返回任何数据，
  //对于页面文件上传来说，结果是正确的，对于contentType的设置，必须
  //在注解中配置，使用response.setContentType结果不起作用。
／／response.getWriter().write("1");

} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
        return "success";
    }