Struts 2 与 AJAX 的 JSON 响应问题排查与解决

本文旨在解决 struts 2 框架下使用 ajax 获取 JSON 响应时遇到的解析错误问题。通过分析常见的配置和代码问题，提供了一种使用 map 结构作为 Action 返回值的解决方案，避免了手动写入响应造成的潜在问题，并确保 AJAX 能够正确解析 json 数据。

在使用 Struts 2 框架开发 Web 应用时，经常需要通过 AJAX 与后端进行数据交互，而 JSON 作为一种轻量级的数据交换格式，被广泛应用于前后端的数据传输。然而，在实践中，我们可能会遇到 Struts 2 返回的 JSON 数据无法被 AJAX 正确解析的问题，导致前端出现错误。本文将针对此类问题进行分析，并提供一种有效的解决方案。

问题分析

常见的问题在于，直接使用 ServletActionContext.getResponse().getWriter().write() 方法手动将 JSON 字符串写入响应流，可能导致 Struts 2 的 JSON 插件无法正确处理响应。这通常会导致 AJAX 的 Error 回调函数被触发，并抛出 JSON 解析错误。

解决方案：使用 Map 作为返回值

避免手动写入响应流，利用 Struts 2 的 JSON 插件自动序列化 Action 的属性，是一种更简洁、更可靠的方法。具体做法是，将需要返回的 JSON 数据存储在一个 Map 对象中，并将其作为 Action 的属性，Struts 2 的 JSON 插件会自动将该 Map 对象序列化为 JSON 字符串并返回给客户端。

示例代码

以下是一个修改后的 Action 类示例，展示了如何使用 Map 作为返回值：

import com.opensymphony.xwork2.ActionSupport; import Java.util.HashMap; import java.util.Map;  public class PropertyTesting extends ActionSupport {      private Map<String, Object> jsonData = new HashMap<>();      public Map<String, Object> getJsonData() {         return jsonData;     }      @Override     public String execute() {         jsonData.put("Name", "PersonName");         jsonData.put("ID", "PersonID");         return SUCCESS;     } }

配置 Struts.xml

确保 Struts.xml 文件中配置了 JSON 结果类型，并指定了需要序列化的属性。

<struts>    <constant name="struts.devMode" value="true"/>    <package name="WebTesting" extends="json-default">         <action name="PropertyTesting" class="org.testing.PropertyTesting" >             <result type="json">                 <param name="root">jsonData</param>             </result>         </action>    </package> </struts>

在这个配置中，<param name=”root”>jsonData</param> 指定了 jsonData 属性作为 JSON 序列化的根对象。

前端 AJAX 代码

前端 AJAX 代码无需修改，只需确保 dataType 设置为 “json”，以便 jquery 能够正确解析返回的 JSON 数据。

function invokeAjax() {     $.ajax(     {         type:"POST",         url:"PropertyTesting",         dataType:"json",          success: function(responseText)         {             console.log(responseText);           },         error: function(errorResponse)         {             console.log(errorResponse);         }     }); }

注意事项

• 确保 Struts 2 的 JSON 插件已正确安装并配置。
• Map 的 key 必须是字符串类型。
• Action 中需要提供 Map 属性的 getter 方法，以便 JSON 插件能够访问该属性。
• 在 Struts.xml 文件中，使用 <param name=”root”> 指定需要序列化的根对象。
• 避免手动设置 Content-Type 为 “application/json”，让 Struts 2 框架自动处理。

总结

通过使用 Map 作为 Struts 2 Action 的返回值，并配置 Struts.xml 文件，可以避免手动写入响应流带来的问题，确保 AJAX 能够正确解析 JSON 数据。这种方法更加简洁、可靠，并且符合 Struts 2 框架的设计理念。在实际开发中，建议采用这种方式来处理 JSON 响应，以提高代码的可维护性和可读性。