使用 Visual Studio 调试共享库

在前面的示例中，我们讨论了如何在 Visual Studio 中调试依赖项，但在项目中使用 Conan 依赖项时，原始构建文件夹和构建文件可能不存在。默认情况下，Conan 包不包含 Visual Studio 调试库所需的信息，此信息存储在库编译期间生成的 PDB 中。使用 Conan 时，这些 PDB 生成在构建文件夹中，该文件夹仅在构建库期间需要。因此，使用 conan cache clean 清理 Conan 缓存以删除构建文件夹并节省磁盘空间是一种常见操作。

对于构建文件夹不存在的这些情况，我们创建了一个钩子，将构建文件夹中生成的 PDB 复制到包文件夹。此行为不能默认强制执行，因为 PDB 文件通常比整个包都大，并且会大大增加包的大小。

本节将介绍一些在不同情况下调试项目的示例，以展示用户如何利用 PDB 钩子。

创建项目并照常调试

首先，我们将照常调试我们的项目，这在 前面的示例 中有更详细的说明。我们可以像上一节一样从源代码开始构建我们的依赖项，只是这次我们将它们构建为共享库。首先，从 GitHub 上的 examples2 存储库 克隆示例所需的源代码并创建项目。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/consuming_packages/simple_cmake_project
$ conan install . -o="*:shared=True" -s build_type=Debug --build="zlib/*"
...
Install finished successfully

# CMake presets require CMake>=3.23
$ cmake --preset=conan-default

注意

我们只涵盖依赖项构建为共享库的情况，因为 PDB 及其与库的链接方式对于静态库有所不同。

现在，我们可以打开解决方案 compressor.sln 以在 Visual Studio 中打开我们的项目并像前面示例中所述进行调试。在第 22 行设置断点，运行调试器并使用单步进入将允许我们调试依赖项文件 deflate.c 内部。

Debugging with build files in cache

在这种情况下，所有原始构建文件都存在，因此调试器按预期工作。接下来，我们将了解在从 Conan 缓存中删除构建文件后调试器的工作方式。

从 Conan 缓存中删除构建文件

编译依赖项后，可能有多种原因会导致构建文件不存在。我们将使用 conan cache clean 从缓存中清理我们的构建文件来模拟其中一种情况。 --build 标志确保我们只删除构建文件，因为在本示例中我们将需要我们的源文件。

$ conan list "zlib/1.2.11:*"
$ conan cache path --folder build zlib/1.2.11:17b26a16efb893750e4481f98a154db2934ead88
$ conan cache clean zlib/1.2.11 --build
$ conan cache path --folder build zlib/1.2.11:17b26a16efb893750e4481f98a154db2934ead88

在关闭并在 Visual Studio 中重新打开我们的解决方案后，我们可以尝试再次进行调试。如果您尝试单步进入依赖项（断点位于第 22 行），您会注意到它会直接跳到下一行，因为 Visual Studio 没有关于要调试的依赖项的任何信息。

安装钩子以将 PDB 复制到包文件夹

为了解决包文件夹中没有 PDB 的问题，我们创建了一个钩子，将 PDB 从构建文件夹复制到包文件夹。该钩子可在 conan-extensions 存储库 中找到。安装整个存储库可以正常工作，但我们建议仅使用以下命令安装 conan-extensions 存储库中的 hooks 文件夹：

$ conan config install https://github.com/conan-io/conan-extensions.git -sf=extensions/hooks -tf=extensions/hooks

该钩子设计为默认不运行，因为它会显着增加包的大小。如 钩子文档 中所述，我们需要将钩子的名称更改为以 hook_ 开头。要找到钩子放置的路径，请运行命令 conan config home 以查找本地缓存路径，然后转到 extensions/hooks 文件夹以重命名 _hook_copy_pdbs_to_package.py 文件。请注意，每次运行 package() 方法时，此钩子都会运行。要禁用钩子，只需将钩子名称改回以 _hook_ 开头即可。

该钩子实现为一个后打包钩子，这意味着它将在通过配方的 package() 方法创建包后执行。这避免了任何潜在的问题，因为顺序如下：

  • 执行配方的 build() 方法，生成 DLL 和 PDB

  • 执行配方的 package() 方法，将必要的文件复制到包文件夹（在本例中为 DLL，但不是 PDB）

  • 执行钩子，将包中每个 DLL 的 PDB 从构建文件夹复制到其旁边

该钩子使用 Visual Studio 安装中包含的 dumpbin 工具。此工具允许我们获取 DLL 的信息，在本例中是其关联 PDB 所在的路径。它将用于包中的每个 DLL 以查找其 PDB 并将其复制到包文件夹。

有关 PDB 如何与 Visual 一起工作以及我们如何使用它来创建钩子的更多信息，请参阅 钩子自述文件。

无需构建文件进行调试

安装钩子后，我们将再次从源代码创建项目，以便钩子现在可以将 PDB 复制到包文件夹以及包 DLL 旁边，以便调试器可以找到它们。

$ conan install . -o="*:shared=True" -s build_type=Debug --build="zlib/*"
...
zlib/1.2.11: Calling package()
...
[HOOK - hook_copy_pdbs_to_package.py] post_package(): PDBs post package hook running
...
Install finished successfully

# CMake presets require CMake>=3.23
$ cmake --preset=conan-default

请注意，现在运行 conan install 时，您将看到在调用 package() 后运行的钩子输出。为了测试钩子，我们可以再次清理缓存以删除构建文件，这包括用于构建库的源文件以及最初生成的 PDB。

$ conan cache clean zlib/1.2.11 --build

再次在 Visual Studio 中打开解决方案并启动调试器。当您尝试在第 22 行单步进入依赖项时，将弹出一个错误消息，告诉我们未找到该文件，并询问文件的位置。我们可以关闭此窗口，它将提供查看反汇编的选项，这要归功于 PDB 而可以进行调试。PDB 只包含调试信息，但 Visual Studio 缺少源文件，因此它无法像最初那样在这些文件上进行调试。

Debugging without build files in cache

为调试器查找源路径

删除原始构建文件后，Visual Studio 将无法自行找到源文件。为了能够在源文件上进行调试，可以选择手动设置源文件夹路径，以便可以在源文件上进行调试。这要求依赖项的源文件存在。在我们的例子中，我们可以通过运行 `conan cache path 来获取这些源文件的位置。

$ conan cache path --folder source zlib/1.2.11

如果此源路径不存在，我们可以使用配置再次下载源代码。

$ conan install . -o="*:shared=True" -s build_type=Debug -c:a="tools.build:download_source=True"

获得源路径后，我们可以在 Visual Studio 中设置它，以便调试器可以找到源文件。在解决方案资源管理器中右键单击解决方案，然后选择“属性”。转到“通用属性”部分中的“调试源文件”，然后添加我们的源路径。

Setting source path

再次启动调试器将允许像我们在第一个示例中所做的那样单步进入依赖项的代码。

注意

如果源文件有补丁，我们将无法在修改后的文件上进行调试，因为我们使用的是源文件夹中的文件，并且补丁是在稍后的步骤中（正好在构建文件夹中编译之前）应用的。

对源文件的任何修改都将不允许在它们上进行调试，因为 Visual Studio 会执行校验和检查，因此它们需要与编译库时完全相同的文件。