技巧：服務器端異步 Web 方法_Web服務器教程

在九月份的第三篇專欄(英文)中，我談到了利用 Microsoftreg; .NET Framework 的客戶端功能通過 HTTP 異步調用 Web 服務的問題。這種調用 Web 服務的方法非常有用，使用時不必鎖定您的應用程序或產生過多后臺線程。現在我們了解一下在服務器端提供類似功能的異步 Web 方法。異步 Web 方法在編寫 ISAPI 擴展方面具有與 HSE_STATUS_PENDING 方法類似的高性能，但不需要為管理自己的線程池編寫代碼，同時又具有以托管代碼方式運行的所有優點。

首先我們考慮一下常規的同步 Microsoftreg; ASP.NET Web 方法。當您從同步 Web 方法返回時，將發送對該方法的響應。如果需要較長的時間來完成請求，則處理請求的線程會一直被占用，直到方法調用結束。不幸的是，多數較長的調用是由較長的數據庫查詢或對另一個 Web 服務的調用等事件引起的。例如，如果您調用數據庫，當前線程會一直等待調用完成。線程無事可做，只是等待，直至聽到查詢的返回。當線程等待完成對 TCP 套接字或后端 Web 服務的調用時，也會出現類似的問題。

讓線程處于等待狀態很不好，特別是在服務器的運行壓力很大的情況下。等待中的線程不會進行任何有效工作，例如為其他請求提供服務。我們需要找到一種方法，能夠在服務器上開始較長的后臺進程，同時又能將當前線程返回到 ASP.NET 進程池。然后，當較長的后臺進程完成時，我們調用一個回調函數，結束對請求的處理，并通過某種方式通知 ASP.NET 請求已完成。實際上，這種功能可由 ASP.NET 使用異步 Web 方法提供。

異步 Web 方法的工作原理

當您使用 Web 方法編寫典型的 ASP.NET Web 服務時，Microsoftreg; Visual Studioreg; .Net 只是編譯您的代碼以創建程序集;當收到對其 Web 方法的請求時，將調用該程序集。程序集本身并不知道關于 SOAP 的任何事情。因此，當您的應用程序首次啟動時，ASMX 處理程序必須反映您的程序集，以確定提供哪些 Web 方法。對于常規的同步請求，這些操作都很簡單：找出哪些方法具有關聯的 WebMethod 屬性、基于 SOAPAction HTTP 標頭來設置調用正確方法的邏輯。

對于異步請求，在反映過程中，ASMX 處理程序尋找具有某種簽名并將簽名識別為異步的 Web 方法。該處理程序將尋找符合以下規則的方法對：

BeginXXX 和 EndXXX Web 方法，其中 XXX 是任意字符串，表示要提供的方法的名稱。

BeginXXX 函數返回一個 IAsyncResult 接口，并分別接受 AsyncCallback 和一個對象，作為其最后兩個輸入參數。

EndXXX 函數接受一個 IAsyncResult 接口，作為其唯一的參數。

兩個方法都必須使用 WebMethod 屬性進行標識。

如果 ASMX 處理程序發現兩個方法符合上述所有條件，則將方法 XXX 作為常規的 Web 方法在其 WSDL 中提供。該方法將接受在 BeginXXX 的簽名中的 AsyncCallback 參數之前定義的參數作為輸入，并返回由 EndXXX 函數返回的內容。因此，如果某個 Web 方法具有如下同步聲明：

[WebMethod]

public string LengthyProcedure(int milliseconds) {...}

則異步聲明將為：

[WebMethod]

public IAsyncResult BeginLengthyProcedure(

int milliseconds,

AsyncCallback cb,

object s) {...}

[WebMethod]

public string EndLengthyProcedure(IAsyncResult call) {...}

每個方法的 WSDL 都是相同的。

在 ASMX 處理程序反映程序集并檢測到某個異步 Web 方法后，它必須以不同于處理同步請求的方式處理對該方法的請求。它將調用 BeginXXX 方法，而不是某個簡單方法。它將傳入的請求還原序列化到要傳遞到函數的參數中(與處理同步請求時一樣);但是它還將指針傳遞到一個內部回調函數(作為 BeginXXX 方法的額外 AsyncCallback 參數)。

這種方法類似于 .NET Framework 中 Web 服務客戶端應用程序的異步編程模式。如果客戶端支持異步 Web 服務調用，則可以為客戶端計算機釋放占用的線程;如果服務器端支持異步 Web 服務調用，則可以釋放服務器計算機上占用的線程。但這里有兩個關鍵的區別。首先，不是由服務器代碼調用 BeginXXX 和 EndXXX 函數，而是由 ASMX 處理程序調用。其次，您要為 BeginXXX 和 EndXXX 函數編寫代碼，而不能使用由 WSDL.EXE 或 Visual Studio .NET 中的 Add Web Reference(添加 Web 引用)向導生成的代碼。但結果是相同的，即釋放線程以使其能夠執行其他進程。

ASMX 處理程序調用服務器的 BeginXXX 函數后，會將線程返回到進程線程池，使之能夠處理接收到的任何其他請求。但是，還不能釋放請求的 HttpContext。ASMX 處理程序將等待，直到它傳遞給 BeginXXX 函數的回調函數被調用，它才結束處理請求。

一旦回調函數被調用，ASMX 處理程序將調用 EndXXX 函數，使您的 Web 方法可以完成任何所要執行的處理，并且可以得到被序列化到 SOAP 響應中的返回數據。EndXXX 函數返回后將發送響應，只有此時該請求的 HttpContext 才得到釋放。

簡單的異步 Web 方法

為舉例說明異步 Web 方法，我從一個名為 LengthyProcedure 的簡單同步 Web 方法開始，其代碼如下所示。然后我們再看一看如何異步完成相同的任務。LengthyProcedure 只占用給定的毫秒數。

[WebService]

public class SyncWebService : System.Web.Services.WebService

{

[WebMethod]

public string LengthyProcedure(int milliseconds)

{

System.Threading.Thread.Sleep(milliseconds);

return "成功";

}

}

現在我們將 LengthyProcedure 轉換為異步 Web 方法。我們必須創建如前所述的 BeginLengthyProcedure 函數和 EndLengthyProcedure 函數。請記住，我們的 BeginLengthyProcedure 調用需要返回一個 IAsyncResult 接口。這里，我打算使用一個委托以及該委托上的 BeginInvoke 方法，讓我們的 BeginLengthyProcedure 調用進行異步方法調用。傳遞到 BeginLengthyProcedure 的回調函數將被傳遞到委托上的 BeginInvoke 方法，從 BeginInvoke 返回的 IAsyncResult 將被 BeginLengthyProcedure 方法返回。

當委托完成時，將調用 EndLengthyProcedure 方法。我們將調用委托上的 EndInvoke 方法，以傳入 IAsyncResult，并將其作為 EndLengthyProcedure 調用的輸入。返回的字符串將是從該 Web 方法返回的字符串。下面是其代碼：

[WebService]

public class AsyncWebService : System.Web.Services.WebService

{

public delegate string LengthyProcedureAsyncStub(

int milliseconds);

public string LengthyProcedure(int milliseconds)

{

System.Threading.Thread.Sleep(milliseconds);

return "成功";

}

public class MyState

{

public object previousState;

public LengthyProcedureAsyncStub asyncStub;

}

[ System.Web.Services.WebMethod ]

public IAsyncResult BeginLengthyProcedure(int milliseconds,

AsyncCallback cb, object s)

{

LengthyProcedureAsyncStub stub

= new LengthyProcedureAsyncStub(LengthyProcedure);

MyState ms = new MyState();

ms.previousState = s;

ms.asyncStub = stub;

return stub.BeginInvoke(milliseconds, cb, ms);

}

[ System.Web.Services.WebMethod ]

public string EndLengthyProcedure(IAsyncResult call)

{

MyState ms = (MyState)call.AsyncState;

return ms.asyncStub.EndInvoke(call);

}

}

何時采用異步 Web 方法

在確定是否適合在您的應用程序中采用異步 Web 方法時，有幾個問題需要考慮。首先，調用的 BeginXXX 函數必須返回一個 IAsyncResult 接口。IAsyncResult 是從多個異步 I/O 操作返回的，這些操作包括訪問數據流、進行 Microsoftreg; Windowsreg; 套接字調用、執行文件 I/O、與其他硬件設備交互、調用異步方法，當然也包括調用其他 Web 服務。您可以從這些異步操作中得到 IAsyncResult，以便從 BeginXXX 函數返回它。您也可以創建自己的類以實現 IAsyncResult 接口，但隨后可能需要以某種方式包裝前面提到的某個 I/O 操作。

對于前面提到的大多數異步操作，使用異步 Web 方法包裝后端異步調用很有意義，可以使 Web 服務代碼更有效。但使用委托進行異步方法調用時除外。委托會導致異步方法調用占用進程線程池中的某個線程。不幸的是，ASMX 處理程序為進入的請求提供服務時同樣要使用這些線程。所以與對硬件或網絡資源執行真正 I/O 操作的調用不同，使用委托的異步方法調用在執行時仍將占用其中一個進程線程。您也可以占用原來的線程，同步運行您的 Web 方法。

下面的示例顯示了一個調用后端 Web 服務的異步 Web 方法。它已經使用 WebMethod 屬性標識了 BeginGetAge 和 EndGetAge 方法，以便異步運行。此異步 Web 方法的代碼調用名為 UserInfoQuery 的后端 Web 方法，以獲得它需要返回的信息。對 UserInfoQuery 的調用被異步執行，并被傳遞到 AsyncCallback 函數，后者被傳遞到 BeginGetAge 方法。這將導致當后端請求完成時，調用內部回調函數。然后，回調函數將調用 EndGetAge 方法以完成請求。此示例中的代碼比前面示例中的代碼簡單得多，并且還具有另外一個優點，即沒有在與為中間層 Web 方法請求提供服務的相同線程池中啟動后端處理。

[WebService]

public class GetMyInfo : System.Web.Services.WebService

{

[WebMethod]

public IAsyncResult BeginGetAge(AsyncCallback cb, Object state)

{

// 調用異步 Web 服務調用。

localhost.UserInfoQuery proxy

= new localhost.UserInfoQuery();

return proxy.BeginGetUserInfo("用戶名",

cb,

proxy);

}

[WebMethod]

public int EndGetAge(IAsyncResult res)

{

localhost.UserInfoQuery proxy

= (localhost.UserInfoQuery)res.AsyncState;

int age = proxy.EndGetUserInfo(res).age;

// 在此對 Web 服務的結果進行其他

// 處理。

return age;

}

}

發生在 Web 方法中的最常見的 I/O 操作類型之一是對 SQL 數據庫的調用。不幸的是，目前 Microsoftreg; ADO.NET 尚未定義一個完好的異步調用機制;而只是將 SQL 調用包裝到異步委托調用中對提高效率沒有什么幫助。雖然有時可以選擇緩存結果，但是也應當考慮使用 Microsoft SQL Server 2000 Web Services Toolkit(英文)將您的數據庫發布為 Web 服務。這樣您就可以利用 .NET Framework 中的支持，異步調用 Web 服務以查詢或更新數據庫。

通過 Web 服務調用訪問 SQL 時，需要注意眾多的后端資源。如果您使用了 TCP 套接字與 Unix 計算機通信，或者通過專用的數據庫驅動程序訪問其他一些可用的 SQL 平臺，甚至具有使用 DCOM 訪問的資源，您都可以考慮使用眾多的 Web 服務工具包將這些資源發布為 Web 服務。

使用這種方法的優點之一是您可以利用客戶端 Web 服務結構的優勢，例如使用 .NET Framework 的異步 Web 服務調用。這樣您將免費獲得異步調用能力，而您的客戶端訪問機制會與異步 Web 方法高效率地配合工作。

使用異步 Web 方法聚合數據

現在，許多 Web 服務都訪問后端的多個資源并為前端的 Web 服務聚合信息。盡管調用多個后端資源會增加異步 Web 方法模型的復雜性，但最終還是能夠顯著提高效率。

假設您的 Web 方法調用兩個后端 Web 服務：服務 A 和服務 B。從您的 BeginXXX 函數，您可以異步調用服務 A 和服務 B。您應該向每個異步調用傳遞自己的回調函數。在從服務 A 和服務 B 接收到結果后，為觸發 Web 方法的完成，您提供的回調函數將驗證所有的請求都已完成，在返回的數據上進行所有的處理，然后調用傳遞到 BeginXXX 函數的回調函數。這將觸發對 EndXXX 函數的調用，此函數的返回將導致異步 Web 方法的完成。

小結

異步 Web 方法在 ASP.NET Web 服務中提供了一個有效的機制，可以調用后端服務，而不會導致占用卻不利用進程線程池中的寶貴線程。通過結合對后端資源的異步請求，服務器可以使用自己的 Web 方法使同時處理的請求數目達到最大。您應該考慮使用此方法開發高性能的 Web 服務應用程序。