服务器端异步 Web 方法

简介

在九月份的第三篇专栏（英文）中，我谈到了利用 Microsoft® .NET Framework 的客户端功能通过 HTTP 异步调用 Web 服务的问题。这种调用 Web 服务的方法非常有用，使用时不必锁定您的应用程序或产生过多后台线程。现在我们了解一下在服务器端提供类似功能的异步 Web 方法。异步 Web 方法在编写 ISAPI 扩展方面具有与 HSE_STATUS_PENDING 方法类似的高性能，但不需要为管理自己的线程池编写代码，同时又具有以托管代码方式运行的所有优点。

首先我们考虑一下常规的同步 Microsoft® ASP.NET Web 方法。当您从同步 Web 方法返回时，将发送对该方法的响应。如果需要较长的时间来完成请求，则处理请求的线程会一直被占用，直到方法调用结束。不幸的是，多数较长的调用是由较长的数据库查询或对另一个 Web 服务的调用等事件引起的。例如，如果您调用数据库，当前线程会一直等待调用完成。线程无事可做，只是等待，直至听到查询的返回。当线程等待完成对 TCP 套接字或后端 Web 服务的调用时，也会出现类似的问题。

让线程处于等待状态很不好，特别是在服务器的运行压力很大的情况下。等待中的线程不会进行任何有效工作，例如为其他请求提供服务。我们需要找到一种方法，能够在服务器上开始较长的后台进程，同时又能将当前线程返回到 ASP.NET 进程池。然后，当较长的后台进程完成时，我们调用一个回调函数，结束对请求的处理，并通过某种方式通知 ASP.NET 请求已完成。实际上，这种功能可由 ASP.NET 使用异步 Web 方法提供。

异步 Web 方法的工作原理

当您使用 Web 方法编写典型的 ASP.NET Web 服务时，Microsoft® Visual Studio® .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 操作返回的，这些操作包括访问数据流、进行 Microsoft® Windows® 套接字调用、执行文件 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 数据库的调用。不幸的是，目前 Microsoft® 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 服务应用程序。