在WebForm下 開發ajax程式,需要藉助於一般處理常式(*.ashx)或web服務(*.asmx),並且每一個ajax請求,都要建一個這樣的檔案,如此一來,如果在一個項目中ajax程式多了,勢必會產生一堆的.ashx或.asmx,雖然於程式本身無礙,但那一堆檔案看上去總覺得有傷大雅。那麼可不可以丟掉這些.ashx和.asmx,選擇一種更簡練的方式來做ajax程式呢。
答案是肯定的,那就是:WebMethod 。(此方法是在.net3.5版本下調試的,在.net2.0下有問題)
首先在aspx.cs檔案裡建一個公開的靜態方法,然後加上WebMethod屬性。
[WebMethod] public static string GetUserName() { //...... }
如果要在這個方法裡操作session,那還得將WebMethod的EnableSession 屬性設為true 。即:
[WebMethod(EnableSession = true)]//或[WebMethod(true)] public static string GetUserName() { //...... }
然後我們就寫ajax程式來訪問這個程式,我們就用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,其他的都無效。因為webservice 是一json格式返回資料的,其形式為:{"d":"......."}。
success:請求成功後的回呼函數。你可以在這裡對返回的資料做任意處理。
我們可以看到其中一些參數值是固定的,所以從複用性的角度考慮,我們可以給jquery做一個擴充,對上面的函數做一下簡單的封裝:
我們建一個指令檔叫 jquery.extend.js。在裡面寫一個叫ajaxWebService的方法(因為webmethod其實就是WebService嘛,故此方法對請求*.asmx也是有效),代碼如下:
/// <summary>/// jQuery原型擴充,重新封裝Ajax請求WebServeice/// </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 });}
好了,這樣我們請求webmethod方法 就可以這樣寫了:
$.ajaxWebService("WebForm2.aspx/GetUserName", "{}", function(result) {......});
最後:如果你的項目中ajax程式非常多(這種情況是可能存在的,我做過一個網站,是個sns,全程ajax,幾乎每個操作都用了ajax),
你覺得把WebMethod方法寫在各個aspx頁面裡很零散,那麼你可以專門建一個頁面(如:WebMethods.aspx)來存放。
源碼下載
原文地址:http://www.cnblogs.com/xumingxiang/archive/2010/05/04/1727609.html