返回介绍

$.ajax

发布于 2019-05-26 13:21:41 字数 4952 浏览 1214 评论 0 收藏 0

$.ajax(options)   ⇒ XMLHttpRequest

执行Ajax请求。它可以是本地资源,或者通过支持HTTP access control的浏览器 或者通过 JSONP来实现跨域。

选项:

  • type(默认: “GET”):请求方法 (“GET”, “POST”, or other)
  • url (默认: 当前地址):发送请求的地址
  • data (默认:none):发送到服务器的数据;如果是GET请求,它会自动被作为参数拼接到url上。非String对象将通过 $.param 得到序列化字符串。
  • processData (默认: true): 对于非Get请求。是否自动将 data 转换为字符串。
  • contentType (默认: “application/x-www-form-urlencoded”): 发送信息至服务器时内容编码类型。 (这也可以通过设置 headers)。通过设置 false 跳过设置默认值。
  • mimeType (默认: none): 覆盖响应的MIME类型。 v1.1+
  • dataType (默认: none):预期服务器返回的数据类型(“json”, “jsonp”, “xml”, “html”, or “text”)
  • jsonp (默认:“callback”): JSONP回调查询参数的名称
  • jsonpCallback (默认: “jsonp{N}”): 全局JSONP回调函数的 字符串(或返回的一个函数)名。设置该项能启用浏览器的缓存。 v1.1+
  • timeout (默认: 0): 以毫秒为单位的请求超时时间, 0 表示不超时。
  • headers: Ajax请求中额外的HTTP信息头对象
  • async (默认:true): 默认设置下,所有请求均为异步。如果需发送同步请求,请将此设置为 false
  • global (默认:true): 请求将触发全局Ajax事件处理程序,设置为 false 将不会触发全局 Ajax 事件。
  • context (默认:window): 这个对象用于设置Ajax相关回调函数的上下文(this指向)。
  • traditional (默认: false): 激活传统的方式通过$.param来得到序列化的 data
  • cache (默认: true): 浏览器是否应该被允许缓存GET响应。从v1.1.4开始,当dataType选项为"script"jsonp时,默认为false
  • xhrFields (默认: none): 一个对象包含的属性被逐字复制到XMLHttpRequest的实例。 v1.1+
  • username & password (默认: none): HTTP基本身份验证凭据。 v1.1+

如果URL中含有 =?或者dataType是“jsonp”,这讲求将会通过注入一个 <script>标签来代替使用 XMLHttpRequest (查看 JSONP)。此时 contentType, dataType, headers有限制,async 不被支持。

Ajax 回调函数

你可以指定以下的回调函数,他们将按给定的顺序执行:

  1. beforeSend(xhr, settings):请求发出前调用,它接收xhr对象和settings作为参数对象。如果它返回 false ,请求将被取消。

  2. success(data, status, xhr):请求成功之后调用。传入返回后的数据,以及包含成功代码的字符串。

  3. error(xhr, errorType, error):请求出错时调用。 (超时,解析错误,或者状态码不在HTTP 2xx)。

  4. complete(xhr, status):请求完成时调用,无论请求失败或成功。

Promise 回调接口 v1.1+

如果可选的“callbacks” 和 “deferred” 模块被加载,从$.ajax()返回的XHR对象实现了promise接口链式的回调:

xhr.done(function(data, status, xhr){ ... })
xhr.fail(function(xhr, errorType, error){ ... })
xhr.always(function(){ ... })
xhr.then(function(){ ... })

这些方法取代了 success, error, 和 complete 回调选项.

Ajax 事件

global: true时。在Ajax请求生命周期内,以下这些事件将被触发。

  1. ajaxStart (global):如果没有其他Ajax请求当前活跃将会被触发。

  2. ajaxBeforeSend (data: xhr, options):再发送请求前,可以被取消。

  3. ajaxSend (data: xhr, options):像 ajaxBeforeSend,但不能取消。

  4. ajaxSuccess (data: xhr, options, data):当返回成功时。

  5. ajaxError (data: xhr, options, error):当有错误时。

  6. ajaxComplete (data: xhr, options):请求已经完成后,无论请求是成功或者失败。

  7. ajaxStop (global):如果这是最后一个活跃着的Ajax请求,将会被触发。

默认情况下,Ajax事件在document对象上触发。然而,如果请求的 context 是一个DOM节点,该事件会在此节点上触发然后再DOM中冒泡。唯一的例外是 ajaxStart & ajaxStop这两个全局事件。

$(document).on('ajaxBeforeSend', function(e, xhr, options){
  // This gets fired for every Ajax request performed on the page.
  // The xhr object and $.ajax() options are available for editing.
  // Return false to cancel this request.
})
$.ajax({
  type: 'GET',
  url: '/projects',
  // data to be added to query string:
  data: { name: 'Zepto.js' },
  // type of data we are expecting in return:
  dataType: 'json',
  timeout: 300,
  context: $('body'),
  success: function(data){// Supposing this JSON payload was received://   {"project": {"id": 42, "html": "<div>..." }}// append the HTML to context object.this.append(data.project.html)
  },
  error: function(xhr, type){alert('Ajax error!')
  }
})
// post a JSON payload:
$.ajax({
  type: 'POST',
  url: '/projects',
  // post payload:
  data: JSON.stringify({ name: 'Zepto.js' }),
  contentType: 'application/json'
})

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文