JQuery系列之ajax请求

---

一、jQuery.ajax(url,[settings])

1、概述

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

2、语法

jQuery.ajax(url, [settings]);

3、参数

• url：一个用来包含发送请求的URL字符串。
• settings：AJAX 请求设置。所有选项都是可选的。

4、settings选项

4.1、accepts

type：Map
默认： 取决于数据类型。

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

4.2、async

type：Boolean

(默认：true) 默认设置下，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为 false。注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。

4.3、beforeSend(XHR)

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

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

4.4、cache

type：Boolean

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

4.5、complete(XHR, TS)

type：Function

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

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

4.6、contents

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

4.7、contentType

type：String

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

4.8、context

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

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

4.9、converters

type：Map
默认： {“* text”: window.String, “text html”: true, “text json”: jQuery.parseJSON, “text xml”: jQuery.parseXML}

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

4.10、crossDomain

type：Map
默认： 同域请求为false

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

4.11、data

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

4.12、dataFilter

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

4.13、dataType

type：String
预期服务器返回的数据类型。如果不指定，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”: 返回纯文本字符串

4.14、error

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

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

4.15、global

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

4.16、headers

type：Map
Default: {}

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

4.17、ifModified

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

4.18、isLocal

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

允许当前环境被认定为“本地”，（如文件系统），即使jQuery默认情况下不会承认它。以下协议目前公认为本地：file, *-extension, and widget。如果isLocal设置需要修改，建议在$.ajaxSetup()方法中这样做一次。

4.19、jsonp

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

4.20、jsonpCallback

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

4.21、mimeType

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

4.22、password

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

4.23、processData

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

4.24、scriptCharset

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

4.25、statusCode

type：Map
默认: {}

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

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

4.26、success(data, textStatus, jqXHR)

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

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

4.27、traditional

type：Boolean
如果你想要用传统的方式来序列化数据，那么就设置为true。

4.28、timeout

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

4.30、type

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

4.31、url

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

4.32、username

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

4.33、xhr

type：Function
需要返回一个XMLHttpRequest 对象。默认在IE下是ActiveXObject 而其他情况下是XMLHttpRequest 。用于重写或者提供一个增强的XMLHttpRequest 对象。这个参数在jQuery 1.3以前不可用。

4.34、xhrFields

type：Map
一对“文件名-文件值”在本机设置XHR对象。例如，如果需要的话，你可以用它来设置withCredentials为true的跨域请求。

5、示例

加载并执行一个 JS 文件。

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

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

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

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

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

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

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

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

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

二、jQuery.get(url, [data], [callback], [type])

1、概述

通过远程 HTTP GET 请求载入信息。

2、语法

jQuery.get(url, [data], [callback], [type]);

3、参数

• url:待载入页面的URL地址【String】
• data:待发送 Key/value 参数。【Map】
• callback:载入成功时回调函数。【Function】
• type:返回内容格式，xml, html, script, json, text, _default。【String】

4、示例

请求 test.php 网页，忽略返回值。

$.get("test.php");

请求 test.php 网页，传送2个参数，忽略返回值。

$.get("test.php", { name: "John", time: "2pm" });

显示 test.php 返回值(HTML 或 XML，取决于返回值)。

$.get("test.php", function (data) {
	alert("Data Loaded: " + data);
});

显示 test.cgi 返回值(HTML 或 XML，取决于返回值)，添加一组请求参数。

$.get("test.cgi", { name: "John", time: "2pm" }, function (data) {
	alert("Data Loaded: " + data);
});

jQuery 1.12 中 jQuery.get()支持对象参数

jQuery.get({
	url: "/example"
});

3、jQuery.getJSON(url, [data], [callback])

3.1、概述

通过 HTTP GET 请求载入 JSON 数据。

3.2、语法

jQuery.getJSON(url, [data], [callback]);

3.3、参数

• url:发送请求地址。
• data:待发送 Key/value 参数。
• callback:载入成功时回调函数。

3.4、示例

从 Flickr JSONP API 载入 4 张最新的关于猫的图片。

<div id="images"></div>

$.getJSON("https://api.flickr.com/services/feeds/photos_public.gne?tags=cat&tagmode=any&format=json&jsoncallback=?", function (data) {
	$.each(data.items, function (i, item) {
		$("<img/>").attr("src", item.media.m).appendTo("#images");
		if (i == 3) return false;
	});
});

从 test.js 载入 JSON 数据并显示 JSON 数据中一个 name 字段数据。

$.getJSON("test.js", function (json) {
	alert("JSON Data: " + json.users[3].name);
});

从 test.js 载入 JSON 数据，附加参数，显示 JSON 数据中一个 name 字段数据。

$.getJSON("test.js", { name: "John", time: "2pm" }, function (json) {
	alert("JSON Data: " + json.users[3].name);
});

三、jQuery.getScript(url, [callback])

1、概述

通过 HTTP GET 请求载入并执行一个 JavaScript 文件。

2、语法

jQuery.getScript(url, [callback])

3、参数

• url:待载入 JS 文件地址。
• callback:成功载入后回调函数。

4、示例

载入 <a title="https://jquery.com/plugins/project/color" class="external text" href="https://jquery.com/plugins/project/color">jQuery 官方颜色动画插件</a> 成功后绑定颜色变化动画。

<button id="go">» Run</button>
<div class="block"></div>

jQuery.getScript("https://dev.jquery.com/view/trunk/plugins/color/jquery.color.js", function () {
	$("#go").click(function () {
		$(".block").animate({ backgroundColor: "pink" }, 1000).animate({ backgroundColor: "blue" }, 1000);
	});
});

加载并执行 test.js。

$.getScript("test.js");

加载并执行 test.js ，成功后显示信息。

$.getScript("test.js", function () {
	alert("Script loaded and executed.");
});

四、jQuery.post(url, [data], [callback], [type])

1、概述

通过远程 HTTP POST 请求载入信息。

2、语法

jQuery.post(url, [data], [callback], [type]);

3、参数

• url:发送请求地址。
• data:待发送 Key/value 参数。
• callback:发送成功时回调函数。
• type:返回内容格式，xml, html, script, json, text, _default。

4、示例

请求 test.php 网页，忽略返回值：

$.post("test.php");

请求 test.php 页面，并一起发送一些额外的数据（同时仍然忽略返回值）：

$.post("test.php", { name: "John", time: "2pm" });

向服务器传递数据数组（同时仍然忽略返回值）：

$.post("test.php", { "choices[]": ["Jon", "Susan"] });

使用 ajax 请求发送表单数据：

$.post("test.php", $("#testform").serialize());

输出来自请求页面 test.php 的结果（HTML 或 XML，取决于所返回的内容）：

$.post("test.php", function (data) {
	alert("Data Loaded: " + data);
});

向页面 test.php 发送数据，并输出结果（HTML 或 XML，取决于所返回的内容）：

$.post("test.php", { name: "John", time: "2pm" }, function (data) {
	alert("Data Loaded: " + data);
});

获得 test.php 页面的内容，并存储为 XMLHttpResponse 对象，并通过 process() 这个 JavaScript 函数进行处理：

$.post(
	"test.php",
	{ name: "John", time: "2pm" },
	function (data) {
		process(data);
	},
	"xml"
);

获得 test.php 页面返回的 json 格式的内容：

$.post(
	"test.php",
	{ func: "getNameAndTime" },
	function (data) {
		alert(data.name); // John
		console.log(data.time); //  2pm
	},
	"json"
);

jQuery 1.12 中 jQuery.post支持对象参数

jQuery.post({
	url: "/example"
});

写在最后

如果你感觉文章不咋地//(ㄒoㄒ)//，就在评论处留言，作者继续改进；o_O???
如果你觉得该文章有一点点用处，可以给作者点个赞；\\*^o^*//
如果你想要和作者一起进步，可以微信扫描二维码，关注前端老L；~~~///(^v^)\\\~~~
谢谢各位读者们啦(^_^)∠※！！！