什麼是 Ajax?
Ajax(Asynchronous JavaScript and XML,異步 JavaScript 與 XML)是一個新出現的名詞,用來描述 JavaScript 的兩項強大能力。這兩項能力多年來一直被 Web 開發者忽略,直到 Gmail、Google Suggest 與 Google Maps 相繼問世,人們才真正意識到它們的重要性。
這兩項被忽略的能力是:
要用 JavaScript 向伺服器發送 HTTP 請求,需要一個具備這種能力的類別實例。這樣的類別最早由 Internet Explorer 以 ActiveX 物件形式引入,稱為 XMLHTTP;後來 Mozilla、Safari 等瀏覽器紛紛跟進,提供了 XMLHttpRequest 類別,支援微軟 ActiveX 物件所提供的屬性與方法。
因此,為了建立跨瀏覽器的物件實例,可以這樣寫:
if (window.XMLHttpRequest) { // Mozilla, Safari, ...
http_request = new XMLHttpRequest();
} else if (window.ActiveXObject) { // IE
http_request = new ActiveXObject("Microsoft.XMLHTTP");
}
(上例為求簡潔做了一定簡化,只用來說明如何建立 XMLHTTP 類別實例。完整的程式碼可參考步驟 3。)
如果伺服器的回應沒有帶 XML mime-type 標頭,某些 Mozilla 瀏覽器可能無法正常運作。為了解決這個問題,可以在回應標頭不是 text/xml 時,呼叫另一個方法強制修改:
http_request = new XMLHttpRequest();
http_request.overrideMimeType('text/xml');
接著要決定:收到伺服器回應後要做什麼。這需要告訴 HTTP 請求物件用哪一個 JavaScript 函數來處理回應。把物件的 onreadystatechange 屬性設為要使用的函數名稱即可:
http_request.onreadystatechange = nameOfTheFunction;
注意:函數名稱後面沒有括號,也不需要傳參數。另一種寫法是在設定時直接定義匿名函數及其行為:
http_request.onreadystatechange = function(){
// do the thing
};
定義好回應處理方式後,就可以發送請求了。呼叫 HTTP 請求類別的 open() 與 send() 方法:
http_request.open('GET', 'https://www.example.org/some.file', true);
http_request.send(null);
open() 的第一個參數是 HTTP 請求方法——GET、POST、HEAD,或任何伺服器支援且你想使用的方法。依 HTTP 規範,該參數必須大寫,否則某些瀏覽器(如 Firefox)可能無法正確處理。第二個參數是請求頁面的 URL;由於安全限制,該頁面不能是第三方網域。同時務必確保所有頁面都使用一致的網域名稱,否則呼叫 open() 會得到 "permission denied" 錯誤。一個常見的錯誤是:造訪站點時用 domain.tld,發請求時卻寫成 www.domain.tld。第三個參數決定請求是否為異步模式;設為 true 時,JavaScript 函數會繼續執行而不等待伺服器回應——這就是 Ajax 裡那個「A」。
如果第一個參數是 "POST",send() 的參數可以是任何你想送給伺服器的資料,並以字串形式傳送,例如:
name=value&anothername=othervalue&so=on
發送請求時,我們提供了用來處理回應的 JavaScript 函數名稱:
http_request.onreadystatechange = nameOfTheFunction;
來看看這個函數該做什麼。首先它會檢查請求狀態;如果狀態值為 4,代表完整的伺服器回應已經收到,可以開始處理:
if (http_request.readyState == 4) {
// everything is good, the response is received
} else {
// still not ready
}
readyState 的取值如下:
接著,函數會檢查 HTTP 回應的狀態值。我們著重看值為 200 OK 的回應:
if (http_request.status == 200) {
// perfect!
} else {
// there was a problem with the request,
// for example the response may be a 404 (Not Found)
// or 500 (Internal Server Error) response codes
}
檢查完請求狀態值與 HTTP 回應狀態值之後,就可以處理從伺服器取得的資料了。取得方式有兩種:
http_request.responseText——以文字字串方式回傳伺服器的回應。http_request.responseXML——以 XMLDocument 物件方式回傳回應,可用 JavaScript 的 DOM 函數來處理。現在把整個流程完整走一遍,發送一個簡單的 HTTP 請求。我們用 JavaScript 請求一個 HTML 檔 test.html(內容為 "I'm a test."),然後用 alert() 把它的內容顯示出來。
<script type="text/javascript" language="javascript">
var http_request = false;
function makeRequest(url) {
http_request = false;
if (window.XMLHttpRequest) { // Mozilla, Safari,...
http_request = new XMLHttpRequest();
if (http_request.overrideMimeType) {
http_request.overrideMimeType('text/xml');
}
} else if (window.ActiveXObject) { // IE
try {
http_request = new ActiveXObject("Msxml2.XMLHTTP");
} catch (e) {
try {
http_request = new ActiveXObject("Microsoft.XMLHTTP");
} catch (e) {}
}
}
if (!http_request) {
alert('Giving up :( Cannot create an XMLHTTP instance');
return false;
}
http_request.onreadystatechange = alertContents;
http_request.open('GET', url, true);
http_request.send(null);
}
function alertContents() {
if (http_request.readyState == 4) {
if (http_request.status == 200) {
alert(http_request.responseText);
} else {
alert('There was a problem with the request.');
}
}
}
</script>
<span
style="cursor: pointer; text-decoration: underline"
>
Make a request
</span>
本例的流程是:
前面的例子中,當伺服器回應被收到後,我們呼叫請求物件的 responseText 屬性,它包含了 test.html 的內容。這次來試試 responseXML。
首先建立一個有效的 XML 檔 test.xml:
<?xml version="1.0" ?> <root> I'm a test. </root>
腳本中只需修改請求部分,接著在 alertContents() 裡,把 alert(http_request.responseText); 換成:
var xmldoc = http_request.responseXML;
var root_node = xmldoc.getElementsByTagName('root').item(0);
alert(root_node.firstChild.data);
這裡我們使用了 responseXML 提供的 XMLDocument 物件,並用 DOM 方法取出存在 XML 檔中的內容。
Ajax 是「Asynchronous JavaScript + XML」的簡稱,也就是異步的 JavaScript 與 XML 處理。從原理上來看,Ajax 主要是透過呼叫 HttpRequest 實現與伺服器的異步通訊,最終在網頁上呈現豐富友善的使用者介面。
設定步驟
1. 把 Ajax.dll 複製到應用系統的 bin 目錄,然後在專案引用中加入 Ajax.dll。
2. 設定 web.config,加入以下資訊:
<httpHandlers> <add verb="POST,GET" path="ajax/*.ashx" type="Ajax.PageHandlerFactory, Ajax" /> </httpHandlers>
3. 假設應用系統名為 Document,目錄結構為 Pages\AjaxTest。
4. 在 Pages\AjaxTest 下建立 AjaxMethod.cs,加入方法:
//[Ajax.AjaxMethod]
[Ajax.AjaxMethod(Ajax.HttpSessionStateRequirement.Read)]
public static string GetNIVNumber(string str)
{
return str;
}
5. 在 Pages\AjaxTest 下建立頁面 AjaxForm.aspx:
<html>
<head>
<title>AjaxForm</title>
<script language="javascript">
function testAjax()
{
var first = document.getElementById("txtfirst");
AjaxMethod.GetNIVNumber(first.value, callback_GetNIVNumber);
}
function callback_GetNIVNumber(res)
{
var obj = document.getElementById("txtsecond");
obj.value = res.value;
}
</script>
</head>
<body>
<form id="Form1" method="post" runat="server">
<input type="button" value="Button" onclick="testAjax()" />
<asp:TextBox id="txtfirst" runat="server"></asp:TextBox>
<asp:TextBox id="txtsecond" runat="server"></asp:TextBox>
</form>
</body>
</html>
protected System.Web.UI.WebControls.TextBox txtfirst;
protected System.Web.UI.WebControls.TextBox txtsecond;
private void Page_Load(object sender, System.EventArgs e)
{
// 註冊,其中 Document.Pages.AjaxTest.AjaxMethod 為 AjaxMethod.cs 所在的命名空間
Ajax.Utility.RegisterTypeForAjax(typeof(Document.Pages.AjaxTest.AjaxMethod));
}
執行後即可看到效果:在第一個文字框輸入內容,點擊按鈕,內容就會顯示到第二個文字框。這只是一個簡單示範,你還可以改寫呼叫方法,做成從資料庫讀取資料或更複雜的操作。