DIV CSS 佈局教程網

原生 XMLHttpRequest 與 jQuery.ajax 的 JSON 通訊實戰
編輯:關於JavaScript     

AJAX 是後台互動的基礎。本文用同一個 .ashx 端點,分別示範原生 XMLHttpRequest、$.ajax 系列方法,以及如何自己封裝一個迷你版 ajax,最後說明後端如何處理與序列化 JSON。

一、原生 AJAX 的七個步驟

  1. 建立 XMLHttpRequest 物件(不同瀏覽器建立方式不同)。
  2. 準備請求路徑。
  3. 用 open() 設定請求方法與 URL。
  4. 用 send() 送出。
  5. 用 responseText 取得伺服器回傳的字串。
  6. 用 responseXML 取得 XML 形式的回應。
  7. 需要時用 W3C DOM 方法解析該 XML 文件。

二、頁面結構

用幾個 HTML5 表單元素做輸入來源,加上六個按鈕分別觸發不同呼叫方式:

<label>E-mail</label><input type="email" id="UserEmail" value="251608027@qq.com" /><br />
<label>URL:</label><input type="url" id="UserURL" value="https://www.baidu.com" /><br />
<label>Number:</label><input type="number" id="UserNumber" min="1" max="100" value="87" /><br />
<label>Range:</label><input type="range" id="UserRange" min="1" max="100" value="78" /><br />
<label>Date:</label><input type="date" id="UserDate" value="2015-12-01" /><br />
<label>Search:</label><input type="search" id="UserSearch" value="search" /><br />
<label id="lblMsg" style="color:Red;"></label><br />
<input type="button" id="btnXmlHttp" value="提 交" onclick="return xmlPost();" />
<input type="button" id="btnAjax" value="Ajax 提交" onclick="return Ajax();" />
<input type="button" id="btnPost" value="Post 提交" onclick="return Post();" />
<input type="button" id="btnGet" value="Get 提交" onclick="return Get();" />
<input type="button" id="btnGetJSON" value="GetJSON 提交" onclick="return GetJSON();" />
<input type="button" id="btnCustom" value="Custom 提交" onclick="return Custom();" />

三、共用資料與回應處理

// 收集表單資料
var jsonData = {
    UserEmail: $("#UserEmail").val(),
    UserURL: $("#UserURL").val(),
    UserNumber: $("#UserNumber").val(),
    UserRange: $("#UserRange").val(),
    UserDate: $("#UserDate").val(),
    UserSearch: $("#UserSearch").val()
};

// 統一處理回傳結果
function Data(data, type) {
    if (data && data.length > 0) {
        var lblMsg = "";
        for (var i = 0; i < data.length; i++) {
            for (var j in data[i]) {
                lblMsg += j + ":" + data[i][j];
                if (j != "Name" && j != "UserSearch") { lblMsg += ","; }
            }
            lblMsg += ";";
        }
        $("#lblMsg").html(type + "請求成功,返回結果:" + lblMsg);
    }
}

四、原生 XMLHttpRequest 實作

建立物件時,舊版 IE 需要按版本依序嘗試 ActiveX:

function createXMLHttp() {
    var XmlHttp;
    if (window.ActiveXObject) {
        var arr = ["MSXML2.XMLHttp.6.0", "MSXML2.XMLHttp.5.0", "MSXML2.XMLHttp.4.0",
                   "MSXML2.XMLHttp.3.0", "MSXML2.XMLHttp", "Microsoft.XMLHttp"];
        for (var i = 0; i < arr.length; i++) {
            try { XmlHttp = new ActiveXObject(arr[i]); return XmlHttp; } catch (error) { }
        }
    } else {
        try { XmlHttp = new XMLHttpRequest(); return XmlHttp; } catch (otherError) { }
    }
}

function xmlPost() {
    var xmlHttp = createXMLHttp();
    var queryStr = "Ajax_Type=Email&jsonData=" + JSON.stringify(jsonData);
    var url = "/Handler/AjaxHandlerHelper.ashx?no=" + Math.random(); // 破快取

    xmlHttp.open('Post', url, true);   // true 表示非同步
    xmlHttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
    xmlHttp.send(queryStr);

    xmlHttp.onreadystatechange = function () {
        // readyState 4 = 完成,status 200 = 成功
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200) {
            var data = eval(xmlHttp.responseText);
            Data(data, "javascript 原生 xmlHttp");
        }
    };
}

三個重點:open 的第三個參數控制同步與否,實務上永遠用 true;POST 時必須手動設定 Content-Type,否則後端收不到表單欄位;URL 上拼 Math.random() 是為了繞過快取,現在也可以改用 cache: false 或適當的 HTTP 標頭。

五、jQuery 的四種呼叫方式

// 1. $.ajax:最完整,可設定 beforeSend / complete / error
function Ajax() {
    $.ajax({
        url: "/Handler/AjaxHandlerHelper.ashx?no=" + Math.random(),
        type: "Post",
        async: false,
        data: { Ajax_Type: "Email", jsonData: JSON.stringify(jsonData) },
        dataType: "json",
        beforeSend: function () { $("#btnPost").attr('disabled', "true"); },
        complete: function () { $("#btnPost").removeAttr("disabled"); },
        error: function (XMLHttpRequest, textStatus, errorThrown) {
            alert("error!" + errorThrown);
        },
        success: function (data) { Data(data, "Jquery $.ajax"); }
    });
}

// 2. $.post
function Post() {
    $.post("/Handler/AjaxHandlerHelper.ashx?no=" + Math.random(),
        { Ajax_Type: "Email", jsonData: JSON.stringify(jsonData) },
        function (data) { Data(data, "Jquery $.post"); });
}

// 3. $.getJSON:jQuery 會自動把回應字串轉成物件
function GetJSON() {
    $.getJSON("/Handler/AjaxHandlerHelper.ashx?no=" + Math.random(),
        { Ajax_Type: "Email", jsonData: JSON.stringify(jsonData) },
        function (data) { Data(data, "Jquery $.getJSON"); });
}

// 4. $.get
function Get() {
    $.get("/Handler/AjaxHandlerHelper.ashx?no=" + Math.random(),
        { Ajax_Type: "Email", jsonData: JSON.stringify(jsonData) },
        function (data) { Data(data, "Jquery $.get"); });
}

dataType: "json" 讓 jQuery 自動呼叫 JSON.parse,回呼裡直接拿到物件;beforeSend 與 complete 則是處理按鈕 loading 狀態的好位置。範例中的 async: false 是為了教學方便,正式環境請勿使用 —— 同步請求會凍住整個 UI 執行緒。

六、自己封裝一個迷你 ajax

var CustomAjax = function (custom) {
    var type = custom.type || "get";
    var url = custom.url;
    var data = custom.data;
    var dataType = custom.dataType || "text";
    var success = custom.success;

    var xmlHttp = createXMLHttp();
    xmlHttp.open(type, url, true);

    if (type.toLowerCase() == "get") {
        xmlHttp.send(null);
    } else {
        xmlHttp.setRequestHeader("content-type", "application/x-www-form-urlencoded");
        xmlHttp.send(data);
    }

    xmlHttp.onreadystatechange = function () {
        if (xmlHttp.readyState == 4 && xmlHttp.status == 200) {
            var t = dataType.toLowerCase();
            if (t == "text") {
                if (success) success(xmlHttp.responseText);
            } else if (t == "xml") {
                if (success) success(xmlHttp.responseXML);
            } else if (t == "json") {
                // 用 JSON.parse 取代 eval
                if (success) success(JSON.parse(xmlHttp.responseText));
            }
        }
    };
};

function Custom() {
    CustomAjax({
        type: "Post",
        url: "/Handler/AjaxHandlerHelper.ashx?no=" + Math.random(),
        data: "Ajax_Type=Email&jsonData=" + JSON.stringify(jsonData),
        dataType: "json",
        success: function (data) { Data(data, "Custom 自定義"); }
    });
}

封裝的價值在於把「建立物件、設定標頭、判斷 readyState、解析 dataType」這些重複動作收起來,呼叫端只關心 url、data 和 success。

七、後端:.ashx 一般處理常式

using System;
using System.Web;
using System.Web.Script.Serialization;
using System.Runtime.Serialization.Json;
using System.IO;
using System.Text;

namespace WebHTML5.Handler
{
    public class AjaxHandlerHelper : IHttpHandler
    {
        public void ProcessRequest(HttpContext context)
        {
            context.Response.ContentType = "application/json";

            // GET 從 QueryString 取,POST 從 Form 取
            var Ajax_Type = context.Request.QueryString["Ajax_Type"] == null
                ? context.Request.Form["Ajax_Type"]
                : context.Request.QueryString["Ajax_Type"];

            switch (Ajax_Type)
            {
                case "Email":
                    context.Response.Write(PostEmail(context));
                    break;
                default:
                    context.Response.Write("[{\"Age\":28,\"Name\":\"張鵬飛\"}]");
                    break;
            }
        }

        public static string PostEmail(HttpContext context)
        {
            string semail;
            if (context.Request.HttpMethod == "GET")
            {
                semail = "[" + context.Request.QueryString["jsonData"] + "]";
            }
            else
            {
                semail = "[" + context.Request.Form["jsonData"] + "]";
            }
            return semail;
        }

        /// JSON 序列化
        public static string JsonSerializer<T>(T t)
        {
            DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(T));
            MemoryStream ms = new MemoryStream();
            ser.WriteObject(ms, t);
            string jsonString = Encoding.UTF8.GetString(ms.ToArray());
            ms.Close();
            return jsonString;
        }

        /// JSON 反序列化
        public static T JsonDeserialize<T>(string jsonString)
        {
            DataContractJsonSerializer ser = new DataContractJsonSerializer(typeof(T));
            MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(jsonString));
            return (T)ser.ReadObject(ms);
        }

        public bool IsReusable { get { return false; } }
    }
}

IHttpHandler 比 Web Service 輕量,適合單純的資料端點。若使用 ASP.NET Core,則改用 [ApiController] 與 System.Text.Json,DataContractJsonSerializer 已不建議再用。

八、幾點值得修正的地方

用 JSON.parse 取代 eval。範例中多處使用 eval 解析回應,這在資料可信時勉強能用,但一旦回應被污染就是 XSS 漏洞。JSON.parse 更快也更安全。

回應標頭要帶 UTF-8。只設 ContentType = "application/json" 時,中文可能出現亂碼,建議明確寫成 "application/json; charset=utf-8"。

別用字串拼 JSON。後端把 jsonData 直接包進 [] 只是教學用的簡化,正式環境請用 JsonSerializer 序列化具名物件,避免欄位內容含引號時產生非法 JSON。

range 輸入框取值。<input type="range"> 用 .val() 就能拿到數值,不需要特殊處理;範例作者提到的取值問題其實只是拼字串時的格式混淆。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved