开放式数据协议 (OData) ,可创建数据服务,以便客户端可以作为基于数据模型的资源使用 Uri 访问数据。 OData 还支持服务操作的定义。 这些数据服务在初始部署之后,可能出于多种原因(例如,更改业务需求、信息技术需求,或者为了解决其他问题)而需要更改,并且在其生存期期间可能需要更改多次。 更改现有数据服务时,您必须考虑是否要定义您的数据服务的新版本以及如何将对现有客户端应用程序的影响降至最低。 本主题提供了有关何时以及如何创建一个新版本的数据服务的指导。 它还介绍了 WCF 数据服务如何处理客户端和数据服务支持 OData 协议的不同版本之间的交换。
WCF 数据服务版本管理
一旦部署数据服务和使用数据,对数据服务的更改有可能导致与现有客户端应用程序的兼容性问题。 但是,因为服务的整体业务需求而经常需要进行更改,您必须考虑何时以及如何创建一个新的数据服务版本,以最大程度减小对客户端上应用程序的影响。
建议发布新的数据服务版本的数据模型更改
在考虑是否要发布数据服务的新版本时,了解不同种类的更改如何影响客户端应用程序很重要。 可能要求您创建一个新版本的数据服务的数据服务更改可分为以下两个类别:
-
对服务协定的更改 — 它包括对服务操作的更新、对实体集(源)的可访问性的更改或对服务行为的其他更改。
-
对数据协定的更改 — 它包括对数据模型、源格式或源自定义的更改。
下表详细说明出现哪类更改时您应考虑发布新版本的数据服务:
| 更改类型 | 需要新版本 | 不需要新版本 |
|---|---|---|
| 服务操作 | -添加新的参数更改返回类型-删除服务操作 | -删除现有参数-添加新的服务操作 |
| 服务行为 | -禁用计数请求-禁用投影支持-增加所需的数据服务版本 | -启用计数请求-启用投影支持-减少所需的数据服务版本 |
| 实体集权限 | -限制实体集权限-更改响应代码 (新第一个数字值) <sup>1</sup> | -放宽实体集权限-更改响应代码 (相同第一个数字值) |
| 实体属性 | -删除现有属性或关系添加不可为 null 的属性-更改现有属性 | 添加可为 null 属性<sup>2</sup> |
| 实体集 | -删除实体集 | 添加派生的类型-将基类型添加实体集 |
| 源自定义 | 更改实体属性映射 |
<sup>1</sup>这可能取决于客户端应用程序依赖于接收的特定错误代码的严格程度。
<sup>2</sup>可以设置xref:System.Data.Services.Client.DataServiceContext.IgnoreMissingProperties*属性设置为true让客户端忽略数据服务发送的客户端未定义任何新属性。 但是,当插入时,客户端在 POST 请求中不包括的属性都设置为其默认值。 对于更新,对客户端未知的属性中任何现有数据可能用默认值改写。 在此情况下,应将更新作为 MERGE 要求发送,这是默认值。 有关详细信息,请参阅管理数据服务上下文。
如何对数据服务进行版本管理
在需要时,通过创建新服务实例(使用更新的服务协定或数据模型)定义新的数据服务版本。 通过使用新的 URI 终结点(使其与以前的版本不同)公开该新服务。 例如:
-
旧版本:
http://services.odata.org/Northwind/v1/Northwind.svc/ -
新版本:
http://services.odata.org/Northwind/v2/Northwind.svc/
升级数据服务时,客户端将需要也更新(基于新的数据服务的元数据)并使用新的根 URI。 如果可能,您应维护以前版本的数据服务以支持尚未升级、无法使用新版本的客户端。 在不再需要时,可以删除旧版本的数据服务。 您应该考虑在外部配置文件中维护数据服务终结点 URI。
OData 协议版本
OData 的新版本的发布,客户端应用程序可能不使用相同版本的数据服务支持 OData 协议。 较旧的客户端应用程序可能会访问数据服务支持 OData 的较新版本。 客户端应用程序也可能使用 WCF 数据服务客户端库,该库支持 OData 的较新版本,比正在访问的数据服务的较新版本。
WCF 数据服务将利用 OData 来处理此类版本控制方案提供的支持。 此外,还有支持生成和使用数据模型元数据创建客户端数据服务类时客户端使用的版本不同的 OData 数据服务使用。 有关详细信息,请参阅OData:协议版本控制。
版本协商
数据服务可以配置为定义的服务,而不考虑客户端请求的版本将使用 OData 协议的最高版本。 您可以执行此操作通过指定xref:System.Data.Services.Common.DataServiceProtocolVersion值xref:System.Data.Services.DataServiceBehavior.MaxProtocolVersion*属性的xref:System.Data.Services.DataServiceBehavior由数据服务。 有关详细信息,请参阅数据服务配置。
当应用程序使用 WCF 数据服务客户端库来访问数据服务时,库自动设置这些标头为正确的值,具体取决于 OData 和应用程序中使用的功能的版本。 默认情况下,WCF 数据服务使用支持请求的操作的最低协议版本。
下表详细说明包括 WCF 数据服务版本的.NET Framework 和 Silverlight 支持的特定版本的 OData 协议。
| OData 协议版本 | 支持引入方式 |
|---|---|
| 1 版 | - .NET Framework 版本 3.5 Service Pack 1 (SP1)Silverlight 版本 3 |
| 2 版 | - .NET Framework 版本 4-对更新.NET Framework 版本 3.5SP1。 您可以下载和安装从更新Microsoft Download Center。Silverlight 版本 4 |
| 3 版 | -你可以下载并安装支持从 OData 版本 3 的预发行版本Microsoft Download Center。 |
元数据版本
默认情况下,WCF 数据服务使用 1.1 版的 CSDL 表示数据模型。 对于基于反射提供程序或自定义数据服务提供程序的数据模型始终如此。 但是,如果数据模型是使用Entity Framework定义的,则返回的 CSDL 版本就是该Entity Framework所用的版本。 CSDL 的版本由的命名空间架构元素 (CSDL)。
返回的元数据的 DataServices 元素还包含一个 DataServiceVersion 特性,该特性的值与响应消息中 DataServiceVersion 标头的值相同。 客户端应用程序,如添加服务引用对话框在 Visual Studio 中,使用此信息来生成正确使用承载数据服务的 WCF 数据服务的版本的客户端数据服务类。 有关详细信息,请参阅OData:协议版本控制。
请参阅
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站展开固定版本仓库内的引用内容,将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
