jQuery.ajax(url,[settings])

概述

经过 HTTP 请求加载远程数据。

jQuery 底层 AJAX 实现。简单易用的高层实现见 $.get, $.post 等。$.ajax() 返回其建立的 XMLHttpRequest 对象。大多数状况下你无需直接操做该函数，除非你须要操做不经常使用的选项，以得到更多的灵活性。

最简单的状况下，$.ajax()能够不带任何参数直接使用。

注意，全部的选项均可以经过$.ajaxSetup()函数来全局设置。

回调函数

若是要处理$.ajax()获得的数据，则须要使用回调函数。beforeSend、error、dataFilter、success、complete。

• beforeSend 在发送请求以前调用，而且传入一个XMLHttpRequest做为参数。
• error 在请求出错时调用。传入XMLHttpRequest对象，描述错误类型的字符串以及一个异常对象（若是有的话）
• dataFilter 在请求成功以后调用。传入返回的数据以及"dataType"参数的值。而且必须返回新的数据（多是处理过的）传递给success回调函数。
• success 当请求以后调用。传入返回后的数据，以及包含成功代码的字符串。
• complete 当请求完成以后调用这个函数，不管成功或失败。传入XMLHttpRequest对象，以及一个包含成功或错误代码的字符串。

数据类型

$.ajax()函数依赖服务器提供的信息来处理返回的数据。若是服务器报告说返回的数据是XML，那么返回的结果就能够用普通的XML方法或者jQuery的选择器来遍历。若是见获得其余类型，好比HTML，则数据就以文本形式来对待。

经过dataType选项还能够指定其余不一样数据处理方式。除了单纯的XML，还能够指定 html、json、jsonp、script或者text。

其中，text和xml类型返回的数据不会通过处理。数据仅仅简单的将XMLHttpRequest的responseText或responseHTML属性传递给success回调函数，

'''注意'''，咱们必须确保网页服务器报告的MIME类型与咱们选择的dataType所匹配。好比说，XML的话，服务器端就必须声明 text/xml 或者 application/xml 来得到一致的结果。

若是指定为html类型，任何内嵌的JavaScript都会在HTML做为一个字符串返回以前执行。相似的，指定script类型的话，也会先执行服务器端生成JavaScript，而后再把脚本做为一个文本数据返回。

若是指定为json类型，则会把获取到的数据做为一个JavaScript对象来解析，而且把构建好的对象做为结果返回。为了实现这个目的，他首先尝试使用JSON.parse()。若是浏览器不支持，则使用一个函数来构建。JSON数据是一种能很方便经过JavaScript解析的结构化数据。若是获取的数据文件存放在远程服务器上（域名不一样，也就是跨域获取数据），则须要使用jsonp类型。使用这种类型的话，会建立一个查询字符串参数 callback=? ，这个参数会加在请求的URL后面。服务器端应当在JSON数据前加上回调函数名，以便完成一个有效的JSONP请求。若是要指定回调函数的参数名来取代默认的callback，能够经过设置$.ajax()的jsonp参数。

注意，JSONP是JSON格式的扩展。他要求一些服务器端的代码来检测并处理查询字符串参数。更多信息能够参阅 最初的文章。

若是指定了script或者jsonp类型，那么当从服务器接收到数据时，其实是用了<script>标签而不是XMLHttpRequest对象。这种状况下，$.ajax()再也不返回一个XMLHttpRequest对象，而且也不会传递事件处理函数，好比beforeSend。

发送数据到服务器

默认状况下，Ajax请求使用GET方法。若是要使用POST方法，能够设定type参数值。这个选项也会影响data选项中的内容如何发送到服务器。

data选项既能够包含一个查询字符串，好比 key1=value1&key2=value2 ，也能够是一个映射，好比 {key1: 'value1', key2: 'value2'} 。若是使用了后者的形式，则数据再发送器会被转换成查询字符串。这个处理过程也能够经过设置processData选项为false来回避。若是咱们但愿发送一个XML对象给服务器时，这种处理可能并不合适。而且在这种状况下，咱们也应当改变contentType选项的值，用其余合适的MIME类型来取代默认的 application/x-www-form-urlencoded 。

高级选项

global选项用于阻止响应注册的回调函数，好比.ajaxSend，或者ajaxError，以及相似的方法。这在有些时候颇有用，好比发送的请求很是频繁且简短的时候，就能够在ajaxSend里禁用这个。更多关于这些方法的详细信息，请参阅下面的内容。

若是服务器须要HTTP认证，可使用用户名和密码能够经过username和password选项来设置。

Ajax请求是限时的，因此错误警告被捕获并处理后，能够用来提高用户体验。请求超时这个参数一般就保留其默认值，要不就经过jQuery.ajaxSetup来全局设定，不多为特定的请求从新设置timeout选项。

默认状况下，请求总会被发出去，但浏览器有可能从他的缓存中调取数据。要禁止使用缓存的结果，能够设置cache参数为false。若是但愿判断数据自从上次请求后没有更改过就报告出错的话，能够设置ifModified为true。

scriptCharset容许给<script>标签的请求设定一个特定的字符集，用于script或者jsonp相似的数据。当脚本和页面字符集不一样时，这特别好用。

Ajax的第一个字母是asynchronous的开头字母，这意味着全部的操做都是并行的，完成的顺序没有先后关系。$.ajax()的async参数老是设置成true，这标志着在请求开始后，其余代码依然可以执行。强烈不建议把这个选项设置成false，这意味着全部的请求都再也不是异步的了，这也会致使浏览器被锁死。

$.ajax函数返回他建立的XMLHttpRequest对象。一般jQuery只在内部处理并建立这个对象，但用户也能够经过xhr选项来传递一个本身建立的xhr对象。返回的对象一般已经被丢弃了，但依然提供一个底层接口来观察和操控请求。好比说，调用对象上的.abort()能够在请求完成前挂起请求。

参数

url,[settings]

url:一个用来包含发送请求的URL字符串。

settings:AJAX 请求设置。全部选项都是可选的。

settings:选项

acceptsMap

默认： 取决于数据类型。

内容类型发送请求头，告诉服务器什么样的响应会接受返回。若是accepts设置须要修改，推荐在$.ajaxSetup()方法中作一次。

asyncBoolean

(默认: true) 默认设置下，全部请求均为异步请求。若是须要发送同步请求，请将此选项设置为 false。注意，同步请求将锁住浏览器，用户其它操做必须等待请求完成才能够执行。

beforeSend(XHR)Function

发送请求前可修改 XMLHttpRequest 对象的函数，如添加自定义 HTTP 头。XMLHttpRequest 对象是惟一的参数。这是一个 Ajax 事件。若是返回false能够取消本次ajax请求。

function (XMLHttpRequest) {
    this; // 调用本次AJAX请求时传递的options参数
}

 

cacheBoolean

(默认: true,dataType为script和jsonp时默认为false) jQuery 1.2 新功能，设置为 false 将不缓存此页面。

complete(XHR, TS)Function

请求完成后回调函数 (请求成功或失败以后均调用)。参数： XMLHttpRequest 对象和一个描述成功请求类型的字符串。 Ajax 事件。

function (XMLHttpRequest, textStatus) {
    this; // 调用本次AJAX请求时传递的options参数
}

 

contentsMapV1.5

一个以"{字符串:正则表达式}"配对的对象，用来肯定jQuery将如何解析响应，给定其内容类型。

contentTypeString

(默认: "application/x-www-form-urlencoded") 发送信息至服务器时内容编码类型。默认值适合大多数状况。若是你明确地传递了一个content-type给 $.ajax() 那么他一定会发送给服务器（即便没有数据要发送）

contextObject

这个对象用于设置Ajax相关回调函数的上下文。也就是说，让回调函数内this指向这个对象（若是不设定这个参数，那么this就指向调用本次AJAX请求时传递的options参数）。好比指定一个DOM元素做为context参数，这样就设置了success回调函数的上下文为这个DOM元素。就像这样：

$.ajax({ url: "test.html", context: document.body, success: function(){
    $(this).addClass("done");
}});

 

convertersmapV1.5

默认： {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}

一个数据类型对数据类型转换器的对象。每一个转换器的值是一个函数，返回响应的转化值

crossDomainmapV1.5

默认： 同域请求为false

跨域请求为true若是你想强制跨域请求（如JSONP形式）同一域，设置crossDomain为true。这使得例如，服务器端重定向到另外一个域

dataObject,String

发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在 URL 后。查看 processData 选项说明以禁止此自动转换。必须为 Key/Value 格式。若是为数组，jQuery 将自动为不一样值对应同一个名称。如 {foo:["bar1", "bar2"]} 转换为 "&foo=bar1&foo=bar2"。

dataFilterFunction

给Ajax返回的原始数据的进行预处理的函数。提供data和type两个参数：data是Ajax返回的原始数据，type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。

function (data, type) {
    // 对Ajax返回的原始数据进行预处理
    return data  // 返回处理后的数据
}

 

dataTypeString

 

预期服务器返回的数据类型。若是不指定，jQuery 将自动根据 HTTP 包 MIME 信息来智能判断，好比XML MIME类型就被识别为XML。在1.4中，JSON就会生成一个JavaScript对象，而script则会执行这个脚本。随后服务器端返回的数据会根据这个值解析后，传递给回调函数。可用值:

"xml": 返回 XML 文档，可用 jQuery 处理。

"html": 返回纯文本 HTML 信息；包含的script标签会在插入dom时执行。

"script": 返回纯文本 JavaScript 代码。不会自动缓存结果。除非设置了"cache"参数。'''注意：'''在远程请求时(不在同一个域下)，全部POST请求都将转为GET请求。(由于将使用DOM的script标签来加载)

"json": 返回 JSON 数据 。

"jsonp": JSONP 格式。使用 JSONP 形式调用函数时，如 "myurl?callback=?" jQuery 将自动替换 ? 为正确的函数名，以执行回调函数。

"text": 返回纯文本字符串

 

errorFunction

(默认: 自动判断 (xml 或 html)) 请求失败时调用此函数。有如下三个参数：XMLHttpRequest 对象、错误信息、（可选）捕获的异常对象。若是发生了错误，错误信息（第二个参数）除了获得null以外，还多是"timeout", "error", "notmodified" 和 "parsererror"。Ajax 事件。

function (XMLHttpRequest, textStatus, errorThrown) {
    // 一般 textStatus 和 errorThrown 之中
    // 只有一个会包含信息
    this; // 调用本次AJAX请求时传递的options参数
}

 

globalBoolean

(默认: true) 是否触发全局 AJAX 事件。设置为 false 将不会触发全局 AJAX 事件，如 ajaxStart 或 ajaxStop 可用于控制不一样的 Ajax 事件。

headersmapV1.5

Default: {}

一个额外的"{键:值}"对映射到请求一块儿发送。此设置被设置以前beforeSend函数被调用;所以，消息头中的值设置能够在覆盖beforeSend函数范围内的任何设置。

ifModifiedBoolean

(默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。在jQuery 1.4中，他也会检查服务器指定的'etag'来肯定数据没有被修改过。

isLocalmapV1.5.1

默认: 取决于当前的位置协议

容许当前环境被认定为“本地”，（如文件系统），即便jQuery默认状况下不会认可它。如下协议目前公认为本地：file, *-extension, and widget。若是isLocal设置须要修改，建议在$.ajaxSetup()方法中这样作一次。

jsonpString

在一个jsonp请求中重写回调函数的名字。这个值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分，好比{jsonp:'onJsonPLoad'}会致使将"onJsonPLoad=?"传给服务器。

jsonpCallbackString

为jsonp请求指定一个回调函数名。这个值将用来取代jQuery自动生成的随机函数名。这主要用来让jQuery生成度独特的函数名，这样管理请求更容易，也能方便地提供回调函数和错误处理。你也能够在想让浏览器缓存GET请求的时候，指定这个回调函数名。

mimeTypeStringV1.5.1

一个mime类型用来覆盖XHR的 MIME类型。

passwordString

用于响应HTTP访问认证请求的密码

processDataBoolean

(默认: true) 默认状况下，经过data选项传递进来的数据，若是是一个对象(技术上讲只要不是字符串)，都会处理转化成一个查询字符串，以配合默认内容类型 "application/x-www-form-urlencoded"。若是要发送 DOM 树信息或其它不但愿转换的信息，请设置为 false。

scriptCharsetString

只有当请求时dataType为"jsonp"或"script"，而且type是"GET"才会用于强制修改charset。一般只在本地和远程的内容编码不一样时使用。

statusCodemapV1.5

默认: {}

一组数值的HTTP代码和函数对象，当响应时调用了相应的代码。例如，若是响应状态是404，将触发如下警报：

$.ajax({
  statusCode: {404: function() {
    alert('page not found');
  }
});

 

success(data, textStatus, jqXHR)Function,Array

请求成功后的回调函数。参数：由服务器返回，并根据dataType参数进行处理后的数据；描述状态的字符串。还有 jqXHR（在jQuery 1.4.x的中，XMLHttpRequest） 对象 。在jQuery 1.5， 成功设置能够接受一个函数数组。每一个函数将被依次调用。 Ajax 事件。

function (data, textStatus) {
    // data 多是 xmlDoc, jsonObj, html, text, 等等...
    this; // 调用本次AJAX请求时传递的options参数
}

 

traditionalBoolean

若是你想要用传统的方式来序列化数据，那么就设置为true。请参考工具分类下面的jQuery.param 方法。

timeoutNumber

设置请求超时时间（毫秒）。此设置将覆盖全局设置。

typeString

(默认: "GET") 请求方式 ("POST" 或 "GET")， 默认为 "GET"。注意：其它 HTTP 请求方法，如 PUT 和 DELETE 也可使用，但仅部分浏览器支持。

urlString

(默认: 当前页地址) 发送请求的地址。

usernameString

用于响应HTTP访问认证请求的用户名

xhrFunction

须要返回一个XMLHttpRequest 对象。默认在IE下是ActiveXObject 而其余状况下是XMLHttpRequest 。用于重写或者提供一个加强的XMLHttpRequest 对象。这个参数在jQuery 1.3之前不可用。

xhrFieldsmapV1.5

一对“文件名-文件值”在本机设置XHR对象。例如，若是须要的话，你能够用它来设置withCredentials为true的跨域请求。

示例

描述:

加载并执行一个 JS 文件。

jQuery 代码:

$.ajax({
  type: "GET",
  url: "test.js",
  dataType: "script"
});

描述:

保存数据到服务器，成功时显示信息。

jQuery 代码:

$.ajax({
   type: "POST",
   url: "some.php",
   data: "name=John&location=Boston",
   success: function(msg){
     alert( "Data Saved: " + msg );
   }
});

描述:

装入一个 HTML 网页最新版本。

jQuery 代码:

$.ajax({
  url: "test.html",
  cache: false,
  success: function(html){
    $("#results").append(html);
  }
});

描述:

同步加载数据。发送请求时锁住浏览器。须要锁定用户交互操做时使用同步方式。

jQuery 代码:

var html = $.ajax({
  url: "some.php",
  async: false
 }).responseText;

描述:

发送 XML 数据至服务器。设置 processData 选项为 false，防止自动转换数据格式。

jQuery 代码:

var xmlDocument = [create xml document];
 $.ajax({
   url: "page.php",
   processData: false,
   data: xmlDocument,
   success: handleResponse
 });