通过

自定义虚拟表数据供应商

使用 Microsoft Dataverse 数据 SDK，.NET 开发人员可以选择创建自定义虚拟表数据提供程序，以帮助集成现有数据提供程序不支持的外部数据源类型。 每个数据提供程序都由一组可重用的 Dataverse 插件组成，这些插件实现支持的 CRUD 操作。 对于每个虚拟表（也称为虚拟实体），开发人员可以创建插件并为每个 创建、更新、检索、批量检索 和 删除 操作注册它们。 本部分提供有关数据提供程序和开发自定义提供程序的方法的基本信息，包括示例代码。

注释

作为创建自定义数据源提供程序的替代方法，应考虑根据现有数据提供程序调整数据源。 例如，如果创建外部数据源的 OData v4 接口，则可以使用提供的标准 OData v4 数据提供程序直接访问它，该提供程序也支持 CRUD 操作。 添加此 REST 接口的机制因基础数据服务技术而异，例如，WCF 数据服务 4.5。 OData 具有广泛的行业支持，提供广泛的专用工具和兼容技术。

先决条件

自定义数据提供程序需要大量的开发资源来创建和维护。 您必须具备以下方面的基础知识：

该 Microsoft.Xrm.Sdk.Data.dll 程序集以 NuGet 包的形式提供： Microsoft.CrmSdk.Data

提供程序类别

可以使用虚拟表数据 SDK 程序集创建两种常规类别的数据提供程序：通用或目标。 下表描述了这些方法，并将其与最适合该方法的数据提供程序开发模型匹配。

类别 开发模型 说明
常规 “裸机”提供程序 这些提供程序可以灵活地将 FetchXML 查询表达式转换为外部数据源的关联请求，然后返回生成的记录。 可以将此类提供程序重新用于此数据源类型的所有实例。 这种方法最通用，但开发起来更为复杂。 若数据源模式变更，仅需重新映射受影响的虚拟表。
目标 已知架构的 LINQ 提供程序 此类提供程序仅将查询狭义地转换为对已知的现有数据源实例的关联 LINQ 调用。 数据源必须是 LINQ 提供程序，如主题为 LINQ 查询启用数据源中所述。 此方法仅限于特定的数据源实例，但需要的编码工作要少得多。 如果数据源的架构发生更改，必须更新并重新构建数据提供程序。

标准 OData v4 数据提供程序和 Azure Cosmos DB 数据提供程序是泛型提供程序的示例。

使用自定义数据提供程序的步骤

创建可导入 Dataverse 应用程序的虚拟表数据提供程序解决方案需要执行几个步骤：

  1. 开发自定义数据提供程序插件 DLL（或 DLL 集）。
  2. 使用插件注册工具（PRT）向 Dataverse 服务注册自定义数据提供程序。
  3. 创建数据提供程序解决方案。
  4. 自定义数据源表以反映数据类型或特定实例。
  5. 导出自定义数据提供程序解决方案。

更多信息：示例：带 CRUD 操作的自定义虚拟表提供程序

插件开发

由于虚拟表支持 CRUD 操作，因此您将以在 创建、更新、检索、检索多个 和 删除 事件上注册的插件的形式编写数据提供程序。 每个相应的事件将在描述要返回的数据类型的执行上下文中包含信息。

Event 执行上下文
取回 描述需检索的表、列及相关关联表。
RetrieveMultiple 包含定义 QueryExpression 查询的对象。 框架包含 QueryExpressionVisitor 类，用于在检查查询表达式树的不同部分。

对于这两项活动，您必须：

  1. 将执行上下文中的相应信息转换为适用于外部数据源的查询。
  2. 从外部系统检索数据。
  3. 对于 Retrieve，请将数据转换为 Entity；否则，对于 RetrieveMultiple，将其转换为 EntityCollection。 此结果通过 Dataverse 平台返回给执行查询的用户。

命名空间中的 Microsoft.Xrm.Sdk.Data 类提供一个框架，以帮助将 Dataverse 查询信息从执行上下文映射到适合外部数据源的格式的查询。 此框架将帮助你将返回的数据转换为 Dataverse 平台所需的适当 Entity 或 EntityCollection 类型。

数据提供程序异常

如果由于任何原因，您的代码无法达到预期的结果，则必须引发相应的错误。 命名空间 Microsoft.Xrm.Sdk.Data.Exceptions 包含以下派生自 SdkExceptionBase的异常类，可用于此目的：

异常类 说明
AuthenticationException 对外部数据源服务进行安全身份验证期间出错；例如，从外部数据服务收到的 HTTP 状态 401。 通常由于当前用户没有适当的权限，或者关联的 EntityDataSource 中的连接信息不正确而发生。
EndpointException 数据源表中的终结点配置无效或终结点不存在。
GenericDataAccessException 错误不映射到更特定的异常时使用的常规数据访问错误。
InvalidMetadataException
InvalidQueryException 指定的查询无效；例如，它是无效的子句组合或不支持的比较运算符。
ObjectNotFoundException 外部数据源中的指定记录不存在。
TimeoutException 外部操作未在允许时间内完成；例如外部数据服务返回 HTTP 状态码 408。

插件注册

与普通插件不同，你只会使用插件注册工具（PRT）为每个事件注册程序集和插件。 您将不会记录特定步骤。 您的插件将在第 30 阶段运行——该阶段是操作的核心事务处理阶段，普通插件步骤无法在此阶段执行。 与其注册步骤，不如使用下表来配置你的数据提供程序。

表 说明
EntityDataProvider 定义要用于每个事件的插件和数据源的逻辑名称。

配置虚拟表的定义后，将使用 PRT 注册插件，并在 EntityDataProvider 表中设置正确的配置数据，虚拟表将开始响应请求。

详细信息： 创建数据提供程序并将插件添加到提供程序

调试插件

自定义虚拟表提供程序是一种插件。 使用这些主题中的信息调试自定义虚拟表提供程序的插件：调试插件 和 教程：插件调试指南。

另请参阅

虚拟表入门
虚拟表的 API 注意事项
示例：通用虚拟表数据提供程序插件