jQuery.ajax()

概述    jQuery.ajax( url [, settings ] )

返回值：XMLHttpRequest

说明: 执行一个异步的HTTP（Ajax）的请求。

• V : 1.5jQuery.ajax( url [, settings ] )

  • url
    类型: String
    一个用来包含发送请求的URL字符串。
  • settings
    类型: PlainObject
    一个以"{键:值}"组成的AJAX 请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。看jQuery.ajax( settings )下所有设置的完整列表。

• V : 1.0jQuery.ajax( [settings ] )

  • settings
    类型: PlainObject
    一个以"{键:值}"组成的AJAX 请求设置。所有选项都是可选的。可以使用$.ajaxSetup()设置任何默认参数。
    • accepts (默认: 取决于数据类型)
      类型: PlainObject
      一个键/值对集合映射给定的dataType 到其的MIME类型，它可以从发送Accept请求头信息中获得。 请求头信息通知服务器该请求需要接收何种类型的返回结果。 例如，下面定义一个自定义类型的mycustomtype与请求一起发送：

      $.ajax({
        accepts: {
          mycustomtype: 'application/x-some-custom-type'
        },
       
        // Instructions for how to deserialize a `mycustomtype`
        converters: {
          'text mycustomtype': function(result) {
            // Do Stuff
            return newresult;
          }
        },
       
        // Expect a `mycustomtype` back from server
        dataType: 'mycustomtype'
      });

      注意: 对于这种类型，为了使其正常工作，您将需要在converters中指定补充项。
    • async (默认: true)
      类型: Boolean
      默认设置下，所有请求均为异步请求（也就是说这是默认设置为 true ）。如果需要发送同步请求，请将此选项设置为 false 。跨域请求和 dataType: "jsonp" 请求不支持同步操作。注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。从 jQuery 1.8 开始, jqXHR ($.Deferred)中使用 async: false 已经过时。您必须使用的 success/error/complete 的回调选项代替相应的jqXHR对象的方法，比如jqXHR.done() 或者过时的jqXHR.success()。
    • beforeSend
      类型: Function( jqXHR jqXHR, PlainObject settings )
      请求发送前的回调函数，用来修改请求发送前jqXHR（在jQuery 1.4.x的中，XMLHttpRequest）对象，此功能用来设置自定义 HTTP 头信息，等等。该jqXHR和设置对象作为参数传递。这是一个Ajax事件 。在beforeSend函数中返回false将取消这个请求。从jQuery 1.5开始， beforeSend选项将被访问，不管请求的类型。
    • cache (默认: true, dataType为"script"和"jsonp"时默认为false)
      类型: Boolean
      如果设置为 false ，浏览器将不缓存此页面。注意: 设置cache为 false将在 HEAD和GET请求中正常工作。它的工作原理是在GET请求参数中附加"_={timestamp}"（译者注：时间戳）。该参数不是其他请求所必须的，除了在IE8中，当一个POST请求一个已经用GET请求过的URL。
    • complete
      类型: Function( jqXHR jqXHR, String textStatus )
      请求完成后回调函数 (请求success 和 error之后均调用)。这个回调函数得到2个参数： jqXHR (在 jQuery 1.4.x中是 XMLHTTPRequest) 对象和一个描述请求状态的字符串("success", "notmodified", "nocontent"，"error", "timeout", "abort", 或者 "parsererror") 。从jQuery 1.5开始， complete设置可以接受一个函数的数组。每个函数将被依次调用。这是一个Ajax事件 。
    • contents
      类型: PlainObject
      一个以"{字符串/正则表达式}"配对的对象，根据给定的内容类型，解析请求的返回结果。 (1.5新增)
    • contentType (default: 'application/x-www-form-urlencoded; charset=UTF-8')
      Type: Boolean or String
      当将数据发送到服务器时，使用该内容类型。默认值是"application/x-www-form-urlencoded; charset=UTF-8"，适合大多数情况。如果你明确地传递了一个内容类型（Content-Type）给 $.ajax()，那么他总是会发送给服务器（即使没有数据要发送）。从 jQuery 1.6 开始，你可以传递false来告诉jQuery，没有设置任何内容类型头信息。 注意：W3C的XMLHttpRequest的规范规定，数据将总是使用UTF-8字符集传递给服务器；指定其他字符集无法强制浏览器更改编码。 注意:对于跨域请求，内容类型设置为application/x-www-form-urlencoded, multipart/form-data, 或 text/plain以外， 将触发浏览器发送一个预检OPTIONS请求到服务器。
    • context
      类型: Object
      这个对象用于设置Ajax相关回调函数的上下文。 默认情况下，这个上下文是一个ajax请求使用的参数设置对象，（$.ajaxSettings合并独傲这个设置，传递给$.ajax）。比如指定一个DOM元素作为context参数，这样就设置了complete回调函数的上下文为这个DOM元素。就像这样：

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

    • converters (默认: {"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML})
      类型: PlainObject
      一个数据类型到数据类型转换器的对象。每个转换器的值是一个函数，返回经转换后的请求结果。 ( 1.5新增)
    • crossDomain (默认: 同域请求为false， 跨域请求为true)
      类型: Boolean
      如果你想在同一域中强制跨域请求（如JSONP形式），例如，想服务器端重定向到另一个域，那么需要将crossDomain设置为 true 。 ( 1.5 新增)
    • data
      类型: PlainObject 或 String 或 Array
      发送到服务器的数据。它被转换成一个查询字符串,如果已经是一个字符串的话就不会转换。查询字符串将被追加到GET请求的URL后面。参见 processData 选项说明，以防止这种自动转换。对象必须为"{键:值}"格式。如果这个参数是一个数组，jQuery会按照traditional 参数的值， 将自动转化为一个同名的多值查询字符串(查看下面的说明)。手册网注：如 {foo:["bar1", "bar2"]} 转换为 '&foo=bar1&foo=bar2'。
    • dataFilter
      类型: Function( String data, String type ) => Anything
      一个函数被用来处理XMLHttpRequest的原始响应数据。这是一个预过滤功能，净化响应。您应该返回安全数据。提供data和type两个参数：data是Ajax返回的原始数据，type是调用jQuery.ajax时提供的dataType参数。
    • dataType (default: Intelligent Guess (xml, json, script, or html))
      Type: String
      从服务器返回你期望的数据类型。 如果没有指定，jQuery将尝试通过MIME类型的响应信息来智能判断（一个XML MIME类型就被识别为XML，在1.4中 JSON将生成一个JavaScript对象，在1.4中 script 将执行该脚本，其他任何类型会返回一个字符串）。 可用的类型（以及结果作为第一个参数传递给成功回调函数）有：

      • "xml": 返回 XML 文档，可以通过 jQuery 处理。
      • "html": 返回纯文本 HTML 文本；包含的script标签会在插入DOM时执行。
      • "script": 把响应的结果当作 JavaScript 执行，并将其当作纯文本返回。默认情况下会通过在URL中附加查询字符串变量 ，_=[TIMESTAMP]， 禁用缓存结果，除非设置了cache参数为true。注意: 在远程请求时(不在同一个域下)，所有POST请求都将转为GET请求。(手册网注：因为将使用DOM的script标签来加载)
      • "json":把响应的结果当作 JSON 执行，并返回一个JavaScript对象。跨域"json" 请求转换为"jsonp"，除非该请求在其请求选项中设置了jsonp:false。JSON 数据以严格的方式解析; 任何畸形的JSON将被拒绝，并且抛出解析错误信息。在jQuery1.9中，一个空响应也将被拒绝;服务器应该返回null或 {}响应代替。（见json.org的更多信息，正确的JSON格式。）
      • "jsonp": 以 JSONP 的方式载入 JSON 数据块。会自动在所请求的URL最后添加"?callback=?"。默认情况下会通过在URL中附加查询字符串变量 ，_=[TIMESTAMP]， 禁用缓存结果，除非设置了cache参数为true。
      • "text": 返回纯文本字符串。
      • 多个用空格分割的值:从 jQuery 1.5 开始， jQuery可以内容类型（Content-Type）头收到并转换一个您需要的数据类型。例如，如果你想要一个文本响应为XML处理，使用"text xml"数据类型。您也可以将一个JSONP的请求，以文本形式接受，并用jQuery以XML解析: "jsonp text xml"。同样地可以使用"jsonp xml"简写,首先会尝试从 jsonp 到 xml 的转换，如果转换失败，就先将 jsonp 转换成 text, 然后再由 text 转换成 xml。
    • error
      类型: Function( jqXHR jqXHR, String textStatus, String errorThrown )
      请求失败时调用此函数。有以下三个参数：jqXHR (在 jQuery 1.4.x前为XMLHttpRequest) 对象、描述发生错误类型的一个字符串 和 捕获的异常对象。如果发生了错误，错误信息（第二个参数）除了得到null之外，还可能是"timeout", "error", "abort" ，和 "parsererror"。 当一个HTTP错误发生时，errorThrown 接收HTTP状态的文本部分，比如： "Not Found"（没有找到） 或者 "Internal Server Error."（服务器内部错误）。 从jQuery 1.5开始, 在error设置可以接受函数组成的数组。每个函数将被依次调用。 注意：此处理程序在跨域脚本和JSONP形式的请求时不被调用。这是一个 Ajax Event。
    • global (默认: true)
      类型: Boolean
      无论怎么样这个请求将触发全局AJAX事件处理程序。默认是true 。设置为 false 将不会触发全局 AJAX 事件，如 ajaxStart 或者 ajaxStop。这可以用来控制各种 Ajax Event.
    • headers (默认: {})
      类型: PlainObject
      一个额外的"{键:值}"对映射到请求一起发送。此设置会在beforeSend 函数调用之前被设置 ;因此，请求头中的设置值，会被beforeSend 函数内的设置覆盖 。 (1.5 新增 ）
    • ifModified (默认: false)
      类型: Boolean
      只有上次请求响应改变时，才允许请求成功。使用 HTTP 包 Last-Modified 头信息判断。默认值是false，忽略HTTP头信息。在jQuery 1.4中，他也会检查服务器指定的'etag'来确定数据没有被修改过。
    • isLocal (默认: 取决于当前的位置协议)
      类型: Boolean
      允许当前环境被认定为“本地”，（如文件系统），即使jQuery默认情况下不会这么做。以下协议目前公认为本地：file, *-extension, and widget。如果isLocal设置需要修改，建议在$.ajaxSetup()方法中这样做一次。 (1.5 新增 ）
    • jsonp
      类型: String 或者 Boolean
      在一个JSONP请求中重写回调函数的名字。这个值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分，比如{jsonp:'onJsonPLoad'}会导致将"onJsonPLoad=?"传给服务器。在jQuery 1.5，，设置jsonp选项为false，阻止了jQuery从加入"?callback"字符串的URL或试图使用"=?"转换。在这种情况下，你也应该明确设置jsonpCallback设置。例如, { jsonp: false, jsonpCallback: "callbackName" }。如果你不信任你的Ajax请求的目标，出于安全原因， 考虑 设置jsonp 属性为false。
    • jsonpCallback
      类型: String, Function
      为jsonp请求指定一个回调函数名。这个值将用来取代jQuery自动生成的随机函数名。这主要用来让jQuery生成一个独特的函数名，这样管理请求更容易，也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存GET请求的时候，指定这个回调函数名。从jQuery 1.5开始，你也可以使用一个函数作为该参数设置，在这种情况下，该函数的返回值就是jsonpCallback的结果。
    • method (default: 'GET')
      Type: String
      HTTP 请求方法 (比如："POST", "GET ", "PUT")。 (添加版本: 1.9.0)。（手册网注：如果你使用jQuery 1.9.0 之前的版本，你需要使用type选项。）
    • mimeType
      类型: String
      一个mime类型用来覆盖XHR的 MIME类型。 (1.5 新增 ）
    • password
      类型: String
      用于响应HTTP访问认证请求的密码
    • processData (默认: true)
      类型: Boolean
      默认情况下，通过data选项传递进来的数据，如果是一个对象(技术上讲只要不是字符串)，都会处理转化成一个查询字符串，以配合默认内容类型 "application/x-www-form-urlencoded"。如果要发送 DOM 树信息或其它不希望转换的信息，请设置为 false。
    • scriptCharset
      类型: String
      仅适用于当"script"传输使用时（例如，跨域的"jsonp"或 dataType选项为"script" 和 "GET"类型）。请求中使用在script标签上设置charset 属性。通常只在本地和远程的内容编码不同时使用。
    • statusCode (默认: {})
      类型: PlainObject

      一个 HTTP响应状态码 和 当请求响应相应的状态码时执行的函数 组成的对象。例如： 下面的代码将在http响应状态码为404时弹出“page not found”。

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

      如果请求成功，响应状态代码对应的函数会带着success回调函数相同的参数；如果请求结果是错误的（包含3xx之类的重定向），他们会采用error回调函数相同的参数。

      (1.5 新增 ）
    • success
      Type: Function( Anything data, String textStatus, jqXHR jqXHR )
      请求成功后的回调函数。这个函数传递3个参数：从服务器返回的数据，并根据dataType参数进行处理后的数据或dataFilter回调函数，如果指定的话；一个描述状态的字符串;还有 jqXHR（在jQuery 1.4.x前为XMLHttpRequest） 对象 。在jQuery 1.5， 成功设置可以接受一个函数数组。每个函数将被依次调用。这是一个 Ajax Event
    • timeout
      类型: Number
      设置请求超时时间（毫秒）。此设置将覆盖$.ajaxSetup() 里的全局设置。 超时周期开始于$.ajax 访问成功的那个时间点；如果几个其他请求都在进步并且浏览器有没有可用的连接，它有可能在被发送前就超时了。在 jQuery 1.4.x 和前面的版本中, 如果请求超时，XMLHttpRequest对象是处于无效状态;访问任何对象的成员可能会抛出一个异常。只有在 Firefox 3.0+,script 和 JSONP请求在超时后不能被取消;该脚本将运行即使超时后到达。
    • traditional
      类型: Boolean
      如果你想要用传统的方式来序列化数据，那么就设置为true。请参考工具分类下面的jQuery.param 方法.
    • type (默认: 'GET')
      类型: String
      method选项的别名。如果你使用jQuery 1.9.0 之前的版本，你需要使用type选项。
    • url (默认: 当前页面地址)
      类型: String
      发送请求的地址。
    • username
      类型: String
      于响应HTTP访问认证请求的用户名
    • xhr (默认: 当可用的ActiveXObject（IE）中，否则为XMLHttpRequest)
      类型: Function()
      回调创建XMLHttpRequest对象。当可用时默认为ActiveXObject（IE）中，否则为XMLHttpRequest。提供覆盖你自己的执行的XMLHttpRequest或增强工厂。
    • xhrFields
      类型: PlainObject

      一对“文件名-文件值”组成的映射，用于设定原生的 XHR对象。例如，如果需要的话，在进行跨域请求时，你可以用它来设置withCredentials为true。

      $.ajax({
         url: a_cross_domain_url,
         xhrFields: {
            withCredentials: true
         }
      });

      在 jQuery 1.5中， withCredentials属性不会传递给原生的XHR从而对于需要使用此属性的 CORS 请求，则只能忽略这个属性。。出于这个原因，我们建议您使用jQuery1.5.1+，如果您需要使用它。

      (1.5.1新增)

$.ajax();

$.ajax({
  url: "http://fiddle.jshell.net/favicon.png",
  beforeSend: function ( xhr ) {
    xhr.overrideMimeType("text/plain; charset=x-user-defined");
  }
}).done(function ( data ) {
  if( console && console.log ) {
    console.log("Sample of data:", data.slice(0, 100));
  }
});

// Assign handlers immediately after making the request,
// and remember the jqxhr object for this request
var jqxhr = $.ajax( "example.php" )
    .done(function() { alert("success"); })
    .fail(function() { alert("error"); })
    .always(function() { alert("complete"); });
 
// perform other work here ...
 
// Set another completion function for the request above
jqxhr.always(function() { alert("second complete"); });

(function () {
  var _super = jQuery.ajaxSettings.xhr,
    xhrCorsHeaders = [ "Cache-Control", "Content-Language", "Content-Type", "Expires", "Last-Modified", "Pragma" ];
 
  jQuery.ajaxSettings.xhr = function () {
    var xhr = _super(),
      getAllResponseHeaders = xhr.getAllResponseHeaders;
 
    xhr.getAllResponseHeaders = function () {
      var allHeaders = "";
      try {
        allHeaders = getAllResponseHeaders.apply( xhr );
        if ( allHeaders ) {
          return allHeaders;
        }
      } catch ( e ) {
      }
 
      $.each( xhrCorsHeaders, function ( i, headerName ) {
        if ( xhr.getResponseHeader( headerName ) ) {
          allHeaders += headerName + ": " + xhr.getResponseHeader( headerName ) + "\n";
        }
      });
      return allHeaders;
    };
 
    return xhr;
  };
})();

$.ajaxSetup({
  contents: {
    mycustomtype: /mycustomtype/
  },
  converters: {
    "mycustomtype json": function ( result ) {
      // do stuff
      return newresult;
    }
  }
});

$.ajaxSetup({
  contents: {
    mycustomtype: /mycustomtype/
  },
  converters: {
    "text mycustomtype": true,
    "mycustomtype json": function ( result ) {
      // do stuff
      return newresult;
    }
  }
});

Additional Notes:（其他注意事项：）

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

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

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

var menuId = $("ul.nav").first().attr("id");
var request = $.ajax({
  url: "script.php",
  method: "POST",
  data: {id : menuId},
  dataType: "html"
});
 
request.done(function(msg) {
  $("#log").html( msg );
});
 
request.fail(function(jqXHR, textStatus) {
  alert( "Request failed: " + textStatus );
});

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

• 上一篇：$.escapeSelector(selector)
• load()：下一篇