使用 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 仓库中的钩子文件夹，命令如下：

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

该钩子实现为后置包钩子，这意味着它将在通过配方（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

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

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

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

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

注意

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

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