部署器

部署器是一种方便将文件从一个文件夹(通常是 Conan 缓存)复制到用户文件夹的机制。虽然 Conan 提供了两个内置的部署器(full_deploydirect_deploy),但用户可以使用 conan config install 轻松管理自己的部署器。

部署器在生成器之前运行,并且可以更改目标文件夹。例如,如果 --deployer=full_deploy 部署器在 CMakeDeps 之前运行,那么 CMakeDeps 生成的文件将指向由 full_deploy 部署器完成的用户文件夹中的本地副本,而不是 Conan 缓存。可以通过提供多个 --deployer= 参数来指定多个部署器,它们将按出现的顺序运行。

部署器可以是多配置的。针对不同的配置文件重复运行 conan install . --deployer=full_deploy 可以实现一个完全自包含的项目,包括所有工件、二进制文件和构建文件。这个项目将完全独立于 Conan,并且在构建时不再需要它。使用 --deployer-folder 参数可以根据需要更改部署器的基础输出路径。

内置部署器

警告

内置部署器处于预览阶段。有关更多信息,请参阅 Conan 稳定性 部分。

full_deploy

将每个依赖项的每个包文件夹部署到您的 recipe 的 output_folder 中的子文件夹树中,该树基于

  1. 构建上下文

  2. 依赖项名称和版本

  3. 构建类型

  4. 构建架构

然后每个依赖项将最终位于如下文件夹中

[OUTPUT_FOLDER]/full_deploy/host/dep/0.1/Release/x86_64

有关 full_deploy 部署器用法的完整示例,请参阅 为开发者使用创建 Conan 无关的依赖项部署

direct_deploy

full_deploy 相同,但只处理您的 recipe 的直接依赖项。此部署器将您的依赖项输出到如下树形文件夹中

[OUTPUT_FOLDER]/direct_deploy/dep

runtime_deploy

Conan 2.5.0 起新增

将所有共享库和可执行文件(如 .so、.dll 或 .dylib 文件)从依赖项复制到一个扁平的目录结构中。

自 Conan 2.20.0 起,子目录被维护并保持原样。只有通过 cpp_info.bindirscpp_info.libdirs 配置正确指定的文件才包含在环境生成器中。

配置

full_deploydirect_deployruntime_deploy 了解当 conf tools.deployer:symlinks 设置为 False 时禁用部署器复制符号链接。这在不支持符号链接的系统上可能很方便,如果部署包含符号链接的包,可能会失败。

自定义部署器

自定义部署器可以通过 conan config install 进行管理。在查找特定部署器时,Conan 将按以下顺序在这些位置查找部署器

  1. 绝对路径

  2. 相对于当前工作目录

  3. [CONAN_HOME]/extensions/deployers 文件夹中

  4. 作为内置部署器

Conan 将为每个安装的文件查找要调用的 deploy() 方法。您的自定义部署器的函数签名应如下所示

my_custom_deployer.py
def deploy(graph, output_folder: str, **kwargs):

(请注意,参数作为命名参数传递,因此 graphoutput_folder 名称都是强制性的)

**kwargs 是强制性的,即使未使用,因为将来 Conan 版本中可能会添加新参数,如果未定义 **kwargs,则会导致中断。

您可以使用 graph.root.conanfile 访问您的 conanfile 对象。有关如何遍历其依赖项的信息,请参阅 ConanFile.dependencies。您的自定义部署器现在可以像内置部署器一样调用,使用其所在的文件名,在本例中为 conan install . --deployer=my_custom_deployer。请注意,提供 .py 扩展名是可选的。

有关如何实现自己的部署器的示例,请参阅 自定义部署器 部分。