为开发者使用创建与 Conan 无关的依赖项部署

使用 full_deploy 部署器,可以创建依赖项的与 Conan 无关的副本,开发者甚至无需在他们的计算机上安装 Conan 即可使用。

对于大多数情况,常见且推荐的流程是直接从 Conan 缓存中使用 Conan 包。

../../../../_images/packages_from_cache.png

但是,在某些情况下,能够将依赖项的副本部署到用户文件夹中可能很有用,以便依赖项可以位于那里而不是 Conan 缓存中。这可以使用 Conan 部署器来实现。

让我们来看一个例子。所有源代码都位于 examples2.0 Github 存储库

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/examples/extensions/deployers/development_deploy

在文件夹中,我们可以找到以下 conanfile.txt 文件。

[requires]
zlib/1.2.13

[tool_requires]
cmake/3.25.3

[generators]
CMakeDeps
CMakeToolchain

[layout]
cmake_layout

该文件夹还包含一个标准的 CMakeLists.txt 和一个 main.cpp 源文件,可以创建一个与 zlib 库链接的可执行文件。

我们可以安装 Debug 和 Release 依赖项,并使用以下命令部署包的本地副本:

$ conan install . --deployer=full_deploy --build=missing
$ conan install . --deployer=full_deploy -s build_type=Debug --build=missing

这将创建以下文件夹:

├──src
├──build
│   ├──generators
|         └── ZLibConfig.cmake
├──full_deploy
│   ├──build
│   │   └──cmake
│   │       └──3.25.3
│   │           └──x86_64
│   │               ├──bin
│   │
│   └──host
│       └──zlib
│           └──1.2.13
│               ├──Debug
│               │   └──x86_64
│               │       ├──include
│               │       ├──lib
│               └──Release
│                   └──x86_64
│                       ├──include
│                       ├──lib

(请注意,您可以使用 --deployer-folder 参数更改部署器的基本文件夹输出路径。)

此文件夹是完全独立的。它包含必要的工具(如 cmake 可执行文件)、zlib 的头文件和编译后的库以及必要的文件夹,例如 build/generators 文件夹中的 ZLibConfig.cmake,这些文件使用相对路径指向 full_deploy 中的二进制文件。

../../../../_images/independent_dependencies_deploy.png

可以删除 Conan 缓存,甚至卸载 Conan,然后可以将该文件夹移动到计算机中的其他位置或复制到另一台计算机,假设它具有相同的操作系统、编译器等配置。

$ cd ..
$ cp -R development_deploy /some/other/place
$ cd /some/other/place

开发者可以使用以下方式使用这些文件:

Windows
$ cd build
# Activate the environment to use CMake 3.25
$ generators\conanbuild.bat
$ cmake --version
cmake version 3.25.3
# Configure, should match the settings used at install
$ cmake .. -G \"Visual Studio 17 2022\" -DCMAKE_TOOLCHAIN_FILE=generators/conan_toolchain.cmake
$ cmake --build . --config Release
$ Release\compressor.exe
ZLIB VERSION: 1.2.13

Linux 和 OSX 中的环境脚本不可重定位,因为它们包含绝对路径,并且 sh shell 无法为源文件提供对当前脚本目录的访问权限

这应该不是一个很大的障碍,因为可以在生成器文件夹中使用 sed 进行“搜索和替换”来解决它。

Linux
$ cd build/Release/generators
# Fix folders in Linux
$ sed -i 's,{old_folder},{new_folder},g' *
# Fix folders in MacOS
$ sed -i '' 's,{old_folder},{new_folder},g' *
$ source conanbuild.sh
$ cd ..
$ cmake --version
cmake version 3.25.3
$ cmake ../.. -DCMAKE_TOOLCHAIN_FILE=generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release
$ cmake --build .
$ ./compressor
ZLIB VERSION: 1.2.13

注意

最佳实践

此流程是可行的,但这并不意味着它在大多数情况下都是推荐的。它有一些局限性。

  • 效率较低,需要额外复制依赖项。

  • 目前只有 CMakeDepsCMakeToolchain 是可重定位的。对于其他构建系统集成,请在 Github 上创建工单。

  • Linux 和 OSX shell 脚本不可重定位,需要手动使用 sed

  • 二进制文件的可变性仅限于 Release/Debug。生成的仅适用于当前配置,更改任何其他设置(操作系统、编译器、体系结构)都需要不同的部署。

通常情况下,建议使用缓存。这种“可重定位开发部署”可能适用于将看起来像 SDK 的最终产品分发给不使用 Conan 的项目的使用者。