DIV CSS 佈局教程網

前端如何把參數傳給後端的 WebMethod 並取回結果
編輯:AJAX基礎知識     

在 ASP.NET 中,若想把普通頁面的某個方法開放給 JavaScript 呼叫,做法是把它標成 WebMethod。以下是五個必須同時滿足的條件,缺一就會失敗。

五個必要條件

1. 方法必須是 public static 修飾,回傳型別最好是 string。

2. 方法前面加上 [WebMethod] 特性。

3. 用戶端必須使用 POST 方法,並以 JSON 作為資料格式溝通。否則會傳回整頁 HTML,而不是你要的資料。

4. 在 jQuery 的回呼中,真正的回傳內容在 data.d 裡,不是 data。這一點最容易搞錯。

5. 呼叫的網址格式為 https://abc.com/abc.aspx/GetTime,也就是「頁面名稱/方法名稱」。

後端:abc.aspx

[WebMethod]
public static string GetTime() {
    return DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss");
}

前端:以 jQuery 呼叫

$.ajax({
    url: url,
    method: "post",
    dataType: "json",
    contentType: "application/json; charset=UTF-8",
    success: function (data) {
        $("#id").html(data.d);   // 注意是 data.d
    }
});

為什麼是 data.d

ASP.NET 的 ScriptService 為了降低 XSS 風險,會把回傳值包一層名為 d 的屬性。這是框架層的行為,不是你的方法造成的,因此前端取值時一定要多一層。

若要傳參數

方法改成接受參數,前端把參數放進 data 並指定為 JSON 字串:

[WebMethod]
public static string Hello(string name) {
    return "你好," + name;
}
$.ajax({
    url: "abc.aspx/Hello",
    type: "post",
    contentType: "application/json; charset=utf-8",
    dataType: "json",
    data: JSON.stringify({ name: "小明" }),
    success: function (data) { console.log(data.d); }
});

參數名稱必須與方法簽章完全一致(包含大小寫),否則會收到「找不到方法」的錯誤——這類錯誤訊息有時會誤導人以為是路由問題,實際上只是參數名打錯。

補充一個現實考量:WebMethod 這套機制已屬較早期的做法。新專案若使用 ASP.NET MVC 或 Web API,直接提供 Controller 與 [HttpPost] 動作會更清楚,回傳的 JSON 也不會多包一層 d。不過若正在維護舊的 Web Forms 系統,上述五點仍是必備知識。

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