struts2-json-plugin-2.2.3 使用

最近在做struts+ajax+json项目，项目中使用了struts2-json-plugin-2.2.3.jar（一款json转化插件），研究了一段时间，今天来总结一下具体的使用过程。

使用struts2-json-plugin-2.2.3.jar需要理解以下几点：1、struts2-json-plugin-2.2.3.jar就是一个将对象属性转化成json的东东，2、要转化的对象中必须要有get打头的函数才可以（所以，如果使用struts2-json-plugin-2.2.3.jar，尽量避免在要转化的对象中将不想转化json的的函数使用get*打头），不多说了，下面看配置：

1、我的程序目录结构，由于这是一个struts插件，所以必须要有struts才可以。

2、我的java文件：

StudentEntity.java

[java] view plaincopy

1. import java.io.Serializable;
2. public class StudentEntity implements Serializable {
3. private String stuName;
4. private String stuAge;
5. private String stuSex;
6. public String getStuAge() {
7. return stuAge;
8. }
9. public void setStuAge(String stuAge) {
10. this.stuAge = stuAge;
11. }
12. public String getStuName() {
13. return stuName;
14. }
15. public void setStuName(String stuName) {
16. this.stuName = stuName;
17. }
18. public String getStuSex() {
19. return stuSex;
20. }
21. public void setStuSex(String stuSex) {
22. this.stuSex = stuSex;
23. }
24. }

TeacherEntity.java

[java] view plaincopy

1. import java.io.Serializable;
2. public class TeacherEntity implements Serializable {
3. private String teacName;
4. private String teacAge;
5. private String teacSex;
6. public String getTeacAge() {
7. return teacAge;
8. }
9. public void setTeacAge(String teacAge) {
10. this.teacAge = teacAge;
11. }
12. public String getTeacName() {
13. return teacName;
14. }
15. public void setTeacName(String teacName) {
16. this.teacName = teacName;
17. }
18. public String getTeacSex() {
19. return teacSex;
20. }
21. public void setTeacSex(String teacSex) {
22. this.teacSex = teacSex;
23. }
24. }

StrIndex.java（这是一个action，命名不规范）

[java] view plaincopy

1. import java.util.Date;
2. import org.apache.struts2.json.annotations.JSON;
3. import com.opensymphony.xwork2.ActionSupport;
4. public class StrIndex extends ActionSupport {
5. private TeacherEntity teacher=new TeacherEntity();
6. private StudentEntity student=new StudentEntity();
7. private Date nowd=new Date();
8. public String toIndex(){
9. teacher.setTeacName("张三");
10. teacher.setTeacAge("100");
11. teacher.setTeacSex("男男");
12. student.setStuName("李老师");
13. return SUCCESS;
14. }
15. // 是否转换该对象
16. //  @JSON(serialize=true)
17. //  @JSON(name="newName")
18. public StudentEntity getStudent() {
19. return student;
20. }
21. public void setStudent(StudentEntity student) {
22. this.student = student;
23. }
24. public TeacherEntity getTeacher() {
25. return teacher;
26. }
27. public void setTeacher(TeacherEntity teacher) {
28. this.teacher = teacher;
29. }
30. @JSON(format="yyyy-MM-dd")
31. public Date getNowd() {
32. return nowd;
33. }
34. public void setNowd(Date nowd) {
35. this.nowd = nowd;
36. }
37. }

紧接着是我的struts配置文件：

[html] view plaincopy

1. <?xml version="1.0" encoding="UTF-8" ?>
2. <!DOCTYPE struts PUBLIC
3. "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
4. "http://struts.apache.org/dtds/struts-2.0.dtd">
5. <struts>
6. <package name="test-default" extends="json-default">
7. <action name="ind" class="StrIndex" method="toIndex">
8. <result name="success" type="json">
9. </result>
10. </action>
11. </package>
12. </struts>

3、简单配置说明

在struts中使用struts2-json-plugin-2.2.3.jar需要将要返回json的action配置在

[html] view plaincopy

1. <package name="test-default" extends="json-default">
2. ...
3. ...
4. </package>

中，注意extends="json-default"继承的是“json-default" 我们正常配置struts是使用‘struts-default’，所以需要将返回json的action和普通action分开使用两个package进行配置

[html] view plaincopy

1. <package name="test-default" extends="json-default">
2. ...
3. ...
4. </package>
5. <package name="struts-default" extends="struts-default">
6. ...
7. ...
8. </package>

在json package中的acton配置

[html] view plaincopy

1. <result name="success" type="json"></result>

便可以成功的转化json，结果如

[plain] view plaincopy

1. {"nowd":"2012-12-27T22:23:13","student":
   {"stuAge":null,"stuName":"李老师","stuSex":null},"teacher":
   {"teacAge":"100","teacName":"张三","teacSex":"男男"}}

4、拦截器配置

因为json插件的原理是将action中所有以get打头的函数全部转化，包括bena中的bean（如本案例所示，会将action中
student中的name以及age等全部转化），如果bean太多这会造成巨大浪费，使用拦截器可以根据需要将bean转化成json。

4.1、配置什么属性转化什么属性，如下配置

[html] view plaincopy

1. <result name="success" type="json">
2. <param name="includeProperties">
3. teacher\.teacName,teacher\.teacAge
4. </param>
5. </result>

在result中配置param标签，同时为param标签指定includeProperties属性，通过以上配置可以让json插件只转化param配置的属性。结果如

[plain] view plaincopy

1. {"teacher":{"teacAge":"100","teacName":"张三"}}

4.2、只返回指定属性的值，如下配置

[html] view plaincopy

1. <result name="success" type="json">
2. <param name="root">
3. teacher.teacName
4. </param>
5. </result>

在result中配置param标签，同时为param标签指定root属性，通过以上配置可以让json插件只转化param配置的属性，如

[plain] view plaincopy

1. "张三"

4.3、不想转化某些对象、属性

[html] view plaincopy

1. <result name="success" type="json">
2. <param name="excludeProperties">
3. teacher\.teacName
4. </param>
5. </result>

在result中配置param标签，同时为param标签指定excludeProperties属性，通过以上配置可以让json插件不转化param配置的属性，如

[plain] view plaincopy

1. {"nowd":"2012-12-27T22:34:00","student":
   {"stuAge":null,"stuName":"李老师","stuSex":null},"teacher":
   {"teacAge":"100","teacSex":"男男"}}

5、json注解使用

我目前所知道的json插件提供四种注解

serialize：设置是否序列化该属性

[java] view plaincopy

1. @JSON(serialize=true)
2. public StudentEntity getStudent() {
3. return student;
4. }

deserialize：设置是否反序列化该属性。

[java] view plaincopy

1. @JSON(deserialize=true)
2. public StudentEntity getStudent() {
3. return student;
4. }

format：设置用于格式化输出、解析日期表单域的格式。例如"yyyy-MM-dd‘T‘HH:mm:ss"。

[java] view plaincopy

1. @JSON(format="yyyy-MM-dd")
2. public Date getNowd() {
3. return nowd;
4. }

name：可改变序列后的属性明

[java] view plaincopy

1. @JSON(name="newName")
2. public StudentEntity getStudent() {
3. return student;
4. }

原文地址：http://blog.csdn.net/sys8090/article/details/8445430