DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> AJAX入門 >> AJAX詳解
AJAX.NET 開發指南:用屬性標記把 C# 方法變成客戶端函式
編輯:AJAX詳解     

AJAX.NET 提供了一個很有意思的抽象:只要在伺服器端方法上掛一個屬性標記,它就自動變成可以在瀏覽器端呼叫的函式。本文整理它的完整使用流程。

運作原理

AJAX 依靠伺服器作為中介來分發與處理請求。由於 XMLHttpRequest 物件被大部分瀏覽器支援,封裝類便以它作為客戶端請求的核心——而封裝的目的正是把 XMLHttpRequest 的實作細節藏起來,所以我們不必去談它怎麼運作。

流程是這樣的:當你在 .NET 方法上加註 AJAX 屬性標記後,AJAX.NET 會自動產生一段對應的客戶端 JavaScript 函式,並透過 XMLHttpRequest 建立伺服器代理,把客戶端函式映射到伺服器的處理函式。

聽起來複雜,看例子就懂了。假設有這麼一個方法:

// C#
public int Add(int firstNumber, int secondNumber)
{
    return firstNumber + secondNumber;
}

AJAX.NET 會立刻自動產生一個名為 Add、帶兩個參數的 JavaScript 函式。客戶端呼叫它時,請求會在背景送到伺服端,再把計算結果回傳。

安裝:把 DLL 放進專案

先下載 AJAX.NET 最新版本,解壓縮後放到專案能參照到的位置,然後在 .NET 專案中加入對它的參照。完成這一步,就可以開始使用 AJAX.dll 進行開發了。

設定 HttpHandler

要讓一切運作,第一步是在 web.config 中註冊封裝包的 HttpHandler。我們不需要深究 HttpHandler 的運作細節,只要知道它能用來處理 ASP.NET 請求即可。例如所有指向 *.aspx 的請求會由 System.Web.UI.PageHandlerFactory 處理;而我們要把所有指向 ajax/*.ashx 的請求,改交給 AJAX.NET 的處理器:

<configuration>
  <system.web>
    <httpHandlers>
      <add verb="POST,GET" path="ajax/*.ashx" type="Ajax.PageHandlerFactory, Ajax" />
    </httpHandlers>
  </system.web>
</configuration>

這段設定告訴 ASP.NET:凡符合 ajax/*.ashx 路徑的請求,都交由 Ajax.PageHandlerFactory 產生的 HttpHandler 處理,而不是預設的 handler。你不需要真的建立 ajax 子目錄——它只是一個虛擬路徑,其他 HttpHandler 仍可用自己的目錄搭配 .ashx 副檔名。

設定頁面

接著開啟要使用的頁面(新舊皆可),在 codebehind 的 Page_Load 事件中加上一行註冊:

// C#
public class Index : System.Web.UI.Page
{
    private void Page_Load(object sender, EventArgs e)
    {
        Ajax.Utility.RegisterTypeForAJax(typeof(Index));
    }
}

這行呼叫會讓頁面輸出兩段 script 標籤:

<script language="Javascript" src="Ajax/common.ashx"></script>
<script language="Javascript"
        src="Ajax/NAMESPACE.PAGECLASS,ASSEMBLYNAME.ashx"></script>

其中 NAMESPACE.PAGECLASS 是當前頁面的命名空間與類別名稱,ASSEMBLYNAME 則是所屬組件名稱。以一個繼承自 AjaxPlay.Sample 的頁面為例,輸出會是 src="Ajax/AjaxPlay.Sample,AjaxPlay.ashx"。

想驗證是否正確,可以把該 src 路徑(檢視原始碼複製出來)直接開在瀏覽器上:如果看到一堆看似無意義的 JavaScript,代表一切正常;如果跳出 ASP.NET 錯誤頁,則表示中間某個環節出了問題。

撰寫伺服器端函式

在 codebehind 的頁面類別中加上方法,並掛上 AJAX 屬性:

// C#
[Ajax.AjaxMethod()]
public int ServerSideAdd(int firstNumber, int secondNumber)
{
    return firstNumber + secondNumber;
}

這個 Ajax.AjaxMethod() 自訂屬性會通知封裝類為該方法產生一個 JavaScript 代理,客戶端才能呼叫它。

客戶端呼叫

最簡單的形式是直接呼叫並取回值:

<script language="Javascript">
var response = Sample.ServerSideAdd(100, 99);
alert(response.value);
</script>

但實務上不會只停在 alert。所有客戶端代理函式都接受一個額外參數——用來處理伺服器回應的回呼函式:

Sample.ServerSideAdd(100, 99, ServerSideAdd_CallBack);

function ServerSideAdd_CallBack(response) {
    if (response.error != null) {
        alert(response.error);
        return;
    }
    alert(response.value);
}

回呼函式收到的 response 物件有四個關鍵屬性:

  • value:伺服器端函式的回傳值,可能是字串、自訂物件或 DataSet。
  • error:若發生錯誤則回傳錯誤資訊(伺服器端拋出例外即可觸發)。
  • request:原始的 XMLHttpRequest 請求,可用來取用額外資訊。
  • context:一個上下文物件。

回傳型別支援範圍

AJAX.NET 原生支援 integer、string、double、boolean、DateTime、DataSet 與 DataTable,也支援簡單的自訂類別與陣列。其他型別則透過其 ToString() 轉為字串回傳。

回傳 DataSet 時,客戶端可以像操作真正的 .NET DataSet 那樣使用它:

function GetDataSet_callback(response) {
    var ds = response.value;
    if (ds != null && typeof(ds) == "object" && ds.Tables != null) {
        var s = new Array();
        s[s.length] = "<table border=1>";
        for (var i = 0; i < ds.Tables[0].Rows.length; i++) {
            s[s.length] = "<tr>";
            s[s.length] = "<td>" + ds.Tables[0].Rows[i].FirstName + "</td>";
            s[s.length] = "<td>" + ds.Tables[0].Rows[i].Birthday  + "</td>";
            s[s.length] = "</tr>";
        }
        s[s.length] = "</table>";
        tableDisplay.innerHtml = s.join("");
    }
}

自訂類別則必須標上 [Serializable()]。註冊時用 Utility.RegisterTypeForAJax(typeof(User)),客戶端即可用 User.GetUser(id, callback) 呼叫,回呼中拿到的 user 物件同樣帶有 FirstName、LastName、UserId 三個屬性。

在非頁面類別中註冊函式

註冊並不限於頁面的 codebehind。封裝類是在指定類別中尋找帶有 Ajax.AjaxMethod() 的方法,所以任何類別都可以:

Public Class AjaxFunctions
    <Ajax.AjaxMethod()> _
    Public Function Validate(username As String, password As String) As Boolean
        ' 執行驗證邏輯
    End Function
End Class

只要在頁面載入時註冊這個類別:Ajax.Utility.RegisterTypeForAjax(typeof(AjaxFunctions)),客戶端呼叫格式就變成 AjaxFunctions.Validate(user, pass, callback)。這種做法比較乾淨,因為業務邏輯不必擠在頁面類別裡。

代理是怎麼產生的

那段由工具自動產生的第二個 script 標籤,其 src 路徑包含命名空間、類別與組件資訊。從這裡不難推測:Ajax.PageHandlerFactory 是用反射取得帶自訂屬性的函式——找出帶有 AjaxMethod 的方法,讀取它們的回傳型別、名稱與參數,據此產生客戶端代理,並建立一個與該型別同名的 JavaScript 物件作為替身。

回傳 Unicode 字元

AJAX.NET 可以從伺服器端向客戶端回傳 Unicode 字元,但伺服器端回傳的值必須經過 HTML 編碼:

[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;
}

SessionState 支援

伺服器端函式有時需要存取 Session。做法是在 Ajax.AjaxMethod 屬性上傳遞參數,指明存取權限:

[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;
}

權限可選 Read、Write 或 ReadWrite。

這個能力解決的是一類很典型的痛點。以文件管理系統為例:使用者編輯文件時會上鎖,其他人得等它釋放才能修改。若不用 AJAX,使用者只能不斷手動重新整理來檢查狀態,體驗極差。有了 Session 支援,就可以在頁面載入後每隔一段時間自己去問一次:

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 = "以下文件已可供編輯!<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);
}

結語

AJAX 技術能為客戶端帶來豐富的互動體驗,而 AJAX.NET 讓這件事在 ASP.NET 專案裡變得相當容易上手:一個屬性標記、一行註冊、一個回呼函式,就完成了一次跨客戶端與伺服端的呼叫。理解它背後其實只是反射加 XMLHttpRequest,你就能在需要的時候繞開封裝、自己動手。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved