DIV CSS 佈局教程網

jQuery 呼叫 WebService 方法全攻略:字串、物件與泛型集合
編輯:JQuery特效代碼     

用 jQuery 呼叫 WebService,有兩個地方比 ashx 來得方便。第一,請求的 URL 寫成「服務位址/方法名稱」,就能直接決定要呼叫哪個方法,不必在 WebService 程式碼裡自行判斷。第二,方法可以直接回傳物件、泛型集合等型別,AJAX 回應後會自動轉成 JSON;若走 ashx,得先手動序列化。

使用上有幾條硬性規則:只能送 POST;要回 JSON 必須把 contentType 設為 application/json;回傳的資料是以字母 d 為鍵值的物件。

一、回傳字串

[WebMethod]
public string HelloWorld()
{
    return "Hello World";
}

$.ajax({
  type: "post",
  contentType: "application/json",
  url: "UserService.asmx/HelloWorld",
  data: "{}",
  dataType: "json",
  success: function (result) {
    alert(result.d);
  }
});

注意取值方式是 result.d,而不是直接 result。這正是因為回傳的 JSON 是以 d 為鍵值的物件。

想親眼確認的話,可以在 IE 9 的開發人員工具中按 F12,切到「網路」頁籤並開始捕獲,重新整理後即可看到所有請求:

點進任一筆的詳細檢視,就能看到實際傳送的標頭與回應內容:

看到回應本文後,就不難理解為什麼非得寫 result.d 不可了。

二、回傳物件

[WebMethod]
public User GetUser()
{
    User user = new User() { Id = 1, UserName = "zhang san", Password = "123qwe" };
    return user;
}

$.ajax({
  type: "post",
  contentType: "application/json",
  url: "UserService.asmx/GetUser",
  data: "{}",
  dataType: "json",
  success: function (result) {
    alert(result.d.Id + " " + result.d.UserName);
  }
});

三、回傳泛型集合

[WebMethod]
public List<User> GetUserList()
{
    List<User> list = new List<User>()
    {
        new User { Id = 1, UserName = "zhang san", Password = "asfasdf" },
        new User { Id = 2, UserName = "li si",     Password = "3rwer"   },
        new User { Id = 3, UserName = "wang wu",   Password = "rqwe"    }
    };
    return list;
}

$.ajax({
  type: "post",
  contentType: "application/json",
  url: "UserService.asmx/GetUserList",
  data: "{}",
  dataType: "json",
  success: function (result) {
    $.each(result.d, function (index, data) {
      alert(data.Id + " " + data.UserName);
    });
  }
});

對應的回應本文長這樣:

{"d":[
  {"__type":"WebServiceDemo.User","Id":1,"UserName":"zhang san","Password":"asfasdf"},
  {"__type":"WebServiceDemo.User","Id":2,"UserName":"li si","Password":"3rwer"},
  {"__type":"WebServiceDemo.User","Id":3,"UserName":"wang wu","Password":"rqwe"}
]}

此時 result.d 拿到的是一個陣列,用 $.each 就能遍歷每一項的屬性。

四、傳遞參數

[WebMethod]
public string Hello(string name)
{
    return "Hello " + name;
}

$.ajax({
  type: "post",
  contentType: "application/json",
  url: "UserService.asmx/Hello",
  data: "{name:'admin'}",
  dataType: "json",
  success: function (result) {
    alert(result.d);
  }
});

這裡有個容易忽略的規則:AJAX 傳送的參數名稱必須與 WebService 方法的參數名稱完全一致,大小寫也要相符,否則呼叫會失敗。ASP.NET 的 ScriptService 在繫結 JSON 到方法參數時,是靠名稱比對而非位置,名字對不上就是拿不到值。

為什麼會多一層 d

這個 d 是微軟在 ASP.NET AJAX 中加入的包裝,用意是防止一類稱為「JSON hijacking」的攻擊手法——若直接回傳陣列,惡意網站有機會透過 <script> 標籤跨網域讀取資料。包成物件後,這個途徑就被堵住了。理解這層背景,就不會把 result.d 當成莫名其妙的規定來死記。

最後提醒,範例中的 Password 欄位被明文回傳到前端。真實專案中,密碼之類的敏感欄位絕不該出現在回應裡,這點在設計 API 時務必留意。

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