【转】 jQuery学习笔记：Ajax(一)

【转】 jQuery学习笔记：Ajax(一)

一、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:上述红色标出的部分是大多数ajax调用常用的参数设置，利用这几个参数就可以成功实现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);
        }
    });
}

几个相关文件：
a、处理ajax请求的服务端文件：AjaxHandler.ashx，对应的cs文件：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.SessionState;
using System.Xml;

namespace MyJqTest
{
    public class AjaxHandler : IHttpHandler, IRequiresSessionState
    {
        /// <summary>
        /// 可复用
        /// </summary>
        public bool IsReusable
        {
            get
            {
                return true;
            }
        }

        public void ProcessRequest(HttpContext context)
        {
            AjaxOperations(context);
        }

        private void AjaxOperations(HttpContext context)
        {
            string action = context.Request["action"];
            if (!string.IsNullOrEmpty(action))
            {
                switch (action)
                {
                    default:
                        break;
                    case "jquery":
                        ProcessJQueryRequest(context);
                        break;
                    case "jquerySaveData":
                        ProcessJQuerySaveData(context);
                        break;
                    case "syncRequest":
                        ProcessJQuerySyncRequest(context);
                        break;
                    case "jqueryXmlRequest":
                        ProcessJQueryXMLRequest(context);
                        break;
                    case "jquerGetXmlRequest":
                        ProcessJQueryGetXMLRequest(context);
                        break;
                }
            }
        }

        private void ProcessJQueryRequest(HttpContext context)
        {
            context.Response.ClearContent();
            context.Response.ContentType = "text/plain"; //设置输出流类型
            context.Response.Cache.SetCacheability(HttpCacheability.NoCache); //没有缓存
            string result = context.Request["userName"].Trim();
            context.Response.Write("You have entered a name:" + result);
        }

        private void ProcessJQuerySaveData(HttpContext context)
        {
            context.Response.ClearContent();
            context.Response.ContentType = "text/plain"; //设置输出流类型
            context.Response.Cache.SetCacheability(HttpCacheability.NoCache); //没有缓存
            string name = context.Request["userName"].Trim();
            string location = context.Request["location"].Trim();
            context.Response.Write("Your data have been saved:your name is " + name + ",living in " + location);
        }

        private void ProcessJQuerySyncRequest(HttpContext context)
        {
            context.Response.ClearContent();
            context.Response.ContentType = "text/plain"; //设置输出流类型
            context.Response.Cache.SetCacheability(HttpCacheability.NoCache); //没有缓存
            context.Response.Write("Your sync ajax request has been processed.");
        }

        /// <summary>
        /// 简单的xml请求处理(服务端从客户端获取xml)
        /// </summary>
        /// <param name="context"></param>
        private void ProcessJQueryXMLRequest(HttpContext context)
        {
            context.Response.ClearContent();
            context.Response.Cache.SetCacheability(HttpCacheability.NoCache); //没有缓存
            XmlDocument doc = new XmlDocument();
            try
            {
                doc.Load(context.Request.InputStream); //获取xml (这里需要注意接受xml数据的方法)
                context.Response.ContentType = "text/plain"; //设置输出流类型
                string name = doc.SelectSingleNode("profile/userName").InnerText;
                string location = doc.SelectSingleNode("profile/location").InnerText;
                context.Response.Write("Your XML data have received,and your name is " + name + ",living in " + location);
            }
            catch (Exception ex)
            {
                context.Response.Write("Get xml data failed.");
                throw ex;
            }
        }

        /// <summary>
        /// 返回简单的xml(服务端返回客户端xml)
        /// </summary>
        /// <param name="context"></param>
        private void ProcessJQueryGetXMLRequest(HttpContext context)
        {
            context.Response.ClearContent();
            context.Response.Cache.SetCacheability(HttpCacheability.NoCache); //没有缓存
            XmlDocument doc = new XmlDocument();
            try
            {
                doc.Load(context.Server.MapPath("/jeffWong.xml"));
                context.Response.ContentType = "text/xml;charset=UTF-8"; //设置输出流类型
                context.Response.Write(doc.OuterXml);
            }
            catch (Exception ex)
            {
                context.Response.Write("Load xml data failed.");
                throw ex;
            }
        }

    }
}

 b、aspx，html和xml文件（直接放在根目录下）
aspx文件是ajax请求页面：

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="JQuery.aspx.cs" Inherits="MyJqTest.JQuery" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>

    <script src="js/jquery-1.3.1.js" type="text/javascript"></script>

</head>
<body>
    <form id="form1" runat="server">
    <div>
        &nbsp;&nbsp;<span style="display: none" id="spanGetHtml"></span>
        <br />
        Please input a name:<input id="txtUserName" type="text" /><input id="btnJQAjax" type="button"
            value="jQuery ajax 请求" onclick="jqAjaxTest()" />
        &nbsp;&nbsp;<span style="display: none" id="spanResult"></span>
    </div>

    <script src="js/jQTest.js" type="text/javascript"></script>

    </form>
</body>
</html>

html很简单：

//test.htm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title></title>
</head>
<body>
<div>it is a simple ajax test</div>
</body>
</html>

xml文件：

//jeffWong.xml

<?xml version="1.0" encoding="utf-8" ?>
<profile>
  <userName>jeff wong</userName>
  <location>beijing</location>
</profile>

c、js文件（放在根目录js文件夹下）

//jqLoadJs.js  测试ajax加载js文件用
alert("this is a ajax request script test");

 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");
}

 下篇接着介绍jquery的ajax几个高层调用方式。