Struts 2 AJAX JSON响应常见问题分析
在web开发中，struts 2与ajax结合进行异步数据交互是常见的模式。然而，开发者在使用struts 2返回json数据给前端ajax请求时，常会遇到一个棘手的问题：客户端ajax请求进入error回调函数，并报告json解析错误（parse error）。这通常发生在开发者尝试在struts 2 action中手动构建json对象并将其直接写入http响应流时，例如使用servletactioncontext.getresponse().getwriter().write(obj.tojsonstring())。
这种做法与Struts 2 JSON插件的工作机制相冲突。当struts.xml中配置了<result type="json"></result>时，Struts 2的JSON插件会尝试自动序列化Action实例中的JavaBean属性，而不是简单地传递已经写入响应流的数据。手动写入会导致以下问题：
- 输出冲突： JSON插件在处理json结果类型时，会尝试再次写入响应流。如果Action中已经手动写入了内容，就会导致响应内容重复、格式错误，或者因为响应流已被关闭而抛出异常。
- 格式不符： 即使没有冲突，JSON插件也可能在手动写入的内容前后添加额外的字符或修改HTTP头，导致最终响应不再是纯净、有效的JSON格式，从而引发客户端的解析错误。
Struts 2 JSON插件工作原理
Struts 2的JSON插件（struts2-json-plugin）提供了一种声明式的方式来处理JSON数据。它的核心思想是：将Action类中的JavaBean属性（带有公共getter方法的字段）自动序列化为JSON格式，并将其作为HTTP响应返回给客户端。
要启用此功能，需要进行以下配置：
- 在struts.xml中，对应的package需要继承json-default。
- Action的result类型需要设置为json。
插件会扫描Action实例，查找所有带有getter方法的属性，并将它们转换为JSON键值对。例如，如果Action有一个名为data的Map属性，并提供了getData()方法，那么data的内容就会被序列化。
正确处理JSON响应的实践
为了避免上述问题，我们应该遵循Struts 2 JSON插件的设计理念，通过Action属性来传递JSON数据。
1. Action类改造
不再手动将JSON字符串写入响应流，而是将需要返回的数据封装到一个Action属性中，并为其提供公共的getter方法。
原始（错误）的Action类示例：
import java.io.IOException;
import org.apache.struts2.ServletActionContext;
import org.json.simple.JSONObject; // 注意这里使用了org.json.simple.JSONObject
import com.opensymphony.xwork2.ActionSupport;
public class PropertyTesting extends ActionSupport {
public String execute() {
JSONObject obj = new JSONObject();
obj.put("Name", "PersonName");
obj.put("ID", "PersonID");
try {
// 错误做法：手动写入响应流
ServletActionContext.getResponse().getWriter().write(obj.toJSONString());
} catch (IOException e) {
e.printStackTrace();
}
return SUCCESS;
}
}修正后的Action类示例：
import java.util.HashMap;
import java.util.Map;
import com.opensymphony.xwork2.ActionSupport;
public class PropertyTesting extends ActionSupport {
// 声明一个属性来承载需要返回的JSON数据
// 可以是Map、List、自定义JavaBean或其他可序列化的对象
private Map<String, String> jsonResponseData;
// 必须提供该属性的公共getter方法，这是JSON插件进行序列化的关键
public Map<String, String> getJsonResponseData() {
return jsonResponseData;
}
public String execute() {
jsonResponseData = new HashMap<>(); // 初始化数据容器
jsonResponseData.put("Name", "PersonName");
jsonResponseData.put("ID", "PersonID");
// 无需手动写入响应流，JSON插件会自动检测getJsonResponseData()方法并序列化其返回值
return SUCCESS; // 返回SUCCESS，让Struts 2处理结果
}
}在修正后的Action中，我们移除了手动写入响应流的代码。取而代之的是，我们声明了一个Map类型的jsonResponseData属性，并为其提供了getJsonResponseData()方法。在execute方法中，我们填充这个Map。当Action返回SUCCESS时，Struts 2的JSON插件会自动调用getJsonResponseData()方法，获取到Map对象，并将其序列化为JSON字符串作为HTTP响应返回。
2. Struts.xml配置
确保你的struts.xml配置正确地使用了JSON插件。
<struts>
<constant name="struts.devMode" value="true"/>
<package name="WebTesting" extends="json-default"> <!-- 继承json-default包 -->
<action name="PropertyTesting" class="org.testing.PropertyTesting" >
<result type="json"></result> <!-- 结果类型设置为json -->
</action>
</package>
</struts>这里，extends="json-default"引入了JSON插件提供的所有默认拦截器和结果类型。<result type="json"></result>则明确指示Struts 2使用JSON插件来处理此Action的响应。
3. 前端AJAX调用
前端的AJAX代码保持不变，但现在它将能够正确地接收和解析JSON响应。
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@ taglib uri="/struts-tags" prefix="s"%>
<html>
<head>
<meta charset="UTF-8">
<title>Property Testing</title>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script type="text/javascript">
function invokeAjax()
{
$.ajax(
{
type:"POST",
url:"PropertyTesting",
dataType:"json", // 告知jQuery期望JSON响应
success: function(responseData) // 成功回调函数，responseData将是解析后的JSON对象
{
console.log("Success:", responseData);
console.log("Name:", responseData.jsonResponseData.Name); // 访问数据
console.log("ID:", responseData.jsonResponseData.ID);
},
error: function(jqXHR, textStatus, errorThrown) // 错误回调函数
{
console.log("Error Status:", textStatus);
console.log("Error Thrown:", errorThrown);
console.log("Error Response:", jqXHR.responseText);
}
});
}
</script>
</head>
<body>
<button type="button" onclick="invokeAjax()" >Submit</button>
</body>
</html>在success回调中，responseData将直接是JavaScript对象，你可以通过点语法（responseData.jsonResponseData.Name）来访问其属性。注意，默认情况下，JSON插件会将Action属性名（例如jsonResponseData）作为JSON的根键。
注意事项与最佳实践
-
Action属性命名与JSON字段名： 默认情况下，JSON插件会将Action属性名作为JSON的根键。如果希望直接返回Map或对象的内部内容作为JSON的根对象（即不包含jsonResponseData这个键），可以在struts.xml的result标签中添加root参数：
<result type="json"> <param name="root">jsonResponseData</param> </result>这样，前端接收到的JSON将直接是{"Name":"PersonName", "ID":"PersonID"}，而不是{"jsonResponseData":{"Name":"PersonName", "ID":"PersonID"}}。
- Action的非单例特性： Struts 2的Action是请求作用域的，每次HTTP请求都会创建一个新的Action实例。这意味着你可以在Action中安全地定义实例变量（属性）来存储请求相关的数据，而不必担心线程安全问题。
- 依赖管理： 确保你的项目中已正确引入struts2-json-plugin及其所有必要的依赖。通常，Maven或Gradle会自动处理传递性依赖。
- 错误处理： 在前端AJAX的error回调中，jqXHR.responseText可以帮助你查看服务器返回的原始响应，这对于调试JSON解析错误非常有帮助。
总结
正确地在Struts 2中使用AJAX返回JSON数据，关键在于理解并遵循Struts 2 JSON插件的工作机制。避免在Action中手动写入响应流，而是通过定义带有公共getter方法的Action属性来承载需要返回的数据。结合正确的struts.xml配置（继承json-default和设置result type="json"），Struts 2将自动完成JSON序列化，确保前端AJAX请求能够顺利接收并解析有效的JSON响应。遵循这些最佳实践，可以有效提升开发效率并避免常见的JSON解析问题。
