通过

生成、部署和调试自定义对象

  • 项目

适用于：Azure 数据工厂中的 SQL Server SSIS Integration Runtime

在为 Integration Services 的自定义对象编写代码后，必须生成和部署程序集，并将该程序集集成到 SSIS 设计器中，使其可在包中使用，然后对其进行测试和调试。

生成、部署和调试 Integration Services 自定义对象的步骤

您已编写了对象的自定义功能代码。 现在必须对所编写的代码进行测试，使其可供用户使用。 对于可为 Integration Services 创建的所有类型的自定义对象，步骤都非常相似。

下面是生成、部署和测试的步骤。

  1. 使用强名称为要生成的程序集签名。

  2. 生成程序集。

  3. 通过将程序集移动到或复制到适当的 Integration Services 文件夹来部署该程序集。

  4. 在全局程序集缓存 (GAC) 中安装该程序集。

    此对象自动添加到工具箱中。

  5. 如有必要，对部署进行故障排除。

  6. 测试并调试代码。

现在可以在 SQL Server Data Tools (SSDT) 中使用 SSIS 设计器来创建、维护和运行面向不同版本的 SQL Server 的包。 有关此改进对自定义扩展的影响的详细信息，请参阅使 SSIS 自定义扩展插件获得用于 SQL Server 2016 的 SSDT 2015 多版本的支持

为程序集签名

若要共享程序集，必须将其安装在全局程序集缓存中。 程序集被添加到全局程序集缓存之后，可以由 SQL Server Data Tools (SSDT) 这样的应用程序使用。 全局程序集缓存要求必须使用强名称为程序集进行签名，这样可保证程序集是全局唯一的。 强名称程序集有一个完全限定的名称，由程序集的名称、区域性、公钥及版本号组成。 运行库使用这些信息来定位程序集并将其与其他同名的程序集区分开。

若要使用强名称为程序集签名，必须首先具有或创建公钥/私钥对。 这一对加密公钥和加密私钥用于在生成时创建强名称程序集。

有关强名称的详细信息和为程序集签名所必须遵循的步骤，请参阅 .NET Framework SDK 文档中的下列主题：

  • 强名称程序集

  • 创建密钥对

  • 使用强名称为程序集签名

在生成时，可以轻松在 Visual Studio 中使用强名称为程序集签名。 在“项目属性”对话框中，选择“签名”选项卡。选择“为程序集签名”的选项，然后提供密钥文件 (.snk) 的路径。

生成程序集

为项目签名后，必须使用 SQL Server Data Tools 的“生成”菜单上可用的命令来生成或重新生成项目或解决方案。 您的解决方案可能包含单独的自定义用户界面项目，该项目也必须使用强名称签名，并且可以同时生成。

执行下两个步骤（部署程序集并将其安装在全局程序集缓存中）的最简便方法是将这些步骤编写为 Visual Studio 中的生成后事件。 Visual Basic 项目的项目属性的“编译”页和 C# 项目的“生成事件”页都提供可用的生成事件。 命令提示实用工具（如 gacutil.exe）需要完整路径。 包含空格的路径和展开为包含空格的路径的宏（如 $(TargetPath)）的前后都需要引号。

下面是自定义日志提供程序的生成后事件命令行的示例：

"C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin\NETFX 4.0 Tools\gacutil.exe" -u $(TargetName)  
"C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin\NETFX 4.0 Tools\gacutil.exe" -i $(TargetFileName)  
copy $(TargetFileName) "C:\Program Files\Microsoft SQL Server\130\DTS\LogProviders "

部署程序集

SSIS 设计器对安装 SQL Server Integration Services 时创建的一系列文件夹中的文件进行枚举，从而查找可在包中使用的自定义对象。 使用默认的 SQL Server 安装设置时，这一组文件夹位于 C:\Program Files\Microsoft SQL Server\130\DTS 下。 但是，如果为自定义对象创建安装程序，应检查 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\130\SSIS\Setup\DtsPath 注册表项的值，以验证此文件夹的位置。

注意

有关如何部署自定义组件以实现与 SQL Server Data Tools 中多版本支持之间的良好协作的详细信息，请参阅使 SSIS 自定义扩展插件获得 SQL Server 2016 的 SSDT 2015 多版本支持的支持。

可以通过下面两种方式将程序集放入文件夹中：

  • 在生成已编译的程序集后，将其移动或复制到相应的文件夹中。 （为方便起见，可以在生成后事件中包含复制命令。）

  • 直接在相应的文件夹中生成程序集。

C:\Program Files\Microsoft SQL Server\130\DTS 下的下列部署文件夹用于不同类型的自定义对象：

自定义对象 部署文件夹
任务 任务
“ODBC 源编辑器” 连接
日志提供程序 LogProviders
数据流组件 PipelineComponents

注意

将程序集复制到这些文件夹中即可支持可用任务、连接管理器等的枚举。 因此，您不一定要将只包含用于自定义对象的自定义用户界面的程序集部署到这些文件夹中。

在全局程序集缓存中安装程序集

若要将任务程序集安装到全局程序集缓存 (GAC) 中，请使用命令行工具 gacutil.exe，或将程序集拖至 %system%\assembly 目录中。 为方便起见，还可以在生成事件后中调用 gacutil.exe。

下面的命令使用 gacutil.exe 将名为 MyTask.dll 的组件安装到 GAC 中。

gacutil /iF MyTask.dll

在安装新版本的自定义对象后，必须先关闭再重新打开 SSIS 设计器。 如果已在全局程序集缓存中安装了早期版本的自定义对象，必须先删除这些对象再安装新版本。 若要卸载程序集，请运行 gacutil.exe 并在 /u 选项中指定程序集名称。

有关全局程序集缓存的详细信息，请参阅“.NET Framework 工具”中的“全局程序集缓存工具 (Gactutil.exe)”。

排除部署故障

如果自定义对象显示在“工具箱”或可用对象列表中，但无法将其添加到包中，可以尝试以下操作：

  1. 在全局程序集缓存中查找该组件是否有多个版本。 如果全局程序集缓存中存在该组件的多个版本，则设计器可能无法加载该组件。 请删除全局程序集缓存中该程序集的所有实例，然后重新添加该程序集。

  2. 请确保部署文件夹中只存在一个程序集实例。

  3. 刷新工具箱。

  4. 将 Visual Studio 附加到 devenv.exe，然后设置一个断点以单步执行初始化代码，确保不会发生异常。

测试并调试代码

若要调试自定义对象的运行时方法，最简单的方法是在生成自定义对象后从 Visual Studio 启动 dtexec.exe，然后运行使用该组件的包。

若要调试组件的设计时方法（如 Validate 方法），请在第二个 Visual Studio, 实例中打开使用该组件的包，并附加到该实例的 devenv.exe 进程。

如果还希望在包已打开并在 SSIS 设计器中运行时调试组件的运行时方法，必须在包的执行过程中强制暂停，以便还能够附加到 DtsDebugHost.exe 进程。

通过附加到 dtexec.exe 来调试对象的运行时方法

  1. 在调试配置中，按照本主题中的说明签名和生成项目，进行部署，然后安装到全局程序集缓存中。

  2. 在“项目属性”的“调试”选项卡中，为“启动操作”选择“启动外部程序”，然后查找 dtexec.exe，默认情况下它安装在 C:\Program Files\Microsoft SQL Server\130\DTS\Binn 中。

  3. 在“启动选项”下的“命令行选项”文本框中，输入运行使用了组件的包所需的命令行参数。 通常，命令行参数包含 /F[ILE] 开关，后跟 .dtsx 文件的路径和文件名。 有关详细信息，请参阅 dtexec Utility。

  4. 在组件的运行时方法源代码中根据需要设置断点。

  5. 运行您的项目。

通过附加到 SQL Server Data Tools 来调试自定义对象的设计时方法

  1. 在调试配置中，按照本主题中的说明签名和生成项目，进行部署，然后安装到全局程序集缓存中。

  2. 在自定义对象的设计时方法源代码中根据需要设置断点。

  3. 打开第二个 Visual Studio 实例，并加载使用自定义对象的包所在的 Integration Services 项目。

  4. 从 Visual Studio 的第一个实例，附加到 devenv.exe 的第二个实例，其中包是通过从第一个实例的“调试”菜单选择“附加到进程”加载的。

  5. 从第二个 Visual Studio 实例运行包。

通过附加到 SQL Server Data Tools 来调试自定义对象的运行时方法

  1. 完成上述过程中列出的步骤之后，在执行包时强制暂停，以便可附加到 DtsDebugHost.exe 中。 强制暂停的方法是：将断点添加到 OnPreExecute 事件，或将脚本任务添加到项目并输入用于显示模式消息框的脚本。

  2. 运行包。 出现暂停时，切换到已在其中打开代码项目的 Visual Studio 实例，并从“调试”菜单中选择“附加到进程”。 请确保附加到在“类型”列中列为“托管，x86”的 DtsDebugHost.exe 实例，而不是只列为 x86 的实例。

  3. 返回到暂停的包，并继续通过断点，或单击“确定”来关闭脚本任务引发的消息框，并继续包的执行和调试。

另请参阅

开发 Integration Services 的自定义对象
使自定义对象持久化
包开发的疑难解答工具