部署器¶

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

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

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

内置部署器¶

full_deploy¶

将每个依赖项的每个包文件夹部署到 recipe 的 output_folder 中，基于以下子文件夹树：

构建上下文
依赖项名称和版本
构建类型
构建架构

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

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

有关使用 full_deploy 部署器的完整示例，请参阅创建用于开发人员使用的 Conan 不可知依赖项部署。

direct_deploy¶

与 full_deploy 相同，但仅处理 recipe 的直接依赖项。此部署器将在如下树文件夹中输出依赖项：

[OUTPUT_FOLDER]/direct_deploy/dep

警告

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

配置¶

当 conf tools.deployer:symlinks 设置为 False 时，full_deploy 和 direct_deploy 都理解禁用部署器复制符号链接。这在不支持符号链接的系统中可能很方便，如果部署包含符号链接的包，则可能会失败。

自定义部署器¶

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

绝对路径
相对于 cwd
在 [CONAN_HOME]/extensions/deployers 文件夹中
作为内置部署器

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

my_custom_deployer.py¶

def deploy(graph, output_folder: str, **kwargs):

(请注意，参数是作为命名参数传递的，因此 graph 和 output_folder 名称都是必需的)

即使未使用 **kwargs，它也是必需的，因为将来 Conan 版本可能会添加新参数，如果未定义 **kwargs，这些参数将会中断。

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

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