本教程深入探讨struts 2与ajax集成时JSON响应解析失败的常见问题。核心在于Struts 2 json插件的序列化机制，它默认序列化Action的公共属性而非手动写入的流。通过在Action中定义可序列化的属性并正确配置Struts.xml，可以有效解决JSON解析错误，实现前后端数据流畅交互，确保AJAX请求成功接收和处理JSON数据。
问题背景与现象
在使用struts 2框架开发web应用时，我们经常需要通过ajax技术与后端进行异步数据交互，尤其是在前后端分离或部分数据动态加载的场景。当后端action处理完业务逻辑后，通常会返回json格式的数据给前端。然而，有时尽管后端看似输出了json字符串，前端ajax请求却可能进入Error回调函数，并报告“parse error”或无法正确解析json数据。
最初的代码尝试通过ServletActionContext.getResponse().getWriter().write(obj.toJSONString());直接将JSON字符串写入http响应流，并期望Struts 2的json结果类型能识别并处理。同时，struts.xml中配置了<result type=”json”></result>，且AJAX请求中设置了dataType:”json”。然而，这种组合导致了前端解析失败。
Struts 2 JSON插件的工作原理
Struts 2的JSON插件（struts2-json-plugin）提供了一种声明式的方式来生成JSON响应。当你在struts.xml中配置<result type=”json”></result>时，Struts 2并不会简单地将你手动写入响应流的内容作为JSON返回。相反，它的核心机制是：
- 序列化Action属性： JSON插件会检查当前Action实例中的公共（public）属性，特别是那些拥有公共getter方法的属性。
- 自动转换为JSON： 它会将这些属性的值自动序列化为JSON格式的字符串，并将其作为HTTP响应的主体发送回客户端。
- 内容类型设置： 插件还会自动设置HTTP响应的Content-Type为application/json。
因此，如果你在Action中直接使用ServletActionContext.getResponse().getWriter().write()来输出JSON，这会与JSON插件的自动序列化机制产生冲突。JSON插件在尝试序列化Action属性时，可能会发现没有需要序列化的内容（或者你手动写入的内容被覆盖/忽略），导致最终的响应不符合预期，或者前端在尝试解析一个并非由插件正确生成的JSON响应时出现错误。
解决方案：利用Action属性进行JSON序列化
要正确地通过Struts 2 JSON插件返回JSON数据，我们应该遵循其设计原则，即在Action中定义一个公共属性（通常是一个map、List或自定义POJO），并通过其getter方法让JSON插件进行序列化。
以下是修改后的Action类示例：
import Java.util.HashMap; import java.util.Map; import com.opensymphony.xwork2.ActionSupport; public class PropertyTesting extends ActionSupport { // 定义一个Map类型的属性，用于存储需要返回的JSON数据 // 必须有公共的getter方法，JSON插件才能访问并序列化它 private Map<String, String> jsonResponseData; // JSON插件会通过这个getter方法获取数据并序列化 public Map<String, String> getJsonResponseData() { return jsonResponseData; } public String execute() { // 初始化Map并填充数据 jsonResponseData = new HashMap<>(); jsonResponseData.put("Name", "PersonName"); jsonResponseData.put("ID", "PersonID"); // 返回SUCCESS，让Struts 2根据struts.xml配置的json结果类型进行处理 return SUCCESS; } }
关键改动点：
- 移除了JSONObject的使用以及手动写入响应流的代码。
- 定义了一个名为jsonResponseData的Map<String, String>类型的私有属性。
- 为jsonResponseData属性提供了公共的getJsonResponseData()方法。JSON插件正是通过这个getter方法来获取Action中需要序列化的数据。
- 在execute()方法中，我们不再直接输出JSON，而是将数据填充到jsonResponseData这个属性中。
Struts.xml配置
struts.xml的配置保持不变，因为它已经正确地使用了JSON插件。确保你的package继承了json-default，并且action的result类型是json。
<struts> <constant name="struts.devMode" value="true"/> <package name="WebTesting" extends="json-default"> <action name="PropertyTesting" class="org.testing.PropertyTesting" > <!-- 指定结果类型为json，Struts 2 JSON插件将自动序列化Action的属性 --> <result type="json"></result> </action> </package> </struts>
配置说明：
- extends=”json-default”：这使得当前包能够使用JSON插件提供的各种功能，包括json结果类型。
- <result type=”json”></result>：这指示Struts 2在Action成功执行后，使用JSON插件来处理响应。插件会查找Action中的公共getter方法，并将其返回值序列化为JSON。
前端AJAX请求
前端的AJAX请求代码无需修改，因为它已经正确地指定了dataType:”json”，这告诉jquery期望服务器返回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> </head> <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(responseText) { // 当服务器返回有效的JSON时，此函数将被调用 console.log(responseText); // responseText 现在是一个JavaScript对象，可以直接访问其属性 console.log("Name: " + responseText.Name); console.log("ID: " + responseText.ID); }, error: function(errorResponse) { // 如果JSON解析失败或服务器返回错误状态码，此函数将被调用 console.log("Error:", errorResponse); console.log("Status:", errorResponse.status); console.log("Response Text:", errorResponse.responseText); } }); } </script> <body> <button type="button" onclick="invokeAjax()" >Submit</button> </body> </html>
现在，当invokeAjax()函数被调用时，jQuery会向PropertyTesting Action发送POST请求。Struts 2将执行PropertyTesting Action的execute()方法，填充jsonResponseData属性。随后，JSON插件会捕获jsonResponseData属性的值（通过getJsonResponseData()方法），将其序列化为JSON字符串，并以application/json的Content-Type返回给客户端。前端的jQuery AJAX请求就能成功解析这个JSON响应，并在success回调中处理数据。
注意事项与最佳实践
- Action属性的命名： JSON插件默认会序列化Action中所有带有公共getter方法的属性。如果你只想序列化特定属性，可以通过struts.xml中的<param name=”root”>yourPropertyName</param>来指定根对象，或者使用@JSON(serialize=false)注解排除某些属性。
- 复杂对象序列化： 除了Map，你也可以使用自定义的POJO（Plain Old Java Object）作为Action的属性。JSON插件会自动递归序列化POJO的属性。
- 避免手动写入响应流： 一旦你决定使用Struts 2的JSON插件，就应避免在Action中直接操作HttpServletResponse.getWriter().write()，这会干扰插件的正常工作流程。
- 错误处理： 在AJAX的error回调中，errorResponse.responseText通常包含服务器返回的原始响应体，这对于调试非常有用。
- JSONObject库的使用： 在本例中，org.json.simple.JSONObject在Action中不再需要，因为Struts 2 JSON插件会处理Java对象到JSON的转换。
- Action非单例： Struts 2的Action是每次请求都会创建新的实例，因此在Action中定义实例变量来存储请求相关的数据是完全安全的，无需担心线程安全问题。
总结
解决Struts 2与AJAX集成时JSON响应解析失败的关键在于理解Struts 2 JSON插件的工作机制。它通过序列化Action中的公共属性来生成JSON响应，而不是依赖于Action手动写入响应流。通过在Action中定义一个带有公共getter方法的属性（如Map或自定义POJO）来承载需要返回的JSON数据，并配合正确的struts.xml配置，可以确保后端成功生成符合预期的JSON响应，前端AJAX也能顺利解析，从而实现高效可靠的前后端数据交互。
评论（已关闭）
评论已关闭