在 Conan 包中 Vendor 依赖项

警告

此功能为实验性功能,可能会有破坏性更改。有关更多信息,请参阅 Conan 稳定性 部分。

从 Conan 2.4 开始,可以创建和使用完全 vendor 其依赖项的 Conan 包,也就是说,它们完全对其使用者隐藏和隔离其依赖项。这在某些不同的情况下可能很有用

  • 当与其他组织共享 Conan 包时,这些组织 vendor(复制、嵌入或链接)依赖项,因此他们的包的使用者不必访问这些依赖项,并且目的是他们始终使用共享的预编译二进制文件。

  • 为了在项目的各个部分之间引入硬解耦。

要使包 vendor 其依赖项,请在其 recipe 中定义以下属性

class MyPkg(ConanFile):
   name = "mypkg"
   version = "0.1"

   vendor = True

   requires = "somedep/1.2"

当我们有这个 recipe 时,我们可以使用正常的 conan create . 创建其二进制文件。但是,当我们使用此包作为其他包的依赖项时,其依赖项将完全不可见。依赖关系图甚至不会展开 somedep/1.2 依赖项。此依赖项甚至不需要在消费者的远程仓库中可用,也不会被检查。

一些重要注意事项

  • vendor 其依赖项的包旨在始终以二进制形式使用。

  • vendor 包的依赖项始终形成完全私有和隔离的依赖关系图,与使用此包的其余依赖关系图解耦。

  • vendor 包及其用户有责任保证 vendor 的依赖项不会冲突。例如,如果一个 vendor 包将 libssl.a 作为静态库 vendor 到其包中,并且依赖关系图中还有另一个包也提供 libssl,则会发生冲突,Conan 无法检测到此冲突,因为 libssl.a 是作为包的内部实现细节 vendor 的,而不是显式建模的。诸如 provides 之类的机制可以用于此目的,但这取决于 recipe 作者来考虑。

  • 定义了 vendor=True 的包的 package_id 完全独立于其依赖项。依赖项版本永远不会影响 vendor 包的 package_id,因此重要的是要注意 vendor 包的版本代表完整的私有依赖关系图。

  • 来自使用者 conanfile.py recipe 的常规 default_options 或选项值定义不会传播到 vendor 包,因为它们甚至不展开其依赖项。

  • 如果 vendor 包的二进制文件丢失和/或用户请求从源码构建此类包,Conan 将失败,并引发错误,提示无法构建它。

  • 要允许展开私有依赖项,可以激活 tools.graph:vendor=build 配置。如果是这种情况,将计算和展开包的私有依赖关系图,并且允许构建该包。