DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> AJAX入門 >> AJAX詳解
ajax.dll 與 ajaxpro.dll 的入門用法
編輯:AJAX詳解     

以下內容會參考網上前人的文章,特此聲明。整體可分為「應用篇」的幾個步驟,帶你快速跑通 Ajax.dll 與 AjaxPro.dll 這兩套老牌 Ajax 元件。

一、加入引用

先把 Ajax.dll 加入專案引用。做法和加入其他 DLL 一樣:在專案上按右鍵,選「加入引用」,一步步把 .dll 檔放進來,之後在參考節點看到 Ajax.dll 就代表成功了。

二、修改 Web.config

在 <system.web> 元素中註冊 httpHandler。要特別留意,Ajax.dll 與 AjaxPro.dll 的寫法不同:

<configuration>
  <system.web>
    <httpHandlers>
      <!-- Ajax.dll 的寫法 -->
      <add verb="POST,GET" path="ajax/*.ashx" type="Ajax.PageHandlerFactory, Ajax" />
      <!-- AjaxPro.dll 的寫法 -->
      <add verb="*" path="ajaxpro/*.ashx" type="AjaxPro.AjaxHandlerFactory, AjaxPro" />
    </httpHandlers>
  </system.web>
</configuration>

三、在 Page_Load 註冊

protected void Page_Load(object sender, EventArgs e)
{
    Ajax.Utility.RegisterTypeForAjax(typeof(_Default));    // Ajax.dll
    AjaxPro.Utility.RegisterTypeForAjax(typeof(_Default)); // AjaxPro.dll
}
// _Default 為頁面類的類名(即頁面名稱)。若放在命名空間下,需寫完整命名空間,如 namespaces._Default

四、建立伺服器端方法

[Ajax.AjaxMethod] // AjaxPro.dll 則寫成 [AjaxPro.AjaxMethod]
public string getValue(int a, int b)
{
    // 從前端傳入兩個數,伺服器端相加後回傳
    return Convert.ToString(a + b);
}

五、前端呼叫

<script language="Javascript">
function getValue()
{
    // AjaxPro.dll 需加命名空間 Web._Default.getValue;Ajax.dll 則直接 _Default.getValue
    _Default.getValue(1, 2, getGroups_callback);
}
function getGroups_callback(response)
{
    var dt = response.value;
    document.getElementById("Div_1").innerHTML = dt;
}
</script>
<div id="Div_1"></div>
<button onclick="getValue()">開始</button>

點擊「開始」鈕後到底發生了什麼?前端先執行 getValue(),其中的 _Default.getValue(1,2,getGroups_callback) 會觸發後台 CS 函式——這正是 Ajax 的精髓所在:無需刷新頁面即可執行後台函式。1 和 2 是傳入參數,getGroups_callback 則是接收伺服器回傳結果的回呼函式。後台算完透過 return 回傳,這個值可以是字串、自訂物件,甚至是一段 HTML 碼,前端再用回呼函式接住即可。整個流程就是:前端無刷新 → 後台計算 → 回傳前端,任你玩弄。

回呼函式與錯誤處理

回呼函式其實還能接收更多資訊,例如:

Sample.ServerSideAdd(100, 99, ServerSideAdd_CallBack);

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

回呼函式接收的 response 物件主要公開了幾個屬性:

  • Value:伺服器端函式實際回傳的值(字串、自訂物件或資料集)。
  • Error:若有錯誤,則為錯誤訊息。
  • Request:XMLHttpRequest 的原始回應。
  • Context:上下文物件。

先檢查 error 是否為 null,就能判斷呼叫有沒有出錯;只要在伺服器端函式中丟出例外,就能輕鬆處理錯誤。

回傳複雜型別

Ajax 包裝器不只會處理整數,還支援 string、double、boolean、DateTime、DataSet、DataTable,以及自訂類別與陣列等基本型別;其餘型別一律回傳 ToString() 值。假設伺服器端回傳 DataSet,前端可這樣呈現:

function getDataSet(){
    AjaxFunctions.GetDataSet(GetDataSet_callback);
}
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><td>" + ds.Tables[0].Rows[i].FirstName
                        + "</td><td>" + ds.Tables[0].Rows[i].Birthday + "</td></tr>";
        }
        s[s.length] = "</table>";
        tableDisplay.innerHTML = s.join("");
    } else {
        alert("Error. [3001] " + response.request.responseText);
    }
}

要回傳自訂類別,唯一的要求是加上 [Serializable] 屬性:

[Serializable()]
public class User {
    private int _userId;
    private string _firstName;
    private string _lastName;

    public int userId { get { return _userId; } }
    public string FirstName { get { return _firstName; } }
    public string LastName { get { return _lastName; } }

    public User(int _userId, string _firstName, string _lastName){
        this._userId = _userId; this._firstName = _firstName; this._lastName = _lastName;
    }
    public User(){}

    [AjaxMethod()]
    public static User GetUser(int userId){
        return new User(userId, "Michael", "Schwarz");
    }
}

透過 RegisterTypeForAjax 註冊代理後即可在客戶端異步呼叫:

private void Page_Load(object sender, EventArgs e){
    Utility.RegisterTypeForAjax(typeof(User));
}
function getUser(userId){
    User.GetUser(GetUser_callback);
}
function GetUser_callback(response){
    if (response != null && response.value != null){
        var user = response.value;
        if (typeof(user) == "object"){
            alert(user.FirstName + " " + user.LastName);
        }
    }
}
getUser(1);

回傳的值實際上是一個物件,公開了與伺服器端相同的屬性(FirstName、LastName、UserId)。

自訂轉換器與其他技巧

除了大量內建型別,包裝器對無法正確處理的型別只會呼叫 ToString()。為避免這種情況,Ajax.NET 包裝器允許開發者建立自訂物件轉換器,讓複雜物件能在伺服器與用戶端之間平滑傳遞。

伺服器端函式也不一定得放在頁面後置程式碼裡,完全可以獨立成類別檔。包裝器的工作原理是在指定類別中找出所有帶 Ajax.AjaxMethod 的方法,透過 Ajax.Utility.RegisterTypeForAjax 指定任意類別即可:

Public Class AjaxFunctions
    <Ajax.AjaxMethod()> _
    Public Function Validate(username As String, passWord As String) As Boolean
        ' do something
        ' return something
    End Function
End Class
private void Page_Load(object sender, EventArgs e){
    Ajax.Utility.RegisterTypeForAjax(typeof(AjaxFunctions));
}

此時客戶端代理的名稱是 <ClassName>.<ServerSideFunctionName>,例如 AjaxFunctions.ServerSideAdd(1,2)。

若要回傳 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;
}
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved