部署器¶
部署器是一种机制,用于方便地将文件从一个文件夹(通常是 Conan 缓存)复制到用户文件夹。虽然 Conan 提供了两个内置的部署器(full_deploy
和 direct_deploy
),但用户可以使用 conan config install
轻松管理自己的部署器。
部署器在生成器之前运行,并且可以更改目标文件夹。例如,如果 --deployer=full_deploy
部署器在 CMakeDeps
之前运行,则 CMakeDeps
生成的文件将指向 full_deploy
部署器在用户文件夹中所做的本地副本,而不是 Conan 缓存。可以通过提供多个 --deployer=
参数来指定多个部署器,它们将按照出现的顺序运行。
部署器可以是多配置的。针对不同的 Profile 重复运行 conan install . --deployer=full_deploy
可以实现完全自包含的项目,包括所有工件、二进制文件和构建文件。这个项目将完全独立于 Conan,并且不再需要 Conan 即可构建。使用 --deployer-folder
参数可以根据需要更改部署器的基本文件夹输出路径。
内置部署器¶
full_deploy¶
将每个依赖项的每个包文件夹部署到配方的 output_folder
中,并按照以下子文件夹树结构组织:
构建上下文
依赖项名称和版本
构建类型
构建架构
然后,每个依赖项将最终位于如下文件夹中:
[OUTPUT_FOLDER]/full_deploy/host/dep/0.1/Release/x86_64
有关 full_deploy
部署器用法的完整示例,请参见 创建用于开发者使用的与 Conan 无关的依赖项部署。
direct_deploy¶
与 full_deploy
相同,但仅处理配方的直接依赖项。此部署器将在如下树形文件夹中输出依赖项:
[OUTPUT_FOLDER]/direct_deploy/dep
警告
内置部署器处于预览状态。有关更多信息,请参见 Conan 稳定性 部分。
配置¶
当配置项 tools.deployer:symlinks
设置为 False
以禁用部署器复制符号链接时,full_deploy
和 direct_deploy
都会理解。这在不支持符号链接的系统中可能很方便,如果部署包含符号链接的包,可能会失败。
自定义部署器¶
自定义部署器可以通过 conan config install
进行管理。当查找特定的部署器时,Conan 将按照以下顺序在这些位置查找部署器:
绝对路径
相对于当前工作目录的路径
在
[CONAN_HOME]/extensions/deployers
文件夹中作为内置部署器
Conan 将查找 deploy()
方法来为每个已安装的文件调用。自定义部署器的函数签名应如下所示:
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 扩展名是可选的。
有关如何实现您自己的部署器的示例,请参见 自定义部署器 部分。