从 XML Web 服务使用 DataSet

DataSet 是用断开式设计来构建的，其部分目的是为了便于通过 Internet 来传输数据。 由于可以将 DataSet 指定为 XML Web 服务的输入或输出，并且无需进行其他任何编码即可在 XML Web 服务和客户端之间将 DataSet 内容以流的形式来回传递，因此 DataSet 是“可序列化的”。 DataSet 使用 DiffGram 格式隐式地转换为 XML 流，通过网络进行发送，然后在接收端从 XML 流重新构造为 DataSet。 DataSet 为你使用 XML Web 服务传输和返回关系数据提供了简单而灵活的方法。 有关 DiffGram 格式的详细信息，请参阅 DiffGram。

以下示例显示如何创建 XML Web 服务和客户端，以使用 DataSet 传输关系数据（包括修改的数据）并将任何更新解析回原始数据源。

备注

如果输入不受信任，则在 XML Web 服务调用过程中传输 DataSet 或 DataTable 实例是不安全的操作。 有关详细信息，请参阅 DataSet 和 DataTable 安全指南。 我们还建议在创建 XML Web 服务时始终考虑到安全影响。 有关保护 XML Web 服务的信息，请参阅保护使用 ASP.NET 创建的 XML Web 服务。

创建 XML Web 服务

1. 创建 XML Web services。

   本示例将创建一个 XML Web 服务，该服务将返回数据（在本例中为 Northwind 数据库中的客户列表），然后接收一个包含数据更新的 DataSet，该 XML Web 服务会将这些更新解析回原始数据源。

   XML Web 服务将公开两个方法：用于返回客户列表的 GetCustomers，和用于将更新解析回数据源的 UpdateCustomers。 XML Web services 存储在 Web 服务器上名为 DataSetSample.asmx 的文件中。 下面的代码概括了 DataSetSample.asmx 的内容。

   <% @ WebService Language = "vb" Class = "Sample" %>  
   Imports System  
   Imports System.Data  
   Imports System.Data.SqlClient  
   Imports System.Web.Services  
   
   <WebService(Namespace:="http://microsoft.com/webservices/")> _  
   Public Class Sample  
   
   Public connection As SqlConnection = New SqlConnection("Data Source=(local);Integrated Security=SSPI;Initial Catalog=Northwind")  
   
     <WebMethod( Description := "Returns Northwind Customers", EnableSession := False )> _  
     Public Function GetCustomers() As DataSet  
       Dim adapter As SqlDataAdapter = New SqlDataAdapter( _  
         "SELECT CustomerID, CompanyName FROM Customers", connection)  
   
       Dim custDS As DataSet = New DataSet()  
       adapter.MissingSchemaAction = MissingSchemaAction.AddWithKey  
       adapter.Fill(custDS, "Customers")  
   
       Return custDS  
     End Function  
   
     <WebMethod( Description := "Updates Northwind Customers", EnableSession := False )> _  
     Public Function UpdateCustomers(custDS As DataSet) As DataSet  
       Dim adapter As SqlDataAdapter = New SqlDataAdapter()  
   
       adapter.InsertCommand = New SqlCommand( _  
         "INSERT INTO Customers (CustomerID, CompanyName) " & _  
         "Values(@CustomerID, @CompanyName)", connection)  
       adapter.InsertCommand.Parameters.Add( _  
         "@CustomerID", SqlDbType.NChar, 5, "CustomerID")  
       adapter.InsertCommand.Parameters.Add( _  
         "@CompanyName", SqlDbType.NChar, 15, "CompanyName")  
   
       adapter.UpdateCommand = New SqlCommand( _  
         "UPDATE Customers Set CustomerID = @CustomerID, " & _  
         "CompanyName = @CompanyName WHERE CustomerID = " & _  
         @OldCustomerID", connection)  
       adapter.UpdateCommand.Parameters.Add( _  
         "@CustomerID", SqlDbType.NChar, 5, "CustomerID")  
       adapter.UpdateCommand.Parameters.Add( _  
         "@CompanyName", SqlDbType.NChar, 15, "CompanyName")  
   
       Dim parameter As SqlParameter = _  
         adapter.UpdateCommand.Parameters.Add( _  
         "@OldCustomerID", SqlDbType.NChar, 5, "CustomerID")  
       parameter.SourceVersion = DataRowVersion.Original  
   
       adapter.DeleteCommand = New SqlCommand( _  
         "DELETE FROM Customers WHERE CustomerID = @CustomerID", _  
         connection)  
       parameter = adapter.DeleteCommand.Parameters.Add( _  
         "@CustomerID", SqlDbType.NChar, 5, "CustomerID")  
       parameter.SourceVersion = DataRowVersion.Original  
   
       adapter.Update(custDS, "Customers")  
   
       Return custDS  
     End Function  
   End Class  
   

   <% @ WebService Language = "C#" Class = "Sample" %>  
   using System;  
   using System.Data;  
   using System.Data.SqlClient;  
   using System.Web.Services;  
   
   [WebService(Namespace="http://microsoft.com/webservices/")]  
   public class Sample  
   {  
     public SqlConnection connection = new SqlConnection("Data Source=(local);Integrated Security=SSPI;Initial Catalog=Northwind");  
   
     [WebMethod( Description = "Returns Northwind Customers", EnableSession = false )]  
     public DataSet GetCustomers()  
     {  
       SqlDataAdapter adapter = new SqlDataAdapter(  
         "SELECT CustomerID, CompanyName FROM Customers", connection);  
   
       DataSet custDS = new DataSet();  
       adapter.MissingSchemaAction = MissingSchemaAction.AddWithKey;  
       adapter.Fill(custDS, "Customers");  
   
       return custDS;  
     }  
   
     [WebMethod( Description = "Updates Northwind Customers",  
       EnableSession = false )]  
     public DataSet UpdateCustomers(DataSet custDS)  
     {  
       SqlDataAdapter adapter = new SqlDataAdapter();  
   
       adapter.InsertCommand = new SqlCommand(  
         "INSERT INTO Customers (CustomerID, CompanyName) " +  
         "Values(@CustomerID, @CompanyName)", connection);  
       adapter.InsertCommand.Parameters.Add(  
         "@CustomerID", SqlDbType.NChar, 5, "CustomerID");  
       adapter.InsertCommand.Parameters.Add(  
         "@CompanyName", SqlDbType.NChar, 15, "CompanyName");  
   
       adapter.UpdateCommand = new SqlCommand(  
         "UPDATE Customers Set CustomerID = @CustomerID, " +  
         "CompanyName = @CompanyName WHERE CustomerID = " +  
         "@OldCustomerID", connection);  
       adapter.UpdateCommand.Parameters.Add(  
         "@CustomerID", SqlDbType.NChar, 5, "CustomerID");  
       adapter.UpdateCommand.Parameters.Add(  
         "@CompanyName", SqlDbType.NChar, 15, "CompanyName");  
       SqlParameter parameter = adapter.UpdateCommand.Parameters.Add(  
         "@OldCustomerID", SqlDbType.NChar, 5, "CustomerID");  
       parameter.SourceVersion = DataRowVersion.Original;  
   
       adapter.DeleteCommand = new SqlCommand(  
       "DELETE FROM Customers WHERE CustomerID = @CustomerID",  
        connection);  
       parameter = adapter.DeleteCommand.Parameters.Add(  
         "@CustomerID", SqlDbType.NChar, 5, "CustomerID");  
       parameter.SourceVersion = DataRowVersion.Original;  
   
       adapter.Update(custDS, "Customers");  
   
       return custDS;  
     }  
   }  
   

   一般情况下，会编写 UpdateCustomers 方法来捕获乐观并发冲突。 为了简单起见，以上示例没有包含此方法。 有关乐观并发的详细信息，请参阅乐观并发。

2. 创建 XML Web services 代理。

   XML Web services 的客户端将需要通过 SOAP 代理来使用公开的方法。 可以使用 Visual Studio 生成此代理。 通过从 Visual Studio 中设置对现有 Web 服务的 Web 引用，此步骤中所述的所有行为均将透明地发生。 如果要自己创建代理类，请继续阅读本讨论。 但是，在大多数情况下，使用 Visual Studio 足以为客户端应用程序创建代理类。

   代理可以使用 Web 服务描述语言工具来创建。 例如，如果在 URL http://myserver/data/DataSetSample.asmx 上公开 XML Web 服务，请发出如下命令以创建一个命名空间为 WebData.DSSample 的 Visual Basic .NET 代理，并将其存储在文件 sample.vb 中。

   wsdl /l:VB -out:sample.vb http://myserver/data/DataSetSample.asmx /n:WebData.DSSample  
   

   若要在文件 sample.cs 中创建一个 C# 代理，请发出以下命令。

   wsdl -l:CS -out:sample.cs http://myserver/data/DataSetSample.asmx -n:WebData.DSSample  
   

   然后，可以将该代理编译为库并导入 XML Web services 客户端。 若要将 sample.vb 中存储的 Visual Basic .NET 代理代码编译为 sample.dll，请发出以下命令。

   vbc -t:library -out:sample.dll sample.vb -r:System.dll -r:System.Web.Services.dll -r:System.Data.dll -r:System.Xml.dll  
   

   若要将 sample.cs 中存储的 C# 代理代码编译为 sample.dll，请发出以下命令。

   csc -t:library -out:sample.dll sample.cs -r:System.dll -r:System.Web.Services.dll -r:System.Data.dll -r:System.Xml.dll  
   

3. 创建 XML Web services 客户端。

   若要让 Visual Studio 为你生成 Web 服务代理类，只需创建客户端项目，然后在“解决方案资源管理器”窗口中右键单击该项目并选择“添加”>“服务引用”。 在“添加服务引用”对话框中，依次选择“高级”、“添加 Web 引用”。 从可用 Web 服务列表中选择该 Web 服务（如果当前解决方案或当前计算机中未提供该 Web 服务，则可能需要提供 Web 服务终结点的地址）。 如果自己创建 XML Web services 代理（按照前面的步骤所述），可以将其导入客户端代码并使用 XML Web services 方法。

   以下示例代码导入代理库，调用 GetCustomers 来获取客户列表，添加新客户，然后返回一个包含对 UpdateCustomers 的更新的 DataSet。

   该示例将 DataSet.GetChanges 所返回的 DataSet 传递给 UpdateCustomers，因为只有经过修改的行才需要传递给 UpdateCustomers。 UpdateCustomers 返回已解析的 DataSet，然后，你可以将其合并到现有 DataSet 中，以整合来自更新的已解析更改以及任何行错误信息。 以下代码假设你使用 Visual Studio 创建了 Web 引用，并且已在“添加 Web 引用”对话框中将该 Web 引用重命名为 DsSample。

   Imports System  
   Imports System.Data  
   
   Public Class Client  
   
     Public Shared Sub Main()  
       Dim proxySample As New DsSample.Sample ()  ' Proxy object.  
       Dim customersDataSet As DataSet = proxySample.GetCustomers()  
       Dim customersTable As DataTable = _  
         customersDataSet.Tables("Customers")  
   
       Dim rowAs DataRow = customersTable.NewRow()  
       row("CustomerID") = "ABCDE"  
       row("CompanyName") = "New Company Name"  
       customersTable.Rows.Add(row)  
   
       Dim updateDataSet As DataSet = _  
         proxySample.UpdateCustomers(customersDataSet.GetChanges())  
   
       customersDataSet.Merge(updateDataSet)  
       customersDataSet.AcceptChanges()  
     End Sub  
   End Class  
   

   using System;  
   using System.Data;  
   
   public class Client  
   {  
     public static void Main()  
     {  
       Sample proxySample = new DsSample.Sample();  // Proxy object.  
       DataSet customersDataSet = proxySample.GetCustomers();  
       DataTable customersTable = customersDataSet.Tables["Customers"];  
   
       DataRow row = customersTable.NewRow();  
       row["CustomerID"] = "ABCDE";  
       row["CompanyName"] = "New Company Name";  
       customersTable.Rows.Add(row);  
   
       DataSet updateDataSet = new DataSet();  
   
       updateDataSet =
         proxySample.UpdateCustomers(customersDataSet.GetChanges());  
   
       customersDataSet.Merge(updateDataSet);  
       customersDataSet.AcceptChanges();  
     }  
   }  
   

   如果决定自己创建代理类，必须执行下列额外的步骤。 若要编译该示例，将需要提供已创建的代理库 (sample.dll) 和相关的 .NET 库。 若要编译该示例的 Visual Basic .NET 版本（存储在文件 client.vb 中），请发出以下命令。

   vbc client.vb -r:sample.dll -r:System.dll -r:System.Data.dll -r:System.Xml.dll -r:System.Web.Services.dll  
   

   若要编译该示例的 C# 版本（存储在文件 client.cs 中），请发出以下命令。

   csc client.cs -r:sample.dll -r:System.dll -r:System.Data.dll -r:System.Xml.dll -r:System.Web.Services.dll  
   

请参阅

• ADO.NET
• 数据集、数据表和数据视图
• DataTables
• 从 DataAdapter 填充数据集
• 使用 DataAdapter 更新数据源
• DataAdapter 参数
• Web Services 描述语言工具 (Wsdl.exe)
• ADO.NET 概述