jQuery学习笔记之Ajax用法详解

时间:2023-09-18 23:47:37

这篇文章主要介绍了jQuery学习笔记之Ajax用法,结合实例形式较为详细的分析总结了jQuery中ajax的相关使用技巧,包括ajax请求、载入、处理、传递等,需要的朋友可以参考下

本文实例讲述了jQuery学习笔记之Ajax用法。分享给大家供大家参考,具体如下:

原文链接:https://yq.aliyun.com/ziliao/153370

一、Ajax请求

  1、jQuery.ajax(options)

    通过 HTTP 请求加载远程数据。jQuery 底层 AJAX 实现。简单易用的高层实现见 .get,.post 等。

    .ajax()返回其创建的XMLHttpRequest对象。大多数情况下你无需直接操作该对象,但特殊情况下可用于手动终止请求。.ajax() 只有一个参数:参数 key/value 对象,包含各配置及回调函数信息。详细参数选项见下。

    注意:  如果你指定了 dataType 选项,请确保服务器返回正确的 MIME 信息,(如 xml 返回 "text/xml")。错误的 MIME 类型可能导致不可预知的错误。

    注意:如果dataType设置为"script",那么在远程请求时(不在同一个域下),所有POST请求都将转为GET请求。(因为将使用DOM的script标签来加载)

    jQuery 1.2 中,您可以跨域加载 JSON 数据,使用时需将数据类型设置为 JSONP。使用 JSONP 形式调用函数时,如 "myurl?callback=?" jQuery 将自动替换 ? 为正确的函数名,以执行回调函数。数据类型设置为 "jsonp" 时,jQuery 将自动调用回调函数。

    返回值: XMLHttpRequest

    参数:

    options (可选) : AJAX 请求设置。所有选项都是可选的。

    选项

    (1)、 async (Boolean)  : (默认: true)

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

    (2)、 beforeSend (Function)  : 发送请求前可修改 XMLHttpRequest 对象的函数,如添加自定义 HTTP 头。

      XMLHttpRequest 对象是唯一的参数。这是一个 Ajax 事件。如果返回false可以取消本次ajax请求。

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

    (3)、 cache (Boolean)  : (默认: true,dataType为script时默认为false) 。jQuery 1.2 新功能,设置为 false 将不会从浏览器缓存中加载请求信息。

    (4)、 complete (Function)  : 请求完成后回调函数 (请求成功或失败时均调用)。

      参数: XMLHttpRequest 对象和一个描述成功请求类型的字符串。 这是一个 Ajax 事件

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

    (5)、 contentType (String)  : (默认: " application/x-www-form-urlencoded ") 发送信息至服务器时内容编码类型。默认值适合大多数应用场合。

    (6)、 data (Object,String)  : 发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在URL 后。查看processData选项说明以禁止此自动转换。

      必须为 Key/Value 格式。如果为数组,jQuery 将自动为不同值对应同一个名称。如  {foo:["bar1", "bar2"]}  转换为 '&foo=bar1&foo=bar2'。

    (7)、 dataFilter (Function)  :给Ajax返回的原始数据的进行预处理的函数。提供data和type两个参数:data是Ajax返回的原始数据,type是调用jQuery.ajax时

      提供的dataType参数。函数返回的值将由jQuery进一步处理。

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

    (8)、 dataType (String)  : (默认值:智能判断xml或者html)

        预期服务器返回的数据类型。如果不指定,jQuery 将自动根据 HTTP 包 MIME 信息返回responseXML 或 responseText,并作为回调函数参数传递,可用值:

        "xml": 返回 XML 文档,可用 jQuery 处理。
        "html": 返回纯文本 HTML 信息;包含的script标签会在插入dom时执行。
        "script": 返回纯文本 JavaScript 代码。不会自动缓存结果。除非设置了"cache"参数。注意:在远程请求时(不在同一个域下),所有POST请求都将转为GET请求。(因为将使用DOM的script标签来加载)
        "json": 返回 JSON 数据 。
        "jsonp": JSONP 格式。使用 JSONP 形式调用函数时,如 " myurl?callback=? " jQuery 将自动替换 ? 为正确的函数名,以执行回调函数。
        "text": 返回纯文本字符串

    (9)、 error (Function)  : (默认: 自动判断 (xml 或 html)) 请求失败时调用时间。参数有以下三个:XMLHttpRequest 对象、错误信息、(可选)捕获的错误对象。

      如果发生了错误,错误信息(第二个参数)除了得到null之外,还可能是"timeout", "error", "notmodified" 和 "parsererror"。Ajax 事件。

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

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

    (11)、 ifModified (Boolean)  : (默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。  

    (12)、 jsonp (String)  : 在一个jsonp请求中重写回调函数的名字。这个值用来替代在"callback=?"这种GET或POST请求中URL参数里的"callback"部分,

        比如 {jsonp:'onJsonPLoad'} 会导致将"onJsonPLoad=?"传给服务器。

    (13)、 password (String)  : 用于响应HTTP访问认证请求的密码

    (14)、 processData (Boolean)  : (默认: true) 默认情况下,发送的数据将被转换为对象(技术上讲并非字符串) 以配合默认内容类型

        " application/x-www-form-urlencoded "。如果要发送 DOM 树信息或其它不希望转换的信息,请设置为 false。

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

    (16)、 success (Function)  : 请求成功后的回调函数。参数:由服务器返回,并根据dataType参数进行处理后的数据;描述状态的字符串。 Ajax 事件。

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

    (17)、 timeout (Number) : 设置请求超时时间(毫秒)。此设置将覆盖全局设置。

    (18)、 type (String)  : (默认: "GET") 请求方式 ("POST" 或 "GET"), 默认为 "GET"。注意:其它 HTTP 请求方法,如 PUT 和 DELETE 也可以使用,但仅部分浏览器

        支持。

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

    (20)、 username (String)  : 用于响应HTTP访问认证请求的用户名

    (21)、 xhr (Function)  : 需要返回一个XMLHttpRequest 对象。默认在IE下是ActiveXObject 而其他情况下是XMLHttpRequest 。用于重写或者提供一个增强的

        XMLHttpRequest 对象。这个参数在jQuery 1.3以前不可用。

     ps:上述的部分是 url  type  dataType  data  success 调用常用的参数设置,利用这几个参数就可以成功实现ajax调用了.

    示例

 //jQTest.js
function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
//1、 加载并执行一个 JS 文件
$.ajax({
type: "GET",
url: "js/jqLoadJs.js",
dataType: "script"
});
//2、装载一个 HTML 网页最新版本
$.ajax({
url: "test.htm",
cache: false, //没有缓存的说
success: function(html) {
//alert(html);
$("#spanGetHtml").css("display", "block");
$("#spanGetHtml").css("color", "red");
$("#spanGetHtml").append(html);
}
});
//3、获取并解析一个xml文件(从服务端获取xml)
$.ajax({
type: 'GET',
dataType: 'xml', //这里可以不写,但千万别写text或者html
url: jqRequestUrl + "?action=jquerGetXmlRequest",
success: function(xml) {
//正确解析服务端的xml文件
$(xml).find("profile").each(function(i) {
var name = $(this).children("userName").text(); //取对象文本
var location = $(this).children("location").text();
alert("Xml at SERVER is gotten by CLIENT:" + name + " is living in " + location);
});
},
error: function(xml) {
alert('An error happend while loading XML document ');
}
});
//4、发送 XML 数据至服务器(客户端发送xml到服务端)
var xmlDocument = "<profile>" +
" <userName>jeff wong</userName>" +
" <location>beijing</location>" +
"</profile>";
$.ajax({
url: jqRequestUrl + "?action=jqueryXmlRequest",
processData: false, //设置 processData 选项为 false,防止自动转换数据格式。
//type: "xml",
cache: false,
type: "xml",
data: xmlDocument,
success: function(html) {
alert(html); //弹出提示
$("#spanResult").css("display", "block");
$("#spanResult").css("color", "red");
$("#spanResult").html(html); //给当前dom的一个span元素赋值
},
error: function(oXmlHttpReq, textStatus, errorThrown) {
alert("jquery ajax xml request failed");
$("#spanResult").css("display", "block");
$("#spanResult").css("color", "red");
$("#spanResult").html("jquery ajax xml request failed"); //提示出错
}
});
//5、同步加载数据。发送请求时锁住浏览器。需要锁定用户交互操作时使用同步方式。
var html = $.ajax({
//没有type 默认为GET方式
url: jqRequestUrl + "?action=syncRequest",
async: false
}).responseText;
alert(html);
//6、显式get测试
$.ajax({
type: "GET",
url: jqRequestUrl + "?action=jquery&userName=" + $("#txtUserName").val(),
cache: false,
success: function(html) {
// alert(html); //弹出提示
$("#spanResult").css("display", "block");
$("#spanResult").css("color", "red");
$("#spanResult").html(html); //给当前dom的一个span元素赋值
},
error: function(oXmlHttpReq, textStatus, errorThrown) {
alert("jquery ajax request failed");
$("#spanResult").css("display", "block");
$("#spanResult").css("color", "red");
$("#spanResult").html("jquery ajax request failed"); //提示出错
}
});
//7、显式POST测试
$.ajax({
type: "POST",
url: jqRequestUrl,
data: "action=jquerySaveData&userName=jeffwong&location=beijing",
success: function(html) {
alert(html);
}
});
}

2、load(url,[data],[callback])

  载入远程 HTML 文件代码并插入至 DOM 中。

  默认使用 GET 方式 - 传递附加参数时自动转换为 POST 方式。jQuery 1.2 中,可以指定选择符,来筛选载入的 HTML 文档,DOM 中将仅插入筛选出的 HTML 代码。语法形如 "url #some > selector"。

  返回值 jQuery

  参数

     url (String)  : 待装入 HTML 网页网址。

     data (Map,String)  : (可选) 发送至服务器的 key/value 数据。在jQuery 1.3中也可以接受一个字符串了。

     callback (Callback)  : (可选) 载入成功时回调函数。

  示例

 function jqAjaxTest() {
$("#spanResult").load("test.htm");
$("#spanResult").css("display", "block");
$("#spanResult").css("color", "red");
}

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

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

  这是一个简单的 GET 请求功能以取代复杂 .ajax。请求成功时可调用回调函数。如果需要在出错时执行函数,请使用.ajax。

  返回值  XMLHttpRequest

  参数

     url (String)  : 待载入页面的URL地址

     data (Map)  : (可选) 待发送 Key/value 参数。

     callback (Function)  : (可选) 载入成功时回调函数。

     type (String)  : (可选) 返回内容格式,xml, html, script, json, text, _default。

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
$.get(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqGetNormalCallBack, 'text'); //返回数据类型
}
function jqGetNormalCallBack(oData) {
$("#spanResult").html(oData);//这里直接json数据绑定了,下一个jquery方法会有处理
$("#spanResult").css("display", "block");
$("#spanResult").css("color", "red");
}

  ps:本例中,我们返回的是一段json类型的数据,在客户端没有对json类型数据进行处理,在下一个方法(jQuery.getJSON)中会改进处理的。

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

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

  在 jQuery 1.2 中,您可以通过使用JSONP 形式的回调函数来加载其他网域的JSON数据,如 "myurl?callback=?"。jQuery 将自动替换 ? 为正确的函数名,以执行回调函数。 
  注意:此行以后的代码将在这个回调函数执行前执行。

  返回值  XMLHttpRequest

  参数

     url (String)  : 发送请求地址。
     data (Map)  : (可选) 待发送 Key/value 参数。
     callback (Function)  : (可选) 载入成功时回调函数。

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
//getJSON方法调用
$.getJSON(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqGetJsonCallBack); //返回json数据类型
}
//对json数据进行处理 (oData是json类型的数据)
function jqGetJsonCallBack(oData) {
var oJsonStr = "";
//取json中的数据,并呈现
oJsonStr += "userName:" + oData.userName + " location:" + oData.location + "<br/>";
//在div中显示所有数据
$("#divResult").html(oJsonStr);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

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

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

  jQuery 1.2 版本之前,getScript 只能调用同域 JS 文件。 1.2中,您可以跨域调用 JavaScript 文件。注意:Safari 2 或更早的版本不能在全局作用域中同步执行脚本。如果通过 getScript 加入脚本,请加入延时函数。

  返回值  XMLHttpRequest

  参数

     url (String)  : 待载入 JS 文件地址。

     callback (Function)  : (可选) 成功载入后回调函数。

  示例

 function jqAjaxTest() {
var jsUrl = "js/jqLoadJs.js";
//getScript方法调用
$.getScript(jsUrl, jqGetJsCallBack);
}
//oData返回的是整个js路径下js文件内容
function jqGetJsCallBack(oData) {
alert(oData);
}

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

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

  这是一个简单的 POST 请求功能以取代复杂 .ajax。请求成功时可调用回调函数。如果需要在出错时执行函数,请使用.ajax。

  返回值  XMLHttpRequest

  参数

     url (String)  : 发送请求地址。

     data (Map)  : (可选) 待发送 Key/value 参数。

     callback (Function)  : (可选) 发送成功时回调函数。

     type (String)  : (可选) 返回内容格式,xml, html, script, json, text, _default。

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
$.post(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqPostCallBack, "text"); //返回text数据类型
}
function jqPostCallBack(oData) {
//在div中显示所有数据
$("#divResult").html(oData);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

二、Ajax事件

  1、ajaxComplete(callback)

    AJAX 请求完成时执行函数。Ajax 事件。

    XMLHttpRequest 对象和设置作为参数传递给回调函数。

    返回值  jQuery

    参数

     callback (Function)  : 待执行函数

    示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
$.post(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqPostCallBack, "text"); //返回text数据类型
//AJAX 请求完成时执行函数
$("#divResult").ajaxComplete(function(event, request, settings) {
$(this).append("<br/>请求完成.");
});
}
function jqPostCallBack(oData) {
//在div中显示所有数据
$("#divResult").html(oData);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

  2、ajaxError(callback)

    AJAX 请求发生错误时执行函数。Ajax 事件。

    XMLHttpRequest 对象和设置作为参数传递给回调函数。捕捉到的错误可作为最后一个参数传递。

    返回值  jQuery

    参数

     callback (Function)  : 待执行函数

 function (event, XMLHttpRequest, ajaxOptions, thrownError) {
// thrownError 只有当异常发生时才会被传递
this; // 监听的 dom 元素
}

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandlers.ashx"; //正确的文件名 AjaxHandler.ashx 这里故意写错 引发ajaxError事件
$.post(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqPostCallBack, "text");
}
//AJAX 请求发生错误时执行函数 (这一段放在jqAjaxTest函数内也可以)
$("#divResult").ajaxError(function(event, request, settings) {
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
$(this).append("<br/>出错页面:" + settings.url);
});
function jqPostCallBack(oData) {
//在div中显示所有数据
$("#divResult").html(oData);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

  3、ajaxSend(callback)

  AJAX 请求发送前执行函数。Ajax 事件。

  XMLHttpRequest 对象和设置作为参数传递给回调函数。

  返回值  jQuery

  参数

  callback (Function) : 待执行函数

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
$.post(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqPostCallBack, "text");
}
//AJAX 请求发送前执行函数
$("#divResult").ajaxSend(function(evt, request, settings) {
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
$(this).append("<br/>开始请求: " + settings.url + "<br/>");
});
function jqPostCallBack(oData) {
//在div中显示所有数据
$("#divResult").append(oData);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

  4、ajaxStart(callback)

  AJAX 请求开始时执行函数。Ajax 事件。

  返回值  jQuery

  参数

  callback (Function) : 待执行函数

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
$.post(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqPostCallBack, "text");
}
//AJAX 请求开始时执行函数
$("#divResult").ajaxStart(function() {
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
$(this).append("<br/>请求开始了<br/>");
});
function jqPostCallBack(oData) {
//在div中显示所有数据
$("#divResult").append(oData);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

  5、ajaxStop(callback)

  AJAX 请求结束时执行函数。Ajax 事件。

  返回值  jQuery

  参数

  callback (Function) : 待执行函数

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
$.post(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqPostCallBack, "text");
}
//AJAX 请求开始时执行函数
$("#divResult").ajaxStop(function() {
$(this).append("<br/>请求已经结束了<br/>");
});
function jqPostCallBack(oData) {
//在div中显示所有数据
$("#divResult").append(oData);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

  6、ajaxSuccess(callback)

  AJAX 请求成功时执行函数。Ajax 事件。

  XMLHttpRequest 对象和设置作为参数传递给回调函数。

  返回值  jQuery

  参数

  callback (Function) : 待执行函数

  示例

 function jqAjaxTest() {
var jqRequestUrl = "AjaxHandler.ashx";
$.post(jqRequestUrl + "?action=jquery", { userName: "jeff wong", location: "beijing" }, jqPostCallBack, "text");
}
//AJAX 请求成功时执行函数
$("#divResult").ajaxSuccess(function(evt, request, settings) {
$(this).append("<br/>请求成功<br/>");
$(this).append(settings.url);
});
function jqPostCallBack(oData) {
//在div中显示所有数据
$("#divResult").append(oData);
$("#divResult").css("display", "block");
$("#divResult").css("color", "red");
}

三、其他

  1、jQuery.ajaxSetup(options)

  设置全局 AJAX 默认选项。

  参数见 '$.ajax' 说明。

  返回值  jQuery

  参数

   options (可选) : 选项设置。所有设置项均为可选设置。

  示例

 //设置 AJAX 请求默认地址为 "AjaxHandler.ashx",禁止触发全局 AJAX 事件,用 POST 代替默认 GET 方法。其后的 AJAX 请求不再设置任何选项参数。
$.ajaxSetup({
url: "AjaxHandler.ashx",
global: false,
type: "POST"
});

  2、serialize()

  序列化表单内容为字符串。

  返回值  jQuery

  参数

  序列化表单内容为字符串,用于 Ajax 请求。

  示例

 $(document).ready(function() {
var oSerializedStr = $("form").serialize(); //序列化表单内容为字符串
$("#results").append("<tt>" + oSerializedStr + "</tt>");
});

  文档片段

 <body>
<p id="results">
<b>Results: </b>
</p>
<form>
<select name="single">
<option>Single</option>
<option>Single2</option>
</select>
<select name="multiple" multiple="multiple">
<option selected="selected">Multiple</option>
<option>Multiple2</option>
<option selected="selected">Multiple3</option>
</select><br />
<input type="checkbox" name="check" value="check1" />
check1
<input type="checkbox" name="check" value="check2" checked="checked" />
check2
<input type="radio" name="radio" value="radio1" checked="checked" />
radio1
<input type="radio" name="radio" value="radio2" />
radio2
</form>
<script src="js/jQTest.js" type="text/javascript"></script>
</body>

  3、serializeArray()

  序列化表单内容,返回 JSON 数据结构数据。

  返回值  jQuery

  参数

  序列化表单内容为JSON ,用于 Ajax 请求。

  示例

 $(document).ready(function() {
var fields = $("select, :radio").serializeArray(); //序列化表单select和raido为json
jQuery.each(fields, function(i, field) {
$("#results").append(field.value + " ");
});
});

jQuery封装好的ajax函数用起来确实方便,有了这样的“神兵利器”,以后写ajax的应用程序肯定会更加得心应手。