在 AJAX 這個名詞流行之前,ASP.NET 2.0 其實已經內建了一套自己的非同步回傳機制:ICallbackEventHandler 介面。它的思路與手寫 XMLHttpRequest 類似——由瀏覽器發出非同步呼叫,伺服器處理後把結果交給前端函式——但整個流程由框架代為安排,程式碼量小得多。以下用微軟官方文件上的範例走一遍。
<%@ Page Language="C#" AutoEventWireup="true" CodeFile="ClientCallback.aspx.cs" Inherits="ClientCallback" %>
<html xmlns="https://www.w3.org/1999/xhtml">
<head runat="server">
<title>Callback Test</title>
<script type="text/javascript">
function ReceiveServerData(receivedStr, context) {
alert(receivedStr);
}
</script>
</head>
<body>
<form id="form1" runat="server">
<input type="button" value="Callback" onclick="CallServer('argument', 'context')" />
</form>
</body>
</html>
前端只有兩件事:ReceiveServerData 負責接收伺服器回傳的資料,CallServer('argument', 'context') 負責把參數送出去。注意 CallServer 並不是我們手寫的函式,它由後端動態註冊進來。
public partial class ClientCallback : System.Web.UI.Page, ICallbackEventHandler
{
private string returnStr;
// 由前端呼叫、在伺服器執行
public void RaiseCallbackEvent(string eventArgument)
{
returnStr = eventArgument.ToUpper();
}
// 產生要送回前端的結果
public string GetCallbackResult()
{
return returnStr;
}
}
兩個方法的分工很清楚:RaiseCallbackEvent 接收前端傳來的參數並在伺服器處理,GetCallbackResult 則回傳結果字串。範例中的處理邏輯只是把字串轉大寫,實務上你可以在此查資料庫、呼叫服務或做任何運算。
void Page_Load(object sender, EventArgs e)
{
ClientScriptManager cm = Page.ClientScript;
string cbReference = cm.GetCallbackEventReference(this, "arg", "ReceiveServerData", "");
string callbackScript = "function CallServer(arg, context) {" + cbReference + "; }";
cm.RegisterClientScriptBlock(this.GetType(), "CallServer", callbackScript, true);
}
關鍵在 Page_Load。GetCallbackEventReference 產生一段真正的回呼參考,指定「要呼叫本頁的哪個方法」、「傳入參數名叫 arg」、「結果交給 ReceiveServerData」;接著把它包成前端要用的 CallServer 函式,用 RegisterClientScriptBlock 註冊出去。最後那個 true 表示要自動包上 script 標籤。
好處很明顯:不必自己處理 XMLHttpRequest 的跨瀏覽器差異,也不必自己組 query string,型別與流程都在 C# 這側掌控。
要留意的地方同樣存在。第一,回傳的是單一字串,結構化資料得自己序列化(常見做法是回傳 JSON 再由前端解析)。第二,回呼不會走完整的頁面生命週期,也不會更新控制項的狀態,畫面必須由你自己用 JavaScript 改寫。第三,前端傳入的參數等於外部輸入,伺服器端一定要驗證與編碼,別把 RaiseCallbackEvent 當成可以信任的入口。
總體來說,若你的專案是純 ASP.NET Web Forms、需求是「按一下、向伺服器問一件事、把答案填回畫面」,ICallbackEventHandler 是成本最低的一條路;等到需要複雜的 JSON 契約或大量前端邏輯時,再考慮全面改用 AJAX 框架會更合適。