DIV CSS 佈局教程網

AJAXRequest v0.3:支援表單序列化的通用 AJAX 類別
編輯:AJAX基礎知識     

Name: AJAXRequest
Author: HotHeart (xujiwei)
Site: https://www.xujiwei.cn/
Blog: https://www.xujiwei.cn/blog/
Copyright (c) 2006, All Rights Reserved

版本 0.3 把「送表單」這件事也包了進來。除了 send、get、post 三個主要方法,還附上一個能把整個表單元素序列化成查詢字串的 formToStr,開發時不必再手動拼參數。

類別規格

建立方式:

var ajaxobj = new AJAXRequest([url], [callback], [content], [method], [async]);

所有參數皆為選用,建立失敗時回傳 false。

屬性

  • url:請求 URL,字串,預設空。
  • callback:回呼函式,收到回應時呼叫,預設直接回傳。函式有一個參數即 XMLHttpRequest 物件,寫成 function mycallback(xmlobj)。
  • content:請求內容,POST 時需設定,預設空字串。
  • method:請求方法,POST 或 GET,預設 POST。
  • async:是否非同步,預設 true。

方法

  • send([url], [callback], [content], [method], [async]):送出請求,參數省略時沿用物件屬性。
  • get([url], [callback]):以 GET 請求指定 URL。
  • post(form_obj, [callback], [url], [method]):把表單送到指定網址,form_obj 為表單物件;未指定 url 時會優先採用表單自身的 action。

使用範例

GET 方法

function test1() {
    var ajax = new AJAXRequest;
    ajax.get(
        "test.asp",
        function (obj) {
            document.getElementById("test1").value = obj.responseText;
        }
    );
}

POST 方法

function test2() {
    var ajax = new AJAXRequest;
    ajax.post(
        document.getElementById("test2c"),
        function (obj) {
            document.getElementById("test2r").innerHTML = obj.responseText;
        }
    );
}

完整程式碼

/*------------------------------------------
Author: xujiwei
Website: https://www.xujiwei.cn
E-mail: vipxjw@163.com
Copyright (c) 2006, All Rights Reserved
------------------------------------------*/
function AJAXRequest() {
    var xmlObj = false;
    var CBfunc, ObjSelf;
    ObjSelf = this;

    try { xmlObj = new XMLHttpRequest; }
    catch (e) {
        try { xmlObj = new ActiveXObject("MSXML2.XMLHTTP"); }
        catch (e2) {
            try { xmlObj = new ActiveXObject("Microsoft.XMLHTTP"); }
            catch (e3) { xmlObj = false; }
        }
    }

    if (!xmlObj) return false;

    if (arguments[0]) this.url = arguments[0]; else this.url = "";
    if (arguments[1]) this.callback = arguments[1]; else this.callback = function (obj) { return };
    if (arguments[2]) this.content = arguments[2]; else this.content = "";
    if (arguments[3]) this.method = arguments[3]; else this.method = "POST";
    if (arguments[4]) this.async = arguments[4]; else this.async = true;

    this.send = function () {
        var purl, pcbf, pc, pm, pa;
        if (arguments[0]) purl = arguments[0]; else purl = this.url;
        if (arguments[1]) pc = arguments[1]; else pc = this.content;
        if (arguments[2]) pcbf = arguments[2]; else pcbf = this.callback;
        if (arguments[3]) pm = arguments[3]; else pm = this.method;
        if (arguments[4]) pa = arguments[4]; else pa = this.async;
        if (!pm || !purl || !pa) return false;

        xmlObj.open(pm, purl, pa);
        if (pm == "POST")
            xmlObj.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");

        xmlObj.onreadystatechange = function () {
            if (xmlObj.readyState == 4) {
                if (xmlObj.status == 200) {
                    pcbf(xmlObj);
                } else {
                    pcbf(null);
                }
            }
        }

        if (pm == "POST") xmlObj.send(pc);
        else xmlObj.send("");
    }

    this.get = function () {
        var purl, pcbf;
        if (arguments[0]) purl = arguments[0]; else purl = this.url;
        if (arguments[1]) pcbf = arguments[1]; else pcbf = this.callback;
        if (!purl && !pcbf) return false;
        this.send(purl, "", pcbf, "GET", true);
    }

    this.post = function () {
        var fo, pcbf, purl, pc, pm;
        if (arguments[0]) fo = arguments[0]; else return false;
        if (arguments[1]) pcbf = arguments[1]; else pcbf = this.callback;
        if (arguments[2]) purl = arguments[2];
        else if (fo.action) purl = fo.action;
        else purl = this.url;
        if (arguments[3]) pm = arguments[3];
        else if (fo.method) pm = fo.method.toLowerCase();
        else pm = "post";
        if (!pcbf && !purl) return false;

        pc = this.formToStr(fo);
        if (!pc) return false;

        if (pm) {
            if (pm == "post") this.send(purl, pc, pcbf, "POST", true);
            else if (purl.indexOf("?") > 0) this.send(purl + "&" + pc, "", pcbf, "GET", true);
            else this.send(purl + "?" + pc, "", pcbf, "GET", true);
        } else {
            this.send(purl, pc, pcbf, "POST", true);
        }
    }

    // formToStr
    // from SurfChen <surfchen@gmail.com>
    // @url     https://www.surfchen.org/
    // @license https://www.gnu.org/licenses/gpl.html GPL
    // modified by xujiwei
    // @url     https://www.xujiwei.cn/
    this.formToStr = function (fc) {
        var i, query_string = "", and = "";
        for (i = 0; i < fc.length; i++) {
            e = fc[i];
            if (e.name != '') {
                if (e.type == 'select-one') {
                    element_value = e.options[e.selectedIndex].value;
                }
                else if (e.type == 'checkbox' || e.type == 'radio') {
                    if (e.checked == false) continue;
                    element_value = e.value;
                }
                else {
                    element_value = e.value;
                }
                element_value = encodeURIComponent(element_value);
                query_string += and + e.name + '=' + element_value;
                and = "&";
            }
        }
        return query_string;
    }
}

這一版的三個亮點

一、非同步與同步的差異處理得當。非同步時把 null 交給回呼,讓呼叫端能分辨「請求失敗」與「回應內容為空」,這比舊版靜默失敗好得多。

二、post 會尊重表單自身的設定。未指定網址時採用 form.action,未指定方法時採用 form.method,符合既有 HTML 的直覺。

三、formToStr 的型別處理完整。select-one 取選中項、checkbox 與 radio 跳過未勾選者、其餘直接取值,最後統一以 encodeURIComponent 編碼。

要再強化的話,formToStr 目前對同名的多選 checkbox 會產生重複鍵名,伺服器端需自行處理成陣列;另外 e 與 element_value 未用 var 宣告,會變成全域變數,在迴圈或併發情境下容易出問題。

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