.NET Framework中使用XML Web Service_netframework webservice入参xml-CSDN博客

Microsoft®.NET Framework 精简版的一个主要功能是能够使用 XML Web Service。Microsoft .NET Framework 精简版支持以两种不同的方式使用 XML Web Service：同步和异步。这两种方式各有优缺点。同步 XML Web Service 调用编码简单，而异步调用的编码略微复杂。如果 XML Web Service 长时间无响应，同步调用将冻结应用程序，而异步调用则允许用户在调用 XML Web Service 期间与应用程序进行交互。

通过 Smart Device（智能设备）项目使用 XML Web Service 时，将发生几秒钟的初始延迟。如果生成异步调用，则此延迟不会冻结应用程序的用户界面。当 .NET Framework 精简版运行时设置 XML Web Service 的连接细节并缓存连接细节时将发生此延迟。通常情况下，这会导致应用程序无响应。以后再调用 XML Web Service 时，性能将会显著提高。

本文说明了如何向 Smart Device（智能设备）项目添加对 XML Web Service 的 Web 引用，以及如何同步和异步调用 XML Web Service。

本文假设您在使用 Microsoft Visual Studio® .NET 2003 创建智能设备应用程序方面有一定的经验。

使用 Web 服务

要在 Smart Device（智能设备）项目中使用 XML Web Service，您需要在项目中添加 Web 引用。项目通过 Web 引用来使用 XML Web Service。在项目中添加 Web 引用时，Visual Studio .NET 将自动生成一个“代理类”（其中包含用作 XML Web Service 每个公开方法的代理的方法）。默认情况下，代理类不会显示在 Solution Explorer（解决方案资源管理器）中。应用程序使用自动生成的类（而不是使用自己的代码修改的类）来访问 XML Web Service。

要向项目中添加 Web 引用，请执行以下操作：

在 Solution Explorer（解决方案资源管理器）中，选择要使用 XML Web Service 的项目。
在 Project（项目）菜单上，选择 Add Web Reference（添加 Web 引用）。
输入要使用的 XML Web Service 的 URL，并单击 Go（转到）按钮。

Add Web Reference（添加 Web 引用）对话框

在 Web reference name（Web 引用名称）字段中，输入将在代码中用于以编程方式访问选定 XML Web Service 的名称。
单击 Add Reference（添加引用）按钮以在应用程序中创建对 XML Web Service 的引用。新引用将显示在 Solution Explorer（解决方案资源管理器）中选定项目的 Web References（Web 引用）节点下。

Visual Studio .NET 在添加 Web 引用时生成的代理类还包含用于同步或异步访问 Web 服务的方法。现在我们来看一下如何实现此目的。

生成同步 XML Web Service 调用

生成对 XML Web Service 的同步调用时，调用线程将中断，直到 XML Web Service 返回方法调用的结果。如果在服务器中调用的方法不需要太多的处理时间，且将迅速返回，则同步调用比较有用。此外，同步 XML Web Service 调用比异步调用容易实现。但是，通过 .NET Framework 精简版应用程序调用 XML Web Service 时将发生重大延迟，这将使应用程序锁定并使用户接口冻结，直到返回方法调用为止。

要生成同步 XML Web Service 调用，需要创建一个代理类实例，然后调用此代理类中的方法，方式与调用其他类中的方法相同。以下代码示例演示了如何生成对 XML Web Service 的 Web 方法（用于返回有关 SQL Server 附带的 Pubs 示例数据库中的书籍的信息）的调用。然后，代码将通过 DataSet 将数据加载到 Windows 窗体上的 ListView 控件。

此示例假设您在添加 Web 引用（如本文第一部分所述）时将 Web 引用命名为 BookCatalog。BookCatalog XML Web Service 包含 GetItems Web 方法，该方法将返回一个 DataSet 对象。此代码取自本文附带的下载中的 button1_Click() 事件处理程序。

// ---- 调用 XML Web Service ----

// 创建 Web 服务代理类的实例

BookCatalog.Service1 bookcatalog = new BookCatalog.Service1();

// 创建 DataSet 对象的新实例并调用 Web 服务

// 方法 GetItems 检索书籍列表

DataSet ds = bookcatalog.GetItems();

// ------------------------------



// ----  处理 DataSet ----

// 遍历 DataSet 并将每个行的 Title_ID 和 Title 字段

// 添加至 ListView

foreach(DataRow drBook in ds.Tables[0].Rows) {

    // 创建一个新 ListViewItem 添加到 ListView

    ListViewItem book = new ListViewItem();

    // 将 Title_ID 字段指定给 Text 属性

    book.Text = drBook["Title_ID"].ToString();

    // 将 Title 字段指定给第一个 SubItem

    book.SubItem[0].Text = drBook["Title"].ToString();

    // 将书 ListViewItem 添加到 ListView

    listView1.Items.Add(book);

}

// ------------------------------

生成异步 Web 服务调用

通过生成异步 XML Web Service 调用，您可以在等待 XML Web Service 作出响应时继续使用调用线程。也就是说，用户可以在应用程序未锁定的情况下继续与其交互，而 XML Web Service 访问也将继续进行。这是一种更好的设计模式，通过使用多线程支持，可以更有效地在智能设备应用程序中使用线程。生成异步调用时，将在不同于运行用户界面的线程中生成调用。XML Web Service 应用程序不需要任何特殊配置即可支持异步访问，也不需要知道调用方式是同步还是异步。代理类中的每个同步方法都有相应的 Begin 和 End 方法。例如，如果 XML Web Service 方法名为 GetItems，则异步方法为 BeginGetItems 和 EndGetItems。

异步调用 XML Web Service 分两个步骤。第一步，调用 Begin 方法以初始化 Web 方法调用。第二步，调用 End 方法以完成 XML Web Service 调用并检索 XML Web Service 的响应。

Begin 方法返回一个 System.Web.Services.Protocol.WebClientAsyncResult 对象，用于实现 System.IAsyncResult 接口。此对象提供关于待定异步调用的状态信息。通过将此对象传递给 End 方法，代理类可以标识要完成的请求，尤其是同时生成多个异步调用时。

有多种方法可以确定异步 XML Web Service 调用何时完成：

向 Begin 方法传递一个回调委托。回调委托将在 XML Web Service 调用完成后执行。
使用 IAsyncResult.AsyncWaitHandle 对象的 WaitHandle 方法之一强制应用程序等待。使用 WaitHandle 类的方法时，客户端也可以指定超时，超时过后，客户端将不再等待调用的 XML Web Service 的结果。
在主线程代码中轮询 IAsyncResult.IsCompleted 属性的值以查找值 true。如果此属性为 true，则调用 End 方法以检索 XML Web Service 的响应。
可直接调用 End 方法，而无需使用其他技术确定异步 XML Web Service 调用是否完成。此方法将中断调用线程的执行，直到异步调用完成为止。

最有效的方法是向 Begin 方法传递一个回调委托，因为回调函数在等待响应期间不会中断线程。XML Web Service 返回其响应时，回调委托将在新线程中执行。然后，在回调中调用 End 方法。

以下代码演示了如何创建异步 XML Web Service 调用；此代码显示了对 BeginGetItems 的调用，语法如下：

BeginGetItems(System.AsyncCallback callback, object asyncState);

BeginGetItems 使用两个参数，第一个是 AsyncCallback 对象，它是通过在构造函数内传递 ServiceCallback 方法的地址创建的。第二个参数是对象类型的参数，可以传递任何可帮助您处理 XML Web Service 响应的对象。可以通过获取回调方法中 IAsyncResult 参数的 AsyncState 属性来访问此同一对象。在以下示例中，以这种方式传递的对象是 XML Web Service 代理对象，因此在执行回调委托时，可以调用 EndGetItems，如下面的 ServiceCallback 方法所示。

private void button2_Click(object sender, System.EventArgs e)

{

    // 禁用 Async 按钮并清除任何数据的 ListView

    // 创建 XML Web Service 代理类的实例

    BookCatalog.Service1 ws = new BookCatalog.Service1();

    // 创建对回调委托的引用

    AsyncCallback cb = new AsyncCallback(ServiceCallback);

    // 调用 Begin 方法，将回调委托和

    // 此代理类实例作为 AsyncState 对象传递。 

    ws.BeginGetItems(cb,ws);

}



private void ServiceCallback(IAsyncResult ar)

{

    // 将 AsyncState 对象转换为代理对象

    BookCatalog.Service1 ws = (BookCatalog.Service1)ar.AsyncState;

    // 调用 End 方法并将响应指定给 DataSet

    DataSet ds = ws.EndGetItems(ar);



    // 遍历 DataSet 并将每个行的 Title_ID 和 Title 字段

    // 添加至 ListView

    foreach(DataRow drBook in ds.Tables[0].Rows) {

        // 创建一个新 ListViewItem 添加到 ListView

        ListViewItem book = new ListViewItem();

        // 将 Title_ID 字段指定给 Text 属性

        book.Text = drBook["Title_ID"].ToString();

        // 将 Title 字段指定给第一个 SubItem

        book.SubItem[0].Text = drBook["Title"].ToString();

        // 将书 ListViewItem 添加到 ListView

        listView1.Items.Add(book);

    }

}

尽管生成异步 XML Web Service 调用比生成同步调用所需的代码稍多，但最终结果可以生成响应更快的应用程序，因此还是值得的。

重要信息：异步调用 XML Web Service 时，请使用多线程编程技术。

生成异步 XML Web Service 调用时，如果不使用多线程技术，则在两个或多个线程同时尝试访问同一数据时，将会出现问题。技术之一（如以下代码所示）就是在 C# 中使用 lock 语句来获取对对象的相互独占的访问权，以拒绝其他线程的访问。

private void ServiceCallback(IAsyncResult ar)

{

    // 将 AsyncState 对象转换为代理对象

    BookCatalog.Service1 ws = (BookCatalog.Service1)ar.AsyncState;

    // 调用 End 方法并将响应指定给 DataSet

    DataSet ds = ws.EndGetItems(ar);



    // 使用 lock 语句防止其他线程访问

    //  listview，直到完成对它的更新

    lock(this.listView1)

    {        

        // 遍历 DataSet 并将每个行的 Title_ID 以及 

        // Title 字段添加至 ListView

        foreach(DataRow drBook in ds.Tables[0].Rows) {

            // 创建一个新 ListViewItem 添加到 ListView

            ListViewItem book = new ListViewItem();

            // 将 Title_ID 字段指定给 Text 属性

            book.Text = drBook["Title_ID"].ToString();

            // 将 Title 字段指定给第一个 SubItem

            book.SubItem[0].Text = drBook["Title"].ToString();

            // 将书 ListViewItem 添加到 ListView

            listView1.Items.Add(book);

        }

    }

}

您还应该学习其他技术，例如，使用 Monitor 类和 Control.Invoke 来生成线程安全的应用程序。有关多线程编程技术的详细信息，可在 MSDN® Library 中找到。