首页 / JQUERY / jqueryajax方法封装的介绍（附示例）

jqueryajax方法封装的介绍（附示例）

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了jqueryajax方法封装的介绍（附示例），小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含7895字，纯文字阅读大概需要12分钟。

内容图文

本篇文章给大家带来的内容是关于jquery ajax 方法封装的介绍（附示例），有一定的参考价值，有需要的朋友可以参考一下，希望对你有所帮助。

简要说明

前面我写了一篇《jquery ajax 方法封装及 api 文件设计》文档，主要用来说明我们在项目中通常会对 jquery 的 ajax 方法进行进一步的封装处理，便于我们在业务代码中使用。从那篇文档中我们可以了解到如何封装ajax方法、如何设计 API 文件，以及如何在业务代码中调用 API 接口。

这篇文档我们主要对封装的 ajax 方法进行一个简要说明。这里的封装主要是将 $.ajax() 返回的 jqXHR 对象，通过调用 jQuery.Deferred() 方法创建成一个可链式调用的工具对象（其实 jqXHR 本身就是 Deferred 对象，本来就可以进行链式调用，后面会对此进行说明）。这样我们就可以使用下面这种形式进行链式调用：

// 链式调用
absService.getAbsListData(conditionObj)
  .done(function (result) {
    var data = ts.handleData(result);
    ts.render(data, columnChange);
  })
  .fail(function (err, jqXHR) {
    Util.hideLoading('#abs-all-container');
  });

同时，通过一些处理，也允许调用者使用如下形式进行调用：

// 传入成功回调、失败回调
absService.getAbsListData(conditionObj, function (result) {
    var data = ts.handleData(result);
    ts.render(data, columnChange);
  }, function (err, jqXHR) {
    Util.hideLoading('#abs-all-container');
  });

实际上，从 jQuery 1.5 开始，$.ajax() 返回的 jqXHR 对象就已经实现了 Promise 接口, 使它拥有了 Promise 的所有属性，方法和行为。也就是说 $.ajax() 返回的 jqXHR 对象本身就可以使用如下形式的调用：

$.ajax(options)
  .done(function (result, textStatus, jqXHR) {
    if (requestId === requestIdentifier[serviceName]) {
      ajaxRequest.ajax.handleResponse(result, $dfd, jqXHR, userOptions, serviceName, requestId);
      }
  })
  .fail(function (jqXHR, textStatus, errorThrown) {
    if (requestId === requestIdentifier[serviceName]) {
      //jqXHR.status
      $dfd.reject.apply(this, arguments);
      userOptions.error.apply(this, arguments);
    }
  });

既然已经可以使用这种方式使用 jqXHR对象，那为什么不直接将 jqXHR对象返回，然后在业务代码中直接使用 jqXHR.done() 和 jqXHR.fail() 方法呢？为什么还要进一步将其包装成一个新的 Deferred 对象呢？

答：是为了在成功和失败回调调用之前做一些统一的处理，比如对接口返回的数据进行判断、对返回的 JSON 字符串进行解析、在请求失败时输出方法名和错误信息等，我们把这些每次接口调用都会进行的操作进行统一处理，实现代码复用，这样业务代码中就只需要关注拿到数据后的处理逻辑即可。

这些统一进行的操作，我们放在 $.ajax().done() 和 $.ajax().fail() 方法中去执行，然后将 $.ajax() 返回的 jqXHR对象包装成新的 Deferred 对象，这样就可以在业务代码中通过链式调用做进一步的处理，比如刷新表格内容、更新页面动态等等。

代码解读

/**
 * 封装 jquery ajax 
 * 例如:
 * ajaxRequest.ajax.triggerService(
 *   'apiCommand', [命令数据] )
 *   .then(successCallback, failureCallback);
 * );
 */
var JSON2 = require('LibsDir/json2');
var URL = '../AjaxHandler.aspx?r=';

// 用来记录每次请求的唯一标识, 键值对形式, 形如:
// var requestIdentifier = {
//   SearchABSList: 'b80a3876-9bca-40d1-b2cd-0daa799591e7',
//   SetABSUserColumns: 'cafe3f01-2ee2-41f0-aeca-d630429f89f4',
// };
var requestIdentifier = {};

// 唯一标识生成方法
function generateGUID() {
  var d = new Date().getTime();
  if (typeof performance !== 'undefined' && typeof performance.now === 'function') {
    d += performance.now();
  }
  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
    var r = (d + Math.random() * 16) % 16 | 0;
    d = Math.floor(d / 16);
    return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16);
  });
}


// 模块主体
var ajaxRequest = ajaxRequest || {};
(function ($) {
  if (!$) {
    throw 'jquery获取失败!';
  }

  ajaxRequest.json = JSON2;

  /**
   * 触发请求, 返回包装成 Deferred 对象的 jqXHR
   * @param    {object}    userOptions   参数对象(包含方法名、参数对象、成功回调、失败回调)
   * @param    {string}    serviceName   方法名
   * @param    {string}    requestId     请求的唯一标识
   * @returns  object
   */
  ajaxRequest.ajax = function (userOptions, serviceName, requestId) {
    userOptions = userOptions || {};

    // 将参数对象与ajax的默认项组成一个新的对象, 作为 jquery ajax 方法的配置项
    var options = $.extend({}, ajaxRequest.ajax.defaultOpts, userOptions);

    // 将 jquery ajax 方法默认的 success 回调和 error 回调置为 undefined
    // .done()方法取代了的过时的jqXHR.success()方法
    // .fail()方法取代了的过时的.error()方法
    options.success = undefined;
    options.error = undefined;

    // 将 jqXHR 包装成新的 Deferred 对象返回
    // jQuery.Deferred([beforeStart]) 一个工厂函数, 这个函数返回一个链式实用对象
    // beforeStart - 一个构造函数返回之前调用的函数
    return $.Deferred(function ($dfd) {
      $.ajax(options)
        .done(function (result, textStatus, jqXHR) {
          if (requestId === requestIdentifier[serviceName]) {
            // 比对请求id, 保证返回结果的正确性 (重复请求有可能会带来返回结果不可靠的问题)
            ajaxRequest.ajax.handleResponse(result, $dfd, jqXHR, userOptions, serviceName, requestId);
          }
        })
        .fail(function (jqXHR, textStatus, errorThrown) {
          if (requestId === requestIdentifier[serviceName]) {
            // jqXHR.status
            $dfd.reject.apply(this, arguments);
            userOptions.error.apply(this, arguments);
          }
        });
    });
  };

  $.extend(ajaxRequest.ajax, {
    // $.ajax() 的默认设置
    defaultOpts: {
      // url: '../AjaxSecureHandler.aspx,
      dataType: 'json',
      type: 'POST',
      contentType: 'application/x-www-form-urlencoded; charset=UTF-8'
    },

    // 在业务代码的回调执行之前, 做一些统一处理, 实现代码复用
    // $dfd.resolve() 和 $dfd.reject() 的执行, 会使得使用 .then()/.done() 中的回调方法得到执行
    // userOptions.success() 和 userOptions.error() 是调用用户以参数形式传入的成功回调函数和失败回调函数
    // 一般来说, 上述两种方式只会有一个真正起到作用, 这取决于用户调用的方式: 
    // 如果是使用 $.ajax().done().fail() 这种方式调用, 那么 $dfd.resolve()/$dfd.reject() 会起到作用
    // 此时 userOptions.success/userOptions.error 都是 undefined, 自然不会得到执行, 反之亦然
    handleResponse: function (result, $dfd, jqXHR, userOptions, serviceName, requestId) {
      if (!result) {
        $dfd && $dfd.reject(jqXHR, 'error response format!');
        userOptions.error(jqXHR, 'error response format!');
        return;
      }

      // 服务器已经错误
      if (result.ErrorCode != '200') {
        $dfd && $dfd.reject(jqXHR, result.ErrorMessage);
        userOptions.error(jqXHR, result);
        return;
      }

      if (result.Data) {
        // 将大于2^53的数字(16位以上)包裹双引号, 避免溢出
        var jsonStr = result.Data.replace(/(:\s*)(\d{16,})(\s*,|\s*})/g, '$1"$2"$3');
        var resultData = ajaxRequest.json.parse(jsonStr);

        // $dfd.resolve() 执行之后, 业务代码中的回调会执行, 即.then()/.done()方法会得到执行
        $dfd.resolve(resultData);
        // 如果是使用传统的传入成功回调函数的形式进行调用的, 那么在此处调用用户设定的成功回调
        userOptions.success && userOptions.success(resultData);
      } else {
        $dfd.resolve();
        userOptions.success && userOptions.success();
      }
    },

    /**
     * 构建请求参数对象
     * @param    {string}    serviceName   方法名
     * @param    {object}    input         传入的参数对象
     * @param    {function}  userSuccess   成功回调
     * @param    {function}  userError     失败回调
     * @param    {object}    ajaxParams    其他参数
     * @returns  object
     */
    buildServiceRequest: function (serviceName, input, userSuccess, userError, ajaxParams) {
      // 这里是根据后台要求构建的
      var requestData = {
        MethodAlias: serviceName, // 方法名
        Parameter: input // 传递的参数
      };

      var request = $.extend({}, ajaxParams, {
        // 这里要对传递的 JSON 字符串参数数据使用 escape 方法进行编码
        // 'data=' 是根据项目约定增加的，与 contentType 相对应
        data: 'data=' + escape(ajaxRequest.json.stringify(requestData)),
        success: userSuccess,
        error: function (jqXHR, textStatus, errorThrown) {
          // 这里是在请求出错的时候做一个统一处理,

输出方法名和错误对象 console.log(serviceName, jqXHR); if (userError && (typeof userError === 'function')) { userError(jqXHR, textStatus, errorThrown); } } }); return request; }, // 构建参数对象, 生成唯一标识, 触发请求 triggerService: function (serviceName, input, success, error, ajaxParams) { // 构建参数对象 var request = ajaxRequest.ajax.buildServiceRequest(serviceName, input, success, error, ajaxParams); // 生成此次 ajax 请求唯一标识 var requestId = requestIdentifier[serviceName] = generateGUID(); request.url = URL + requestId; // 触发请求 return ajaxRequest.ajax(request, serviceName, requestId); } }); })(jQuery); module.exports = ajaxRequest;

本篇文章到这里就已经全部结束了，更多其他精彩内容可以关注PHP中文网的JavaScript视频教程栏目！

以上就是jquery ajax方法封装的介绍（附示例）的详细内容，更多请关注Gxl网其它相关文章！

内容总结

以上是互联网集市为您收集整理的jqueryajax方法封装的介绍（附示例）全部内容，希望文章能够帮你解决jqueryajax方法封装的介绍（附示例）所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/283319.html

来源：【匿名】

【上一篇】jquery中deferred对象的用法介绍（附示例）【下一篇】学习php+jQuery+Ajax实现点赞效果的方法

更多 ►

【jqueryajax方法封装的介绍（附示例）】教程文章相关的互联网学习教程文章

jQuery里面ajax请求的封装【代码】

为了避免ajax漫天飞，我们需要对jQuery的代码进行封装，封装代码：function api_request(name, params, cb, scope, async, el) {if (async == null)async = true;console.log(‘调用接口:\n%s,\n参数列表:‘, REQUEST_URL+name, params);$.ajax( {url : REQUEST_URL+name,async : async,data : params,type : ‘POST‘,dataType:‘json‘,cache : false,timeout:70000,success : function(data, textStatus) {//alert(data.obj[0]....

jquery 封装页面之间获取值【代码】

最近在项目中发页面传值比较繁琐。View → Control → View，或是Session、Cookie 的感觉不是很好，于是封装了一个页面间的js方法，上码$.extend({request: function (name) {var search = decodeURI(location.search.slice(1)); //decodeURI 对中文进行转码，防止乱码出现var arr = search.split("&");for (var i = 0; i < arr.length; i++) {var ar = arr[i].split("=");if (ar[0] == name) {if (unescape(ar[1]) == ‘undefi...

用jQuery基于原生js封装的轮播【代码】

我发现轮播在很多网站里面都用到过，一个绚丽的轮播可以为网页增色不少，最近闲来无事，也用原生js封装了一个轮播，可能不像网上的插件那么炫，但是也有用心去做。主要用了闭包的思想。需要传递的参数有：图片地址的数组，图片宽度，上一页，下一页的id,图片列表即ul的id(这儿使用无序列表排列的图片),自动轮播间隔的时间。功能：实现了轮播的自动轮播，可以点击上一页，下一页进行切换。下面是html中的代码,只需要把存放的容器写好...

自己封装的一些简单的jQuery插件

俗话说的好：温故而知新，可以为师矣！　　学习是一个人一辈子的事情。于是乎趁着今天休息，回顾了一些知识点，可能做的不够完美，请多多指教。/** * Created by Administrator on 2017/5/6. *//** * 格式化日期 * @param dt 日期对象 * @returns {string} 返回值是格式化的字符串日期 */function getDates(dt) { 　　var str = "";//存储时间的字符串　　//获取年　　var year = dt.getFullYear(); 　　//获取月 ...

封装通用的 ajax，基于 jQuery。【代码】

在前端异步获取数据时候每次都是使用 ajax；为了通用性更好，然而封装通用的 ajax 是一个一劳永逸的办法。本次基于 jQuery 封装实现；第一步：引入 jQuery：<script type="text/javascript" src="<%=path%>/resources/js/jquery.min.js"></script>第二步：实现代码：// 该封装基于 jQueryvar sendAjax = function(method, url, data, successfn, errorfn) {$.ajax({type: method,url: url,data: data,success: function(d){succ...

对jquery的ajax进行二次封装以及ajax缓存代理组件:AjaxCache详解

虽然jquery的较新的api已经很好用了，但是在实际工作还是有做二次封装的必要，好处有：1，二次封装后的API更加简洁，更符合个人的使用习惯；2，可以对ajax操作做一些统一处理，比如追加随机数或其它参数。同时在工作中，我们还会发现，有一些ajax请求的数据，对实时性要求不高，即使我们把第一次请求到的这些数据缓存起来，然后当相同请求再次发起时直接拿之前缓存的数据返回也不会对相关功能有影响，通过这种手工的缓存控制，减少...

对jquery的ajax进行二次封装以及ajax缓存代理组件:AjaxCache详解_jquery

原生javascript封装类似jquery的ajax请求跨域函数【代码】

function ajax(opt) {opt = opt || {}; // 对实参处理var xmlhttp, method, url, async, dataType, data;method = opt.method || GET; // 默认method为GETmethod = trim(method).toUpperCase(); //转换成大写并去除空格url = opt.url //请求地址url = trim(url);async = opt.async || true; ...

jQuery焦点图切换特效插件封装实例【图】

网站焦点图是一种网站内容的展现形式，可简单理解为一张图片或多张图片展现在网页上就是网站焦点图。在网站很明显的位置，用图片组合播放的形式，类似焦点新闻的意思只不过加上了图片。一般多使用在网站首页版面或频道首页版面，因为是通过图片的形式，所以有一定的吸引性、视觉吸引性。容易引起访问者的点击，据国外的设计机构调查统计，网站焦点图的点击率明显高于纯文字，转化率高于文字标题5倍。由此看来焦点图的能让游客对企业...

jQuery的Cookie封装,与PHP交互的简单实现

首先，用到两个jQuery函数，JSON.parse（Json字符串转对象）和JSON.stringify（对象转JSON字符串）我这里的分成两次封装，因为数据不在一个页面里。这是第一个页面： $(".color-gray").click(function(){ var detail = new Object();//自定义一个空对象将获取的参数放入这个对象 detail.userName = $(input[data-node="userName"]).val(); detail.userSex = $(".userSex").val(); detail.detail = $(input[data-node="address"]...

关于ajax二次封装jquery

大家都知道二次封装jquery，Ajax 的全称是Asynchronous JavaScript and XML 异步的javaScript和XML，下面这篇文章主要给大家介绍了关于二次封装jquery ajax办法示例，文中通过示例代码介绍的非常详细，需要的朋友们下面来一起看看吧，希望能帮助到大家。AJax所涉及到得技术： 1.使用CSS和XHTML来表示。 2. 使用DOM模型来交互和动态显示。 3.使用XMLHttpRequest来和服务器进行异步通信。(核心) 4.使用javas...

$选择器--是如何将DOM封装成jquery对象【图】

前言：说到jquery不得不说的就是强大的jquery的选择器功能啦。该功能很强大，还单独分离出来sizzle模块供只需用到选择器功能的朋友使用。（该篇先不说jquery选择器的强大功能，先说说jquery是如何将DOM元素封装成jquery对象的）一、Dom对象和jquery对象<body> <script src="https://cdn.bootcss.com/jquery/2.0.0/jquery.min.js"></script> <p id="box">测试</p> <script>var oBox = document.getElementById(box);var oBox2 = doc...

jqueryajax方法封装及api文件设计的代码示例

本篇文章给大家带来的内容是关于jquery ajax方法封装及api文件设计的代码示例，有一定的参考价值，有需要的朋友可以参考一下，希望对你有所帮助。封装 jquery ajax 文件/*** 封装 jquery ajax * 例如:* ajaxRequest.ajax.triggerService(* apiCommand, [命令数据] )* .then(successCallback, failureCallback);* );*/ var JSON2 = require(LibsDir/json2); var URL = ../AjaxHandler.aspx?r=;// 用来记录每次请求的唯一标识 va...