
本單元接續 AJAX.NET 開發指南,示範如何為伺服器端方法宣告 Ajax 屬性,以及如何讓这些方法存取 Session 資訊。
AJAX.NET 最迷人的一點,是只要為方法加上 Ajax.AjaxMethod 屬性,前端就能像呼叫本地函式一樣呼叫它:
[Ajax.AjaxMethod]
public string Test1(string name, string email, string comment){
string html = "";
html += "Hello " + name + "<br>";
html += "Thank you for your comment <b>";
html += System.Web.HttpUtility.HtmlEncode(comment);
html += "</b>.";
return html;
}
注意這裡刻意用 HttpUtility.HtmlEncode() 處理使用者輸入的 comment:即使回傳的是 HTML 片段,也應先轉義,否則等於把 XSS 的門打開。
伺服器端方法常常需要讀取工作階段狀態。要做到這件事,必須在方法的 AjaxMethod 屬性上宣告所需的 Session 權限。
舉個實用場景:某套文件管理系統在有人編輯文件時會將其鎖定,其他人必須等到文件釋放才能修改。若不用 Ajax,使用者只能不停手動重新整理頁面來檢查狀態——體驗很差。有了 Ajax 搭配 Session 支援,這件事就簡單多了。
先寫一個方法,找出使用者等待中的文件,並回傳其中已經可用的部分:
// VB.NET
<Ajax.AjaxMethod(HttpSessionStateRequirement.Read)> _
Public Function DocumentReleased() As ArrayList
If HttpContext.Current.Session("DocumentsWaiting") Is Nothing Then
Return Nothing
End If
Dim readyDocuments As New ArrayList
Dim documents() As Integer =
CType(HttpContext.Current.Session("DocumentsWaiting"), Integer())
For i As Integer = 0 To documents.Length - 1
Dim document As Document = Document.GetDocumentById(documents(i))
If Not document Is Nothing AndAlso document.Status = DocumentStatus.Ready Then
readyDocuments.Add(document)
End If
Next
Return readyDocuments
End Function
// C#
[Ajax.AjaxMethod(HttpSessionStateRequirement.Read)]
public ArrayList DocumentReleased(){
if (HttpContext.Current.Session["DocumentsWaiting"] == null){
return null;
}
ArrayList readyDocuments = new ArrayList();
int[] documents = (int[])HttpContext.Current.Session["DocumentsWaiting"];
for (int i = 0; i < documents.Length; ++i){
Document document = Document.GetDocumentById(documents[i]);
if (document != null && document.Status == DocumentStatus.Ready){
readyDocuments.Add(document);
}
}
return readyDocuments;
}
屬性參數指定的是 HttpSessionStateRequirement.Read,可選值還包含 Write 與 ReadWrite。這個宣告不是裝飾:ASP.NET 預設停用工作階段狀態以提高效能,必須明確要求,執行期才會為該方法啟用對應的 Session 存取權限。只讀情境就宣告 Read,是兼顧正確性與效能的做法。
<script language="javascript">
function DocumentsReady_CallBack(response){
if (response.error != null){
alert(response.error);
return;
}
if (response.value != null && response.value.length > 0){
var div = document.getElementById("status");
div.innerHTML = "The following documents are ready!<br />";
for (var i = 0; i < response.value.length; ++i){
div.innerHTML += '<a href="edit.aspx?documentId='
+ response.value[i].DocumentId + '">'
+ response.value[i].Name + '</a><br />';
}
}
setTimeout('page.DocumentReleased(DocumentsReady_CallBack)', 10000);
}
</script>
頁面載入後每十秒向伺服器請求一次;有回應就檢查 response 並更新畫面,然後再排下一次輪詢,形成一個自我延續的循環。
兩點值得注意。第一,callback 中的 response 物件有 error 與 value 兩個屬性,AJAX.NET 會把例外包裝進 error,因此別忘了先檢查錯誤再取資料。第二,上例把回應直接拼進 innerHTML,若文件名稱可能含 HTML 特殊字元,仍應轉義后再輸出。
Ajax 能為用戶端帶來豐富的操作體驗,而 AJAX.NET 讓這種能力的實作門檻大幅降低——一個屬性就能把伺服器方法暴露給前端,再搭配 Session 宣告,就能勝任文件鎖定狀態這類需要工作階段資訊的即時查詢場景。