Ajax请求文档格式.docx
《Ajax请求文档格式.docx》由会员分享，可在线阅读，更多相关《Ajax请求文档格式.docx（12页珍藏版）》请在冰豆网上搜索。
类似的，指定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或者jsonp类似的数据。
当脚本和页面字符集不同时，这特别好用。
Ajax的第一个字母是asynchronous的开头字母，这意味着所有的操作都是并行的，完成的顺序没有前后关系。
$.ajax（）的async参数总是设置成true，这标志着在请求开始后，其他代码依然能够执行。
强烈不建议把这个选项设置成false，这意味着所有的请求都不再是异步的了，这也会导致浏览器被锁死。
$.ajax函数返回他创建的XMLHttpRequest对象。
通常jQuery只在内部处理并创建这个对象，但用户也可以通过xhr选项来传递一个自己创建的xhr对象。
返回的对象通常已经被丢弃了，但依然提供一个底层接口来观察和操控请求。
比如说，调用对象上的.abort（）可以在请求完成前挂起请求。
参数
options（可选）ObjectAJAX请求设置。
所有选项都是可选的。
选项
asyncBoolean（默认:
true）默认设置下，所有请求均为异步请求。
如果需要发送同步请求，请将此选项设置为false。
注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。
beforeSend（XHR）Function发送请求前可修改XMLHttpRequest对象的函数，如添加自定义HTTP头。
XMLHttpRequest对象是唯一的参数。
这是一个Ajax事件。
如果返回false可以取消本次ajax请求。
function（XMLHttpRequest）{
this;
//调用本次AJAX请求时传递的options参数
}
cacheBoolean（默认:
true,dataType为script和jsonp时默认为false）jQuery1.2新功能，设置为false将不缓存此页面。
complete（XHR,TS）Function请求完成后回调函数（请求成功或失败之后均调用）。
参数：
XMLHttpRequest对象和一个描述成功请求类型的字符串。
Ajax事件。
function（XMLHttpRequest,textStatus）{
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"
）;
}}）;
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返回的原始数据进行预处理
returndata//返回处理后的数据
dataTypeString
预期服务器返回的数据类型。
如果不指定，jQuery将自动根据HTTP包MIME信息来智能判断，比如XMLMIME类型就被识别为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之中
//只有一个会包含信息
globalBoolean（默认:
true）是否触发全局AJAX事件。
设置为false将不会触发全局AJAX事件，如ajaxStart或ajaxStop可用于控制不同的Ajax事件。
ifModifiedBoolean（默认:
false）仅在服务器数据改变时获取新数据。
使用HTTP包Last-Modified头信息判断。
在jQuery1.4中，他也会检查服务器指定的'
etag'
来确定数据没有被修改过。
jsonpString在一个jsonp请求中重写回调函数的名字。
这个值用来替代在"
这种GET或POST请求中URL参数里的"
callback"
部分，比如{jsonp:
onJsonPLoad'
}会导致将"
onJsonPLoad=?
传给服务器。
jsonpCallbackString为jsonp请求指定一个回调函数名。
这个值将用来取代jQuery自动生成的随机函数名。
这主要用来让jQuery生成度独特的函数名，这样管理请求更容易，也能方便地提供回调函数和错误处理。
你也可以在想让浏览器缓存GET请求的时候，指定这个回调函数名。
passwordString用于响应HTTP访问认证请求的密码
processDataBoolean（默认:
true）默认情况下，通过data选项传递进来的数据，如果是一个对象（技术上讲只要不是字符串），都会处理转化成一个查询字符串，以配合默认内容类型"
如果要发送DOM树信息或其它不希望转换的信息，请设置为false。
scriptCharsetString只有当请求时dataType为"
或"
，并且type是"
GET"
才会用于强制修改charset。
通常只在本地和远程的内容编码不同时使用。
successFunction请求成功后的回调函数。
由服务器返回，并根据dataType参数进行处理后的数据；
描述状态的字符串。
function（data,textStatus）{
//data可能是xmlDoc,jsonObj,html,text,等等...
traditionalBoolean如果你想要用传统的方式来序列化数据，那么就设置为true。
请参考工具分类下面的jQuery.param方法。
timeoutNumber设置请求超时时间（毫秒）。
此设置将覆盖全局设置。
typeString（默认:
）请求方式（"
POST"
或"
），默认为"
其它HTTP请求方法，如PUT和DELETE也可以使用，但仅部分浏览器支持。
urlString（默认:
当前页地址）发送请求的地址。
usernameString用于响应HTTP访问认证请求的用户名
xhrFunction需要返回一个XMLHttpRequest对象。
默认在IE下是ActiveXObject而其他情况下是XMLHttpRequest。
用于重写或者提供一个增强的XMLHttpRequest对象。
这个参数在jQuery1.3以前不可用。
示例
描述:
加载并执行一个JS文件。
jQuery代码:
$.ajax（{
type:
url:
test.js"
dataType:
}）;
保存数据到服务器，成功时显示信息。
some.php"
data:
name=John&
location=Boston"
success:
function（msg）{
alert（"
DataSaved:
+msg）;
}
装入一个HTML网页最新版本。
cache:
false,
function（html）{
$（"
#results"
）.append（html）;
同步加载数据。
发送请求时锁住浏览器。
需要锁定用户交互操作时使用同步方式。
varhtml=$.ajax（{
async:
false
}）.responseText;
发送XML数据至服务器。
设置processData选项为false，防止自动转换数据格式。
varxmlDocument=[createxmldocument];
$.ajax（{
page.php"
processData:
xmlDocument,
handleResponse
}）;
jQueryload（url,[data],[callback]）
载入远程HTML文件代码并插入至DOM中。
默认使用GET方式-传递附加参数时自动转换为POST方式。
jQuery1.2中，可以指定选择符，来筛选载入的HTML文档，DOM中将仅插入筛选出的HTML代码。
语法形如"
url#some>
selector"
请查看示例。
urlString待装入HTML网页网址。
data（可选）Map,String发送至服务器的key/value数据。
在jQuery1.3中也可以接受一个字符串了。
callback（可选）Callback载入成功时回调函数。
加载文章侧边栏导航部分至一个无序列表。
HTML代码:
<
b>
jQueryLinks:
/b>
ulid="
links"
>
/ul>
$（"
#links"
）.load（"
/Main_Page#p-Getting-Startedli"
加载feeds.html文件内容。
#feeds"
feeds.html"
同上，但是以POST形式发送附加参数并在成功时显示信息。
feeds.php"
{limit:
25},function（）{
alert（"
Thelast25entriesinthefeedhavebeenloaded"
XMLHttpRequestjQuery.get（url,[data],[callback],[type]）
通过远程HTTPGET请求载入信息。
这是一个简单的GET请求功能以取代复杂$.ajax。
请求成功时可调用回调函数。
如果需要在出错时执行函数，请使用$.ajax。
urlString待载入页面的URL地址
data（可选）Map待发送Key/value参数。
callback（可选）Function载入成功时回调函数。
type（可选）String返回内容格式，xml,html,script,json,text,_default。
请求test.php网页，忽略返回值。
$.get（"
test.php"
请求test.php网页，传送2个参数，忽略返回值。
{name:
John"
time:
2pm"
}）;
显示test.php返回值（HTML或XML，取决于返回值）。
function（data）{
DataLoaded:
+data）;
显示test.cgi返回值（HTML或XML，取决于返回值），添加一组请求参数。
test.cgi"
},
function（data）{
XMLHttpRequestjQuery.getJSON（url,[data],[callback]）
通过HTTPGET请求载入JSON数据。
在jQuery1.2中，您可以通过使用JSONP形式的回调函数来加载其他网域的JSON数据，如"
jQuery将自动替换?
注意：
此行以后的代码将在这个回调函数执行前执行。
urlString发送请求地址。
从FlickrJSONPAPI载入4张最新的关于猫的图片。
divid="
images"
/div>
$.getJSON（"
$.each（data.items,function（i,item）{
img/>
）.attr（"
src"
item.media.m）.appendTo（"
#images"
if（i==3）returnfalse;
从test.js载入JSON数据并显示JSON数据中一个name字段数据。
function（json）{
JSONData:
+json.users[3].name）;
从test.js载入JSON数据，附加参数，显示JSON数据中一个name字段数据。
},function（json）{
XMLHttpRequestjQuery.getScript（url,[callback]）
通过HTTPGET请求载入并执行一个JavaScript文件。
jQuery1.2版本之前，getScript只能调用同域JS文件。
1.2中，您可以跨域调用JavaScript文件。
Safari2或更早的版本不能在全局作用域中同步执行脚本。
如果通过getScript加入脚本，
升级会员 