ASP.NET AJAX 允許你從用戶端腳本呼叫 ASP.NET Web Service(.asmx)與 WCF 服務(.svc)。當你使用 ASP.NET AJAX 的伺服器控制項時,腳本參照會自動加入頁面,並自動產生 Web Service 的代理類別,你直接透過代理類別發出呼叫即可。
即使不使用 ASP.NET AJAX 的伺服器控制項(例如你採用其它的開發環境),也同樣能呼叫 ASP.NET Web Service:只要自行在頁面中引入 Microsoft AJAX Library、載入相關腳本檔,再指向你的服務即可。執行階段 ASP.NET 一樣會產生代理類別。
本文說明如何建立一個 Web Service,以及如何用用戶端腳本在 AJAX 化的應用程式中呼叫它。
搭配 WCF 與 ASP.NET 時,常見的幾種情況:
AJAX 網頁上,瀏覽器會先發出一次初始請求,之後再對 Web Service 發出非同步的資料請求。用戶端通訊的兩個主要元素是「從伺服器下載的代理類別」與「核心用戶端腳本庫」;伺服器端則由 HTTP 處理常式與自訂服務負責。

瀏覽器透過代理類別呼叫 Web Service 方法。代理類別由伺服器自動產生,並在頁面載入時下載到瀏覽器,它提供一個用戶端物件,對應到服務所公開的方法。呼叫時,用戶端腳本呼叫代理類別上對應的方法,實際的溝通則由 XMLHTTP 物件以非同步方式完成。
代理類別裡的程式碼與核心通訊層,把 XMLHTTP 的複雜度以及各家瀏覽器的差異都隱藏起來,讓呼叫 Web Service 這件事變得單純。
使用 POST:請求本文可以承載資料,沒有大小限制。用戶端會把參數序列化成 JSON 格式,作為 POST 資料送出;伺服器反序列化為 .NET 型別後進行真正的服務呼叫,再把回傳值序列化送回,用戶端反序列化為 JavaScript 物件。
使用 GET:功能類似 POST,但有幾點差異——參數透過查詢字串傳遞;一次只能呼叫一個方法,且必須用 ScriptMethodAttribute 標記;資料量受瀏覽器允許的 URL 長度限制。

自訂服務代理類別:由伺服器自動產生並下載到用戶端,對應 ScriptManager 控制項 ServiceReferences 中的每一個項目。
驗證代理類別:由伺服器的驗證應用程式服務產生,讓你可以用 JavaScript 處理登入、登出,不必往返伺服器。
角色代理類別:由角色服務產生,可將使用者分組,用於授權或拒絕存取伺服器資源。
設定檔代理類別:由 Profile 服務產生,可把目前使用者的資料取到用戶端。
頁面方法代理類別:為 ASP.NET 頁面上的靜態方法提供底層支援。
Web Service 通訊層:一組用戶端腳本型別,負責與伺服器溝通、維護非同步流程,並封裝各瀏覽器提供的 XMLHTTP 物件,讓應用程式不必理會瀏覽器差異。主要成員包括 WebRequest(產生請求)、WebRequestManager(管理請求流程)、XmlHttpExecutor(執行非同步網路請求)、JSON 序列化,以及對 SOAP 請求的 XML 序列化支援。
.NET Framework 允許你從用戶端瀏覽器非同步呼叫 ASP.NET Web Service(.asmx)方法,不需要 Postback、也不會刷新整個頁面,因為只有資料在用戶端與伺服器之間傳輸。
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
<title>Simple Web Service</title>
<script type="text/javascript">
// 呼叫 Web Service 方法
function GetServerTime() {
Samples.AspNet.ServerTime.GetServerTime(OnSucceeded);
}
// 處理 Web Service 回傳值的回呼函式
function OnSucceeded(result) {
var RsltElem = document.getElementById("Results");
RsltElem.innerHTML = result;
}
</script>
</head>
<body>
<form id="Form1" runat="server">
<asp:ScriptManager runat="server" ID="scriptManager">
<Services>
<asp:ServiceReference path="ServerTime.asmx" />
</Services>
</asp:ScriptManager>
<div>
<h2>Server Time</h2>
<p>Calling a service that returns the current server time.</p>
<input id="EchoButton" type="button" value="GetTime"
onclick="GetServerTime()" />
</div>
</form>
<hr />
<div><span id="Results"></span></div>
</body>
</html>
對應的 Web Service:
<%@ WebService Language="C#" Class="Samples.AspNet.ServerTime" %>
using System;
using System.Web.Script.Services;
using System.Web.Services;
namespace Samples.AspNet
{
[WebService(Namespace = "https://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[ScriptService]
public class ServerTime : System.Web.Services.WebService
{
[WebMethod]
public string GetServerTime()
{
return String.Format("The server time is {0}.", DateTime.Now);
}
}
}
若你想自己掌控通訊層,或需要觀察送出的資料內容,可以直接用 WebRequest 類別呼叫服務。以下示範如何對指定的 URL 發出 GET 與 POST 請求:
// ConnectingEndPoints.js
var resultElement;
function pageLoad() {
resultElement = $get("ResultId");
}
// 執行 GET 請求
function GetWebRequest() {
var wRequest = new Sys.Net.WebRequest();
wRequest.set_url("getTarget.htm");
wRequest.set_httpVerb("GET");
wRequest.add_completed(OnWebRequestCompleted);
resultElement.innerHTML = "";
wRequest.invoke();
}
// 執行 POST 請求
function PostWebRequest() {
var wRequest = new Sys.Net.WebRequest();
wRequest.set_url("postTarget.aspx");
wRequest.set_httpVerb("POST");
wRequest.add_completed(OnWebRequestCompleted);
var requestBody = "Message=Hello! Do you hear me?";
wRequest.set_body(requestBody);
wRequest.get_headers()["Content-Length"] = requestBody.length;
resultElement.innerHTML = "";
wRequest.invoke();
}
// 非同步回呼:處理請求的傳回值
function OnWebRequestCompleted(executor, eventArgs) {
if (executor.get_responseAvailable()) {
resultElement.innerHTML = "";
// 顯示狀態碼
resultElement.innerHTML += "Status: [" +
executor.get_statusCode() + " " +
executor.get_statusText() + "]" + "<br/>";
// 顯示回應標頭
resultElement.innerHTML += "Headers: " +
executor.getAllResponseHeaders() + "<br/>";
// 顯示回應本文
resultElement.innerHTML += "Body: ";
if (document.all) {
resultElement.innerText += executor.get_responseData();
} else {
resultElement.textContent += executor.get_responseData();
}
}
}
if (typeof(Sys) !== "undefined") Sys.Application.notifyScriptLoaded();
你也可以用腳本非同步呼叫 WCF 服務(.svc)。頁面寫法如下:
<%@ Page Language="C#" AutoEventWireup="true" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head runat="server">
<style type="text/css">
body { font: 11pt Trebuchet MS; color: #000000;
padding-top: 72px; text-align: center }
.text { font: 8pt Trebuchet MS }
</style>
<title>Simple WCF Service Page</title>
</head>
<body>
<form id="form1" runat="server">
<asp:ScriptManager ID="ScriptManager1" runat="server">
<Services>
<asp:ServiceReference Path="SimpleService.svc/ws" />
</Services>
<Scripts>
<asp:ScriptReference Path="service.js" />
</Scripts>
</asp:ScriptManager>
<div>
<h2>Simple WCF Service</h2>
<input type="button" name="clickme" value="Greetings"
onclick="Javascript:OnClick()" />
<input type="button" name="clickme2" value="Greetings2"
onclick="Javascript:OnClick2()" />
<hr/>
<div><span id="Results"></span></div>
</div>
</form>
</body>
</html>
用戶端腳本:
var ServiceProxy;
function pageLoad() {
ServiceProxy = new ISimpleService();
ServiceProxy.set_defaultSucceededCallback(SucceededCallback);
}
function OnClick() {
ServiceProxy.HelloWorld1("George");
}
function OnClick2() {
var dc = new DataContractType();
dc.FirstName = "George";
dc.LastName = "Washington";
ServiceProxy.HelloWorld2(dc);
}
// 處理服務回傳值的回呼函式
function SucceededCallback(result, userContext, methodName) {
var RsltElem = document.getElementById("Results");
RsltElem.innerHTML = result + " from " + methodName + ".";
}
if (typeof(Sys) !== "undefined") Sys.Application.notifyScriptLoaded();
服務端實作:
using System;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Activation;
// WCF 服務由合約(ISimpleService)與實作類別(SimpleService)組成,
// 並於 web.config 的 <system.serviceModel> 中設定相關行為
namespace ASPnet.Samples
{
[ServiceContract()]
public interface ISimpleService
{
[OperationContract]
string HelloWorld1(string value1);
[OperationContract]
string HelloWorld2(DataContractType dataContractValue1);
}
[ServiceBehavior(IncludeExceptionDetailInFaults = true)]
[AspNetCompatibilityRequirements(
RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class SimpleService : ISimpleService
{
public string HelloWorld1(string value1)
{
return "Hello " + value1;
}
public string HelloWorld2(DataContractType dataContractValue1)
{
return "Hello " + dataContractValue1.FirstName +
" " + dataContractValue1.LastName;
}
}
[DataContract]
public class DataContractType
{
string firstName;
string lastName;
[DataMember]
public string FirstName
{
get { return firstName; }
set { firstName = value; }
}
[DataMember]
public string LastName
{
get { return lastName; }
set { lastName = value; }
}
}
}
整個流程可以濃縮成三件事:在服務類別上加 [ScriptService]、在頁面用 ScriptManager 註冊服務路徑、然後在 JavaScript 裡以「命名空間.類別.方法(參數, 回呼函式)」的形式呼叫。代理類別與序列化工作都由框架代勞,你只需要專心處理成功與失敗這兩條回呼路徑。