使用 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_ 开头即可。

该钩子被实现为后打包钩子（post-package hook），这意味着它将在通过配方（recipe）的 package() 方法创建包之后执行。这避免了任何潜在问题，因为执行顺序将如下所示：

配方的 build() 方法被执行，生成 DLL 和 PDB 文件
配方的 package() 方法被执行，将必要的文件复制到包文件夹（在本例中是 DLL，但不包括 PDB 文件）
钩子被执行，将构建文件夹中的 PDB 文件复制到包中每个 DLL 旁边

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

有关 PDB 如何与 Visual Studio 配合工作以及我们如何使用它来创建钩子的更多信息，请参阅钩子 README。

无需构建文件进行调试¶

安装钩子后，我们将再次从源代码创建项目，这样钩子就可以将 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

如果此源路径不存在，我们可以使用配置（config）再次下载源文件。

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

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

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

注意

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

对源文件的任何修改都将不允许对其进行调试，因为 Visual Studio 会进行校验和检查，所以它们必须与库编译时的文件完全相同。