在 codebehind 中註冊型別:
// C#
public class Index : System.Web.UI.Page {
private void Page_Load(object sender, EventArgs e) {
Ajax.Utility.RegisterTypeForAJax(typeof(Index));
// ...
}
// ...
}
這行呼叫會讓頁面產生如下的 JavaScript(你也可以手動加入):
<script language="javascript" src="Ajax/common.ashx"></script>
<script language="javascript"
src="Ajax/NAMESPACE.PAGECLASS,ASSEMBLYNAME.ashx"></script>
粗體部分的意義是:
以 AjaxPlay 專案中的 sample.aspx 為例,輸出如下:
<%@ Page Inherits="AjaxPlay.Sample" Codebehind="sample.aspx.cs" ... %>
<html>
<head>
<script language="javascript" src="Ajax/common.ashx"></script>
<script language="javascript"
src="Ajax/AjaxPlay.Sample,AjaxPlay.ashx"></script>
</head>
<body>
<form id="Form1" method="post" runat="server">
...
</form>
</body>
</html>
你可以自行驗證:把 src 的路徑(從原始碼複製)貼到瀏覽器開啟,一切正常時會看到一段無意義的文字;若出現 ASP.NET 錯誤頁,代表中間出了問題。
即使不熟悉 HttpHandler 的運作,也能理解這裡的邏輯:透過 web.config,我們確保所有指向 Ajax/*.ashx 的請求都由自訂的處理常式接手,因此上面那兩個 script 標籤才會被正確處理。
接著寫一個可以被客戶端非同步呼叫的伺服器端函數。以最經典的加法為例,在 codebehind 的頁面類中加上:
' VB.Net
<Ajax.AjaxMethod()> _
Public Function ServerSideAdd(ByVal firstNumber As Integer, _
ByVal secondNumber As Integer) As Integer
Return firstNumber + secondNumber
End Function
// C#
[Ajax.AjaxMethod()]
public int ServerSideAdd(int firstNumber, int secondNumber)
{
return firstNumber + secondNumber;
}
關鍵是 Ajax.AjaxMethod() 這個自訂屬性:屬性服務會告知 Ajax 封裝類為此方法建立一個 JavaScript 代理,用戶端才有辦法呼叫它。沒有這個標記的方法,即使在同一個類裡,也不會出現在客戶端。
Ajax 封裝類會建立一個有兩個參數、名為「類名.ServerSideAdd」的 JavaScript 函數。最基本的用法就是呼叫它並傳入參數:
<%@ Page Inherits="AjaxPlay.Sample" Codebehind="sample.aspx.cs" ... %>
<html>
<head>
<script language="javascript" src="Ajax/common.ashx"></script>
<script language="javascript"
src="ajax/AjaxPlay.Sample,AjaxPlay.ashx"></script>
</head>
<body>
<form id="Form1" method="post" runat="server">
<script language="javascript">
var response = Sample.ServerSideAdd(100, 99);
alert(response.value);
</script>
</form>
</body>
</html>
上面這個寫法看起來像同步呼叫,實際上它仍然是一次非同步往返——只是回呼沒有被指定,因此你無法在同一個執行流程裡期待 response 立即可用。要把這種強大的能力用在真正有意義的地方(而不只是跳個 alert),所有客戶端代理(如 Sample.ServerSideAdd)都同時接受一個額外的參數,用來指定處理伺服器回應的回呼函數。
實務上建議一律採用帶回呼的形式:非同步呼叫不會阻塞 UI 執行緒,這正是 Ajax 的價值所在;相對地,若你在回呼之外的地方讀取 response,多半會拿到 undefined。