xref:System.Data.DataSet 是用断开式设计来构建的,其部分目的是为了便于通过 Internet 来传输数据。 数据集是"可序列化",它可以被指定为输入还是输出而无需任何其他编码的 XML Web services 所需流式传输的内容数据集从 XML Web 服务到客户端并返回。 数据集隐式转换为使用 DiffGram 格式的 XML 流、 通过网络发送和从 XML 流作为然后重新构造数据集在接收端。 它为你使用 XML Web services 传输和返回关系数据提供了非常简单而灵活的方法。 有关 DiffGram 格式的详细信息,请参阅Diffgram。
下面的示例演示如何创建 XML Web 服务和使用客户端数据集传输关系数据 (包括修改后的数据) 并解决任何更新回原始数据源。
Note: 我们建议你在创建 XML Web services 时,应始终考虑到安全问题。 有关保护的 XML Web 服务的信息,请参阅保护 ASP.NET XML Web Services 创建使用。
创建返回和使用 DataSet 的 XML Web services
-
创建 XML Web services。
在示例中,XML Web 服务创建返回数据,在此情况下从客户列表Northwind数据库,并接收数据集与更新数据,该 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会编写方法来捕获开放式并发冲突。 为了简单起见,以上示例没有包含此方法。 有关开放式并发的详细信息,请参阅乐观并发。
-
创建 XML Web services 代理。
XML Web services 的客户端将需要通过 SOAP 代理来使用公开的方法。 可以使用 Visual Studio 生成此代理。 通过从 Visual Studio 中设置对现有 Web 服务的 Web 引用,此步骤中所述的所有行为均将透明地发生。 如果要自己创建代理类,请继续阅读本讨论。 但是,在大多数情况下,使用 Visual Studio 足以为客户端应用程序创建代理类。
代理可以使用 Web 服务描述语言工具来创建。 例如,如果 XML Web 服务的 URL 公开
http://myserver/data/DataSetSample.asmx,发出的命令如下所示,若要使用的命名空间中创建的 Visual Basic.NET 代理WebData.DSSample并将其存储在文件 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 -
创建 XML Web services 客户端。
如果你想要使用 Visual Studio 为你生成 Web 服务代理类,只需创建客户端项目中,并且,在解决方案资源管理器窗口中,右键单击项目,单击添加 Web 引用,并选择从 Web 服务(这可能需要提供的 Web 服务终结点地址,如果 Web 服务不可用当前解决方案中或在当前计算机上。) 的可用 Web 服务的列表如果自己创建 XML Web services 代理(按照前面的步骤所述),可以将其导入客户端代码并使用 XML Web services 方法。 下面的示例代码导入代理库,调用GetCustomers若要获取的客户,列表中添加新客户,然后返回数据集的更新的UpdateCustomers.
请注意,该示例将数据集返回的DataSet.GetChanges到UpdateCustomers因为修改的行需要传递给UpdateCustomers。 UpdateCustomers返回已解析数据集,然后,您可以合并到现有数据集合并的已解析的更改和任何从更新的行错误信息。 以下代码假定您已经使用 Visual Studio 创建的 Web 引用,并且你已重命名为 DsSample 中的 Web 引用添加 Web 引用对话框。
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 Classusing 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
- 数据集、数据表和数据视图
- 数据表
- 从 DataAdapter 填充数据集
- 使用 DataAdapter 更新数据源
- DataAdapter 参数
- Web 服务描述语言工具 (Wsdl.exe)
- ADO.NET 托管提供程序和数据集开发人员中心
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
