在生产环境中使用 ConanCenter 包

注意

Conan 2.9.2 中的默认远程更新

Conan 版本 2.9.2 开始,默认的远程仓库已更改为 https://center2.conan.io。以前的默认远程仓库 https://center.conan.io 现已冻结,不再接收更新。建议更新您的远程配置以使用新的默认远程仓库,以确保访问最新的配方和包更新(欲了解更多信息,请阅读此文章)。

如果您仍将已弃用的远程仓库配置为默认,请使用以下命令进行更新

conan remote update conancenter --url="https://center2.conan.io"

ConanCenter 是一个绝佳的资源,其中包含社区贡献的超过 1500 个库和应用程序的配方参考实现。因此,它是一个关于如何为开源依赖项创建和构建 Conan 包的优秀知识库。

ConanCenter 还为各种配置构建并提供二进制包:多种操作系统(Windows、Linux、macOS)、编译器、编译器版本和库变体(共享、静态)。最重要的是,对于许多库,社区贡献者确保配方与附加操作系统(Android、iOS、FreeBSD、QNX)和 CPU 架构兼容。Conan Center 中的配方是 Conan 普遍性承诺的最佳例证。

与其他包管理器或仓库不同,ConanCenter 不维护固定版本的快照。相反,对于给定的库(例如 OpenCV),同时维护多个版本。这让用户可以更好地控制使用哪个版本,而不是必须固定在旧版本,或被迫始终使用最新版本。

为了支持这个生态系统,ConanCenter 配方更新非常频繁。配方本身可能会更新以支持新平台、修复错误,或要求其依赖项的较新版本。另一方面,ConanCenter 的每个用户在其需求中可能有不同的版本组合。这意味着,给定相同的输入需求列表,Conan 在不同时间点可能会以不同的方式解析图表——解析为不同的配方修订版、版本或包。这类似于其他语言中包管理器的默认行为(pip/PyPi、npm、cargo 等)。在重视可重现性的生产环境中,因此不鼓励以不受约束的方式直接依赖 Conan Center。

以下指南包含一系列建议,以确保可重复性、可靠性、合规性,以及在适用情况下,对自定义的控制。总而言之,强烈建议在使用 ConanCenter 的包时遵循以下方法:

可重复性和可重现性

如前所述——给定一组需求,ConanCenter 的变化可能导致 Conan 依赖解析器在不同时间解析出不同的图。这不仅适用于库的实际版本(例如 opencv/4.5.0 而不是 opencv/4.2.1)——也适用于配方本身。也就是说,opencv/4.5.0 配方可能存在多个修订版,这可能对使用者产生副作用。配方的更改通常是为了解决问题(错误修复)、目标功能(例如添加条件选项、支持新平台)或更改依赖项的版本。

为了确保可重复性,强烈建议在消费者端使用锁定文件:请查看锁定文件文档以获取更多信息。

锁定文件确保 Conan 将以可重复且一致的方式解析相同的图表——从而确保在多个系统(CI、开发人员等)中使用相同的版本。

锁定文件也用于其他包管理器,如 Python pip、Rust Cargo、npm——这些建议与这些其他技术的实践一致。

此外,强烈建议在您自己的服务器中托管您的配方和包(见下文)。这两种方法都有助于您控制 ConanCenter 的上游更改何时在您的团队和系统之间传播。

服务可靠性

从 ConanCenter 远程仓库使用配方和包可能会在停机期间(计划内或计划外)受到影响。尽管我们尽一切努力确保 ConanCenter 始终可用,并且计划外停机很少见且会紧急处理——但这可能会影响直接依赖 ConanCenter 的用户。此外,从源代码构建配方时,这需要从 ConanCenter 控制范围之外的远程服务器检索源代码包(通常是 zip 或 tar 文件)。偶尔,这些也可能遭遇计划外停机。

在需要强大运行时间的生产环境中,强烈建议在您控制的服务器中托管配方和二进制包。

这还可以防止瞬态网络问题以及由外部源传输二进制数据引起的问题。这些建议也适用于从任何包管理器的外部源使用包。

合规性和安全性

某些行业,如金融、机器人和嵌入式系统,对变更管理、开源许可证和可重现性有更严格的要求。例如,配方的更改可能导致解析出依赖项的新版本,而该版本的许可证已更改,需要由您的组织进行验证和审计。在医疗或汽车等某些行业中,您可能需要确保所有依赖项都可以以可重复的方式从源代码构建,因此使用 Conan Center 提供的二进制文件可能不可取。在这些情况下,我们建议从源代码构建您自己的二进制包。

控制和自定义

依赖项的用户通常需要对外部库进行自定义更改——通常是为了支持 ConanCenter 或原始库作者未考虑到的特定平台配置、移植错误修复等。其中一些更改可能不适合合并到 ConanCenter 中,并且可能要等到 ConanCenter 维护人员审查和验证后才能发生。因此,如果您需要严格控制配方中的更改,强烈建议不仅托管 Conan 远程仓库,还要托管您自己的 conan-center-index 配方仓库的副本。

以下小节将更详细地描述上述策略