ajax请求Struts2返回JSON数据方法

Ajax 前端之家
前端之家收集整理的这篇文章主要介绍了ajax请求Struts2返回JSON数据方法，前端之家小编觉得挺不错的，现在分享给大家，也给大家做个参考。

如果是作为客户端的HTTP+JSON接口工程，没有JSP等view视图的情况下，使用Jersery框架开发绝对是第一选择。而在基于Spring3 MVC的架构下，对HTTP+JSON的返回类型也有很好的支持。但是，在开发工作中，对功能的升级是基于既定架构是很常见的情况。本人碰到需要用开发基于Struts2的HTTP+JSON返回类型接口就是基于既定框架结构下进行的。

Struts2返回JSON有两种方式：1.使用Servlet的输出流写入JSON字符串；2.使用Struts2对JSON的扩展。

一.使用Servlet的输出流

JSON接口的实质是：JSON数据在传递过程中，其实就是传递一个普通的符合JSON语法格式的字符串而已，所谓的“JSON对象”是指对这个JSON字符串解析和包装后的结果。

所以这里只需要将一个JSON语法格式的字符串写入到Servlet的HttpServletResponse中，这里使用的是PrintWriter的方式，当然也可以采用Stream流的方式。需要注意的是：在调用getWriter之前未设置编码(既调用setContentType或者setCharacterEncoding方法设置编码),HttpServletResponse则会返回一个用默认的编码(既ISO-8859-1)编码的PrintWriter实例。这样就会造成中文乱码。而且设置编码时必须在调用getWriter之前设置,不然是无效的。

编写接口代码：

这里的方法与一般的Struts2方法的区别是这里是void返回类型。

Java代码
  1. publicvoidwrite()throwsIOException{
  2. HttpServletResponseresponse=ServletActionContext.getResponse();
  3. /*
  4. *在调用getWriter之前未设置编码(既调用setContentType或者setCharacterEncoding方法设置编码),
  5. *HttpServletResponse则会返回一个用默认的编码(既ISO-8859-1)编码的PrintWriter实例。这样就会
  6. *造成中文乱码。而且设置编码时必须在调用getWriter之前设置,不然是无效的。
  7. **/
  8. response.setContentType("text/html;charset=utf-8");
  9. //response.setCharacterEncoding("UTF-8");
  10. PrintWriterout=response.getWriter();
  11. //JSON在传递过程中是普通字符串形式传递的，这里简单拼接一个做测试
  12. StringjsonString="{\"user\":{\"id\":\"123\",\"name\":\"张三\",\"say\":\"Hello,iamaactiontoprintajson!\",\"password\":\"JSON\"},\"success\":true}";
  13. out.println(jsonString);
  14. out.flush();
  15. out.close();
  16. }

配置action

从以下的配置中可以明显的看到配置与普通的action配置没有任何区别，只是没有返回的视图而已。

<actionname="write"class="json.JsonAction"method="write"/>

返回值

Console代码
    {"user":{"id":"123","name":"张三","say":"Hello,iamaactiontoprintajson!","password":"JSON"},"success":true}

二.使用Struts2对JSON的扩展

要使用这个扩展功能肯定需要添加支持包。经过本人的调试，这里有两种选择：

1. xwork-core-2.1.6.jar和struts2-json-plugin-2.1.8.jar。如果你想使用struts2-json-plugin-2.1.8.jar这种支持方式，你的xwork-core-*.jar不能选择2.2.1及以上版本，因为xwork-core-*.jar的2.2.1及以上版本中没有了org.apache.commons.lang等包。启动tomcat的时候会出现：java.lang.NoClassDefFoundError: org.apache.commons.lang.xwork.StringUtils。

2. xwork-2.1.2.jar和jsonplugin-0.34.jar。如果想用jsonplugin-0.34.jar这种支持方式，那需要切换你的xwork-core-*.jar为xwork-2.1.2.jar。因为jsonplugin-0.34.jar需要com.opensymphony.xwork2.util.TextUtils

这个类的支持。而xwork-core-*.jar的2.2.1以上版本均为找到该类，且在xwork-core-2.1.6.jar中也没有该类。

最后说一句，还因为用原始构建方式而不停蹚雷，确实不值得，真心累。使用Maven等自动化构件方式，会在很大程度上避免依赖包间的版本差异的bug。第三节的“struts2零配置”中会使用maven的构件方式。

编写接口代码

该类中json()方法就是普通Struts2的方法。在这里没有看到任何JSON格式的字符串，因为我们将要把这项工作交给扩展去完成。在没有任何设定的情况下，改类下的所有getter方法的返回值将被包含在返回给客户端的JSON字符串中。要剔除不需要包含的属性，在类结构结构中需要在getter方法上使用@JSON(serialize=false)进行注解,当然在不影响其他业务的时候也可以直接去掉这个getter方法。所以本例中的返回结果是将dataMap对象转换成的JSON格式的字符串。

packagejson;
  • importjava.util.HashMap;
  • importjava.util.Map;
  • importorg.apache.struts2.json.annotations.JSON;
  • importcom.opensymphony.xwork2.ActionSupport;
  • /**
  • *JSON测试
  • *
  • *@authorWatsonXu
  • *@date2012-8-4下午06:21:01
  • */
  • classJsonActionextendsActionSupport{
  • privatestaticfinallongserialVersionUID=1L;
  • privateMap<String,Object>dataMap;
  • privateStringkey="Justseesee";
  • publicStringjson(){
  • //dataMap中的数据将会被Struts2转换成JSON字符串，所以这里要先清空其中的数据
  • dataMap=newHashMap<String,Object>();
  • Useruser=newUser();
  • user.setName("张三");
  • user.setPassword("123");
  • dataMap.put("user",user);
  • //放入一个是否操作成功的标识
  • dataMap.put("success",true);
  • //返回结果
  • returnSUCCESS;
  • }
  • publicMap<String,Object>getDataMap(){
  • returndataMap;
  • //设置key属性不作为json的内容返回
  • @JSON(serialize=false)
  • publicStringgetKey(){
  • returnkey;
  • }

    • 配置aciton

    在配置中，首先需要action所在的package继承了json-default，或者继承的父包继承了json-default。这配置action的返回类型的type为json,并且可以配置其序列化的属性等一些类参数

    Xml代码
      <?xmlversion="1.0"encoding="UTF-8"?>
    1. <!DOCTYPEstrutsPUBLIC
    2. "-//ApacheSoftwareFoundation//DTDStrutsConfiguration2.0//EN"
    3. "http://struts.apache.org/dtds/struts-2.0.dtd">
      4. @H_211_404@<strutspackagename="json"extends="struts-default,json-default"actionname="json"class="json.JsonAction"method="json"resulttype="json" <!--这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法--> @H_211_404@paramname="root">dataMap</paramresultactionpackage>

    {"success":true,"user":{"name":"张三","password":"123"}}

    三.Struts2零配置使用方法，使用Maven构件：

    3.1） 建立一个webapp，这里还是采用Maven构建，构建过程参考limingnihao的blog：使用Eclipse构建Maven的SpringMVC项目。

    3.2） 添加Struts2的依赖、struts2零配置依赖和struts2的json依赖：

    dependencies<!--struts2核心依赖--> @H_211_404@dependencygroupId>org.apache.strutsartifactId>struts2-coreversion>2.3.4type>jarscope>compile<!--struts2零配置依赖--> @H_211_404@>struts2-convention-plugin<!--struts2的json依赖--> @H_211_404@>struts2-json-plugin 经过测试，上面的依赖包间没有出现版本兼容的bug，不仅仅因为他们是同一个版本，更加得益于Maven的自动构建方式。

    3.3） 配置web.xml，启用Struts2：

    web-appversion="2.5"xmlns="http://java.sun.com/xml/ns/javaee"
  • xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  • xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
  • http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"filterfilter-name>StrutsPrepareAndExecuteFilterfilter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilterinit-paramparam-name>configparam-value>struts-default.xml,struts-plugin.xml,struts.xmlfilter-mappingurl-pattern>/*web-app 3.4）配置struts.xml，设置一些基本常量和应用：

    packagename="base"extends="json-default,struts-default"<!--这里可以设置一些全局的返回值映射关系等-->
    • @H_211_404@constantname="struts.action.extension"value=""/> @H_211_404@constantname="struts.ui.theme"value="simple"constantname="struts.i18n.encoding"value="utf-8"constantname="struts.multipart.maxSize"value="1073741824"constantname="struts.devMode"value="false" 3.5）编写和配置Action。由并未指定Convention进行设置，所以对于Convention插件而言，默认的它会把所有类名以Action结尾的java类当成Action处理：

    packagewatson.action;
  • importorg.apache.struts2.convention.annotation.Action;
  • importorg.apache.struts2.convention.annotation.Namespace;
  • importorg.apache.struts2.convention.annotation.ParentPackage;
  • importorg.apache.struts2.convention.annotation.Result;
  • importorg.apache.struts2.convention.annotation.Results;
  • @ParentPackage("base")
  • @Namespace("/watson")
  • @Results({
  • @Result(name="json",type="json",params={"root","msg"})
  • })
  • classJsonAction{
  • @Action(value="json")
  • msg= msg.put("flag","success");
  • Map<String,String>user= user.put("name","张三");
  • user.put("age","34");
  • msg.put("user",85); font-weight:bold">return"json";
  • //==================================
  • returnmsg;
  • 3.6）部署项目，启动容器，浏览器地址栏中输入：http://localhost:7070/Struts2foo/watson/json。等到结果如下：

    Json代码 {"flag":"success","user":{"age":"34","name":"张三"}}

    • 从上面结果可知在启用了零配置以后，只是少了在xml中的配置，改为在每个action中用annotation进行注解。这里删除上面在xml中的配置，将下面的代码写入到上面的JsonAction的上部：

    })

    root就相当xml配置中的参数配置。

    四.附：

    action的返回类型为json时的可配置参数详解：

  • >
  • <!--这里指定将被Struts2序列化的属性，该属性在action中必须有对应的getter方法-->
  • <!--默认将会序列所有有返回值的getter方法的值，而无论该方法是否有对应属性-->
  • <!--使用root去除dataMap在json中生成变量-->
  • <!--指定是否序列化空的属性-->
  • paramname="excludeNullProperties">true<!--这里指定将序列化dataMap中的那些属性-->
  • paramname="includeProperties">user.*<!--这里指定将要从dataMap中排除那些属性，这些排除的属性将不被序列化，一般不与上边的参数配置同时出现-->
  • paramname="excludeProperties">flag

    extends=”json-default”这边必须这样设置才能处理json。

    1.<action name="test" class="com.TestAction" method="test">

    <result type="json" /><!--将action的bean属性以json字符串返回浏览器-->

    </action>

    2.只要继承extends="json-default"，json拦截器是默认配置上的，可以不配。result设置成json之后，容器会把action的属性自动封装到一个json对象中（json拦截器来做），然后调用js的callback方法.返回json数据

    3.如果按照1中的配置。你会发现前台返回的json字符串，是把action中的所有属性全部转化为json字符串返回给浏览器了（甚至有时候返回不了结果，也不报错，后台执行了，但前台执行不到callback function），但是我们有时候需要根据实际情况返回部分结果，如何对json的结果进行定制输出呢？result提供了一些参数替你解决这个问题，一般情况下用的最多的就是includeProperties参数和excludeNullProperties参数。当然还有其他的方法，如给pojo的属性加json注解。

    4.includeProperties参数：输出结果中需要包含的属性值，这里正则表达式和属性名匹配，可以用“,”分割填充多个正则表达式。这个参数直接返回对象的json数据，前台不需要eval转换，<param name="root">result</param>则不同，需要前台进行eval转换

    如：输出data对象下面的所有属性和总条数。

    <resulttype="json">

    <paramname="includeProperties">totalCount,data.*</param>

    </result>

    5.excludeProperties参数：输出结果需要剔除的属性值，也支持正则表达式匹配属性名，可以用“,sans-serif">”分割填充多个正则表达式，类同includeProperties

    6.对一些属性的特殊处理可在action代码中去特殊的序列化，如：

    [.1]默认情况下以get方法开头的都会序列化,如果不想序列化在中的方法要打上注解
    @JSON(serialize=false)

    [    .2]如果在属性方法上面加@JSON(name="newName")则返回的json数据中名称是指定的新名称


    [.3]@JSON(format ="yyyy-MM-dd'T'HH:mm:ss")设置用于格式化输出、解析日期表单域的格式。

    [    .4]@JSON(deserialize=true)设置是否反序列化该属性

    注意：为了避免不必要的麻烦，action里面要有有get开头的方法。

    参考：

    1.《深入了解Struts2返回JSON数据的原理及具体应用范例》

    2.添加支持包时的bug汇总：http://hi.baidu.com/chennning/item/53d8f8b97c1fd5d985dd79de

    3.jjiag22222的BLOG《HttpServletResponse中获取PrintWriter需要注意的一个小问题》

    4.struts2 零配置详解：http://topic.csdn.net/u/20101130/11/a47de200-c0e2-4daa-841b-5b2cb659f66b.html?45426

    原文链接：https://www.f2er.com/ajax/164278.html

    • 猜你在找的Ajax相关文章

    网页的异步请求（Ajax）
    JS原生Ajax操作(XMLHttpRequest) GET请求 POST请求 兼容性问题 利用iframe模拟ajax 实现表...
    手动实现AJAX
    AJAX 每日更新前端基础，如果觉得不错，点个star吧 &#128515; https://github.com/Win...
    axios异步提交表单数据的不同形式
    踩坑Axios提交form表单几种格式 前后端分离的开发前后端, 前端使用的vue,后端的安全模块使...
    php的ajax简单实例
    很早就听闻ajax的名声，但是却一直不知道怎么用，今天自己捣鼓了一下，竟然会用了，哈哈哈...
    Json与Ajax(注册实例）
    需要在服务器上进行哈 jquery的ajax方法： // jquery请求 $.ajax({ url: &quot;./serv...
    jSon和Ajax登录功能，ajax数据交互案例
    ajax实例，检测用户与注册 检测用户名是否被占用： 在用户填写完用户名之后，ajax会异步向...
    关于AjaxControlToolkit的样式问题
    网(LieHuo.Net)教程 技术文章一直都是转载的,从来没有自创过.终于遇到AjaxControlToolkit,...
    一个简单的AJAX实现(HELLO AJAX)
    客户端部分： <html> <head> <meta http-equiv="Content-Type" ...
    AJAX中文乱码的两类问题及解决之策
    1）发送路径中的参数有中文，在服务器段接收参数值是乱码 例如： var url=”a.jsp?na...
    实例：AJAX返回xml代码如何在网页中显示
    建站学院（LieHuo.Net）文档 今天来学习一篇实例代码教程：AJAX返回xml代码如何在网页中显...
    HTMLHTML5JavaScriptCSSjQueryBootstrapAngularjsTypeScriptVueDojoJsonElectronNode.jsextjsExpress XMLES6AjaxFlashUnityReactFlexAnt DesignWeb前端微信小程序微信公众号
    关闭广告单独headers封装代码提示错误整数正则非0开头跳页出页码antd table提示URL未注册公众号支付vue hash模式iSlider车牌键盘循环图片echarts 双折左右布局DllPlugin对象创建打字游戏圈选两栏云函数蒙版ES2020橱窗无缝滚动轮播色块碰撞组件销毁文档操作