DIV CSS 佈局教程網

告別 ashx 與 asmx:用 jQuery 呼叫 WebMethod 處理 Ajax
編輯:AJAX基礎知識     

在 WebForm 底下開發 Ajax,過去得仰賴一般處理常式(*.ashx)或 Web 服務(*.asmx),而且每支 Ajax 請求都要配一個檔案。專案裡 Ajax 一多,檔案就堆成一團——雖然不影響程式執行,看起來總是不太體面。

能不能丟掉這些檔案,用更精簡的方式寫 Ajax?可以,答案是 WebMethod(此方法在 .NET 3.5 下測試無誤,.NET 2.0 有問題)。

一、在 aspx.cs 中定義方法

寫一個公開的靜態方法,掛上 WebMethod 屬性即可:

 [WebMethod]
 public static string GetUserName() {
     // ……
 }

若要在方法內使用 Session,還得把 EnableSession 打開:

 [WebMethod(EnableSession = true)]   // 亦可寫成 [WebMethod(true)]
 public static string GetUserName() {
     // ……
 }

二、用 jQuery 呼叫

 $.ajax({
     type: "POST",
     contentType: "application/json",
     url: "WebForm2.aspx/GetUserName",
     data: "{}",
     dataType: "json",
     success: function () { /* …… */ }
 });

幾個參數說明如下:

  • type:必須是 POST,WebMethod 只接受 POST 請求。
  • contentType:務必使用 application/json。
  • url:格式為「檔名(含副檔名)/方法名」。
  • data:參數必須是 JSON 格式的字串,例如 "{aa:11,bb:22,cc:33}"。若寫成物件,jQuery 會幫你序列化,伺服器端收到的就不是 JSON 了。即使沒有參數也要寫成 "{}"——很多人卡關就是卡在這裡。
  • dataType:必須是 json。WebMethod 以 {"d":"……"} 的形式回應,因此回呼中要取 result.d。
  • success:成功後的回呼函數,可在其中任意處理資料。

三、封裝成可複用的方法

既然有幾個參數值是固定不變的,從複用角度來看,不妨給 jQuery 做個擴充。建立一支腳本 jquery.extend.js:

 /// <summary>
 /// jQuery 原型擴充,重新封裝 Ajax 請求 WebService
 /// </summary>
 /// <param name="url" type="String">處理請求的位址</param>
 /// <param name="dataMap" type="String">參數,JSON 格式的字串</param>
 /// <param name="fnSuccess" type="Function">請求成功後的回呼函數</param>
 $.ajaxWebService = function (url, dataMap, fnSuccess) {
     $.ajax({
         type: "POST",
         contentType: "application/json",
         url: url,
         data: dataMap,
         dataType: "json",
         success: fnSuccess
     });
 };

之後呼叫就簡潔多了:

 $.ajaxWebService("WebForm2.aspx/GetUserName", "{}", function (result) {
     // …… 注意取 result.d
 });

四、方法寫在哪裡

如果專案中的 Ajax 數量可觀(做過全站 Ajax 的 SNS 網站就很接近這種情況),把 WebMethod 散落在各個 aspx 裡會顯得零碎。此時可以專門開一個頁面(例如 WebMethods.aspx)集中存放,讓所有前端請求都指向同一處。這個方法對 *.asmx 也同樣有效——WebMethod 本來就是 WebService 的概念。

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