每次寫 AJAX,總要重複處理建立 XMLHttpRequest、判斷瀏覽器、設定回呼函式等瑣事。若能把這些步驟封裝成一個通用類別,開發時就能省下不少重複碼。本文介紹名為 AJaxRequest 的通用類(版本 0.3),它把請求的建立、發送與回呼都做了良好封裝。
AJaxRequest 由 HotHeart(xujiwei)所寫,主要目的是簡化 AJAX 開發步驟、減少重複程式碼。它支援 GET、POST、同步與非同步請求,也能直接把表單序列化後送出。
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 為非同步,false 為同步,預設為 true
send([url],[callback],[content],[method],[async]) // 發送請求,省略的參數沿用物件屬性 get([url],[callback]) // 以 GET 請求指定 URL post(form_obj,[callback],[url],[method]) // 把表單送到指定 URL
// 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;
}
);
}
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);
}
}
// 表單序列化
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;
}
}
有了這樣的封裝,日常 AJAX 開發只要專注在「請求什麼」與「收到後怎麼處理」,不必再為跨瀏覽器細節分心。