使用 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。

在这种情况下，原始构建文件都存在，因此调试器像往常一样工作。接下来我们将看到从 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）。
执行钩子，将 PDB 从构建文件夹复制到包中每个 DLL 旁边。

该钩子利用了 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 缺少源文件，因此它无法像最初那样调试这些文件。

定位调试器的源路径¶

删除原始构建文件后，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 中设置它，以便调试器可以找到源文件。右键单击解决方案资源管理器中的解决方案并选择属性。转到“通用属性”部分中的“调试源文件”并添加我们的源路径。

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

注意

如果源文件有补丁，我们将无法调试修改后的文件，因为我们使用的是源文件夹中的文件，补丁是在构建文件夹中编译之前在后续步骤中应用的。

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