本文示範透過 System.Web.Script 命名空間,讓用戶端 JavaScript 直接呼叫 Web 服務方法。
在 Ajax 中呼叫 Web 服務能有效提升使用者體驗。微軟在 ASP.NET 3.5 的 Ajax 中加入了這個能力:用戶端腳本可以呼叫伺服器端方法而不必 Postback、不必刷新整個頁面,資料可以作為輸入參數傳入,結果則由伺服器回傳給瀏覽器。
要讓應用程式能以用戶端腳本呼叫 ASP.NET Web Service,AJAX 的伺服器非同步通訊層會自動產生 JavaScript 代理類別。只要在 ScriptManager 控制項中登記對應的服務元素即可:
<asp:ScriptManager id="scriptManagerId" runat="server">
<Services>
<asp:ServiceReference Path="WebService.asmx" />
</Services>
</asp:ScriptManager>
代理類別會在頁面載入時被下載到瀏覽器,並提供一個用戶端物件供你呼叫 Web 服務的方法。呼叫時,產生的 JavaScript 會透過 XMLHTTP 物件與伺服器非同步通訊。

此外還需要註冊用來呼叫服務方法的 JavaScript 檔,例如 CallWebServiceMethod.js。
由於呼叫是非同步的,要取得返回值就必須提供「成功回呼函式」;它在請求成功完成時被呼叫,並接收 Web 方法傳回的資料(若有)。你也可以再提供一個「失敗回呼函式」處理錯誤,並可透過使用者內容參數在回呼之間傳遞額外資訊。

JSON(JavaScript 物件符號)是預設的序列化格式,用戶端與伺服器之間的資料轉換就靠它完成。你也可以停用 HTTP-GET、HTTP-POST 甚至早期 Web 服務使用的 SOAP/XML 協定,設定寫在 Web.config 裡:
<system.web>
<webServices>
<protocols>
<clear />
</protocols>
</webServices>
</system.web>

在 Ajax 中使用 Web 服務方法,基本上就是兩件事:建立並定義 Web 服務,然後用用戶端腳本從網頁呼叫它。
在 System.Web.Script.Services 命名空間中,你會找到 ScriptService 屬性類別。把它套用在 Web 服務類別上,該服務的方法才能被引用戶端腳本呼叫,同時會產生對應的代理物件。
同一個命名空間裡還有 ScriptMethod 屬性類別,套用在個別方法上時,可以指定用哪種 HTTP 動詞呼叫、以及回應的格式。它有三個參數:
UseHttpGet:設為 true 時以 HTTP GET 呼叫該方法,預設為 false。
ResponseFormat:指定回應序列化為 JSON 或 XML,預設為 JSON。
XmlSerializeString:指定是否連字串型別的返回值也一併做 XML 序列化;若為 false,則連續的回應會被序列化為 JSON。
接著在 Visual Studio 2008 中用 ASP.NET Web Service 範本建立新的服務,並修改如下:
using System.Web.Script.Services;
using System.Web.Services;
using System.Xml;
namespace AjaxWebService
{
[WebService(Namespace = "https://localhost:1382/AjaxWebService/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[ScriptService]
public class Service : System.Web.Services.WebService
{
string myXmlData =
@"<?xml version=""1.0"" encoding=""utf-8"" ?><BOOK></BOOK>";
/// <summary>
/// 這個方法使用 JSON 回應格式
/// </summary>
[ScriptMethod(ResponseFormat = ResponseFormat.Json)]
[WebMethod]
public string getNextBackupDate(int months)
{
return DateTime.Now.AddMonths(months).ToShortDateString();
}
/// <summary>
/// 這個方法使用 XML 回應格式
/// </summary>
[ScriptMethod(ResponseFormat = ResponseFormat.Xml)]
[WebMethod]
public XmlDocument GetBookTitle()
{
XmlDocument xmlDoc = new XmlDocument();
xmlDoc.LoadXml(myXmlData);
return xmlDoc;
}
/// <summary>
/// 這個方法以 HTTP-GET 協定呼叫
/// </summary>
[ScriptMethod(UseHttpGet = true)]
[WebMethod]
public string HelloWorld()
{
return "Hello, world";
}
}
}
注意:建立好 ScriptService 之後,預設情況下瀏覽器不會直接存取它。若要測試上述服務,需修改 Web.config:
<webServices>
<protocols>
<add name="HttpGet" />
<add name="HttpPost" />
</protocols>
</webServices>
AJAX 網頁呼叫 Web 服務方法是非同步的,不會 Postback、也不會刷新整個頁面,只有資料在用戶端與伺服器之間傳輸。目前 .NET 3.5 架構支援用戶端網頁與 Web 服務位於同一個網域(同一個站台)。
新增一個「AJAX 啟用的 Web 網頁」,加入下列標記,並撰寫呼叫服務與回呼的 JavaScript 函式。呼叫方式是透過代理類別加上參數清單、成功回呼函式名、失敗回呼函式,以及額外的使用者端參數:
<%@ Page Language="C#" AutoEventWireup="true"
CodeFile="Default.aspx.cs" Inherits="AjaxWebService.Default" %>
<html xmlns="https://www.w3.org/1999/xhtml">
<head runat="server">
<script type="text/javascript">
function CallNextDate() {
AjaxWebService.Service.getNextBackupDate(1, OnSucceeded);
}
function CallHelloWorld() {
AjaxWebService.Service.HelloWorld(OnSucceeded);
}
function CallBookTitle() {
AjaxWebService.Service.GetBookTitle(OnSuccess, OnFail, "XmlDocument");
}
// 處理 JSON 格式回傳值的回呼函式
function OnSucceeded(result) {
document.getElementById("Text1").value = result;
}
// 處理 XML 格式回傳值的回呼函式
function OnSuccess(result) {
document.getElementById("Text1").value =
"Title: " + result.documentElement.text;
}
// 失敗回呼函式
function OnFail(error) {
document.getElementById("Text1").value =
"Service Error: " + error.get_message();
}
</script>
<style type="text/css">
#Text1 { width: 375px; }
#Button2 { width: 140px; }
</style>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:ScriptManager id="ScriptManager1" runat="server">
<Services>
<asp:ServiceReference Path="~/Service.asmx" />
</Services>
</asp:ScriptManager>
<br />
Result: <input id="Text1" /><br /><br />
<input id="Button1" onclick="CallNextDate()" type="button"
value="Get Server Time" />
<input id="Button2" onclick="CallHelloWorld()" type="button"
value="Say Hello World" />
<input id="Button3" onclick="CallBookTitle()" type="button"
value="Get Book Title" />
</div>
</form>
</body>
</html>
上述標記中,ServiceReference 元素的 Path 屬性指向 Web 服務類別的位置,這使得頁面裡的腳本得以呼叫該服務的方法。CallNextDate、CallHelloWorld、CallBookTitle 三個函式分別呼叫三個服務方法,OnSuccess 與 OnFail 則是處理執行結果的回呼。
最後,為了讓用戶端網頁正常運作,Web.config 還需要加入組件繫結重新導向的設定:
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Web.Extensions"
publicKeyToken="31bf3856ad364e35" />
<bindingRedirect newVersion="3.5.0.0" oldVersion="1.0.0.0-1.1.0.0" />
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Web.Extensions.Design"
publicKeyToken="31bf3856ad364e35" />
<bindingRedirect newVersion="3.5.0.0" oldVersion="1.0.0.0-1.1.0.0" />
</dependentAssembly>
</assemblyBinding>
</runtime>
本文使用 ASP.NET 3.5 中內建的 System.Web.Extensions.dll 等程式集,示範了 Ajax 與 Web 服務整合的完整路徑,僅供學習參考。