
理解Struts 2 JSON插件的工作原理
在struts 2框架中,当我们需要向前端返回json格式的数据时,通常会利用其强大的json插件。该插件通过配置
原始代码中,Action类PropertyTesting.java试图通过ServletActionContext.getResponse().getWriter().write(obj.toJSONString());手动将JSON字符串写入响应流,同时struts.xml中又配置了
- 手动写入: getWriter().write()会立即将JSON字符串发送到客户端。
- JSON插件序列化: 当Action执行完毕并返回SUCCESS后,Struts 2的JSON插件会再次尝试序列化PropertyTesting这个Action实例的属性,并将其作为响应发送。
由于响应流可能已经被手动写入并关闭,或者JSON插件尝试序列化一个没有暴露JSON数据的Action实例,这会导致客户端接收到的响应要么是空字符串,要么是格式不正确的JSON,从而引发AJAX的“parse error”。
正确的Action类设计与数据暴露
为了让Struts 2 JSON插件正确地工作,我们应该遵循其设计原则:将需要序列化为JSON的数据作为Action类的公共属性暴露出来,并通过公共的getter方法提供访问。JSON插件会自动检测这些属性并将其转换为JSON。
以下是修正后的PropertyTesting.java代码示例:
import java.util.HashMap;
import java.util.Map;
import com.opensymphony.xwork2.ActionSupport;
public class PropertyTesting extends ActionSupport
{
// 定义一个Map类型的属性,用于存放需要序列化的JSON数据
// 注意:这个属性必须有公共的getter方法
private Map jsonData; // 属性名可以自定义,但getter方法名需要对应
// 公共的getter方法,JSON插件会通过它获取数据并序列化
public Map getJsonData() { // getter方法名应为 get + 属性名(首字母大写)
return jsonData;
}
public String execute()
{
// 在execute方法中初始化并填充数据到jsonData属性
jsonData = new HashMap<>();
jsonData.put("Name", "PersonName");
jsonData.put("ID", "PersonID");
// 返回SUCCESS,让Struts 2 JSON插件接管响应处理
return SUCCESS;
}
} 关键点说明:
- 移除手动写入: execute()方法中不再需要ServletActionContext.getResponse().getWriter().write()。
- 定义属性: 创建一个私有属性(例如jsonData),类型可以是Map、List、自定义Java Bean等,只要能被JSON库序列化即可。
- 提供Getter: 为该属性提供一个公共的getter方法(例如getJsonData())。Struts 2 JSON插件会查找这些getter方法来获取要序列化的数据。
- 填充数据: 在execute()方法中,将需要返回的数据填充到这个属性中。
- 返回SUCCESS: 确保execute()方法返回SUCCESS,以便Struts 2能够根据struts.xml的配置调用JSON结果类型处理器。
Struts.xml 配置
struts.xml的配置在原问题中已经基本正确,它指定了使用json-default包和type="json"的结果类型。这正是启用JSON插件的关键。
配置要点:
- extends="json-default": 确保你的包继承了json-default包,这样才能使用type="json"结果类型。
-
: 这行配置告诉Struts 2,当Action返回SUCCESS时,使用JSON插件来处理响应。
JSP页面与AJAX调用
JSP页面中的AJAX调用方式在原问题中也是正确的,它指定了dataType:"json",这会告诉jQuery期望接收JSON格式的响应,并尝试自动解析。
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<%@ taglib uri="/struts-tags" prefix="s"%>
Property Testing
AJAX调用要点:
- dataType:"json": 这是至关重要的,它指示jQuery自动解析收到的响应为JSON对象。
- success回调: 当响应被成功解析为JSON后,responseText参数将直接是一个JavaScript对象,你可以像访问普通对象一样访问其属性(例如responseText.Name)。
- error回调: 在调试阶段,error回调函数非常有用。通过打印jqXHR.responseText,你可以看到服务器返回的原始文本,这有助于判断是服务器端返回了非JSON内容,还是JSON格式有误。
总结与注意事项
通过以上修正,Struts 2与AJAX集成时返回JSON的流程将变得清晰和可靠:
- 利用Struts 2 JSON插件: 避免在Action中手动写入响应流。
- 暴露Action属性: 将需要返回的数据封装在Action的私有属性中,并提供公共的getter方法。
- 正确配置struts.xml: 确保包继承json-default,并且Action结果类型为json。
- AJAX指定dataType:"json": 让前端库自动处理JSON解析。
这种方法不仅符合Struts 2的设计哲学,也使得代码更加简洁、易于维护。记住,Struts 2 Action并非单例,因此在Action中创建和填充属性是安全且推荐的做法。










