visual_studio_logo Visual Studio

Visual Studio 的配方工具

Conan 提供了多种工具,可帮助您使用 Microsoft Visual Studio 管理项目。这些工具可以从 conan.tools.microsoft 导入,并允许与 Microsoft Visual Studio 进行原生集成,无需使用 CMake,而是直接使用 Visual Studio 解决方案、项目和属性文件。最相关的工具有:

  • MSBuildDeps:Microsoft MSBuild 构建系统的依赖信息生成器。它将生成多个 xxxx.props 属性文件,每个包的每个依赖项一个,供使用 MSBuild 或 Visual Studio 的使用者使用,只需将生成的属性文件添加到解决方案和项目中即可。

  • MSBuildToolchain:MSBuild 的工具链生成器。它将生成可添加到 Visual Studio 解决方案项目的 MSBuild 属性文件。此生成器将当前包配置、设置和选项转换为 MSBuild 属性文件语法。

  • MSBuild 构建助手是 MSBuild 命令行调用的包装器。它将诸如 msbuild "MyProject.sln" /p:Configuration=<conf> /p:Platform=<platform> 等调用抽象为 Python 方法调用。

有关 conan.tools.microsoft 下所有工具的完整列表,请查看参考部分。

Visual Studio 的 Conan 扩展

有一个扩展可在 VisualStudio Marketplace 中获取,与 Visual Studio 2022 版本及更高版本兼容。使用此扩展,您可以浏览 Conan Center 中可用的 Conan 包,将它们添加到您的项目,并且它们将在构建项目之前自动安装。

注意

此 Visual Studio 扩展仅兼容基于 MSBuild 的 C/C++ 项目。它不适用于基于 CMake 的项目或使用其他技术的项目。对于基于 CMake 的项目,请参考 cmake-conan 依赖项提供程序

安装

Conan Visual Studio 扩展可以直接在 Visual Studio 中安装

  • 打开“扩展”菜单。

  • 选择“管理扩展”。

  • 在在线市场中搜索“Conan”。

  • 下载并安装该扩展。

或者,您可以从我们的发布页面下载最新版本并手动安装。

初始配置

安装 Conan 扩展后,您可以从 Visual Studio 中的“Conan”工具窗口访问它。为此,请导航到 视图 > 其他窗口 > Conan C/C++ 包管理器

Initial configuration

最初,您需要配置该扩展将使用的 Conan 可执行文件。通过点击扩展窗口中的配置按钮(齿轮图标),您可以设置 Conan 客户端可执行文件的路径。您可以指定自定义路径,或选择使用系统级安装的 Conan 客户端。

Select Conan executable

配置好 Conan 客户端后,该扩展即可使用,您可以开始向项目添加库了。

搜索和添加库

配置完成后,Conan 工具窗口中的库列表将变为活动状态,您可以使用搜索栏搜索 Conan 包。选择一个库将允许您查看其详细信息,包括可用版本和集成选项。

Search for Conan packages

如果您现在点击 添加要求 按钮,该扩展会将 conanfile.pyconandata.yml 添加到您的项目,其中包含安装所选 Conan 包所需的信息。它还会为项目添加一个预构建事件,以便在下次编译项目时安装这些库。

在任何时候,您还可以使用刷新按钮(圆形箭头图标)来更新 Conan Center 中可用包的列表。

现在,如果您启动项目的构建过程,预构建事件将触发 Conan 安装包并将必要的属性注入到项目中,从而使 Visual Studio 能够编译并链接这些库。

Build project with Conan packages

警告

如果 Visual Studio 没有足够的时间处理注入的属性,首次编译可能会失败。如果发生这种情况,只需重新构建项目,它就应该能够成功构建。

有关 Conan Visual Studio 扩展的更深入介绍和实际示例,请查看 Conan 博客中的此示例

另请参阅