简介

Conan 是一个用于 C 和 C++ 语言的依赖项和包管理器。它是 免费且开源的,适用于所有平台(Windows、Linux、OSX、FreeBSD、Solaris 等),并且可用于开发所有目标,包括嵌入式、移动设备(iOS、Android)和裸机。它还与所有构建系统集成,例如 CMake、Visual Studio (MSBuild)、Makefiles、SCons 等,包括专有构建系统。

它专为加速 C 和 C++ 项目的开发和持续集成而设计和优化。通过完整的二进制文件管理,它可以为任意数量的不同版本的包创建和重用任意数量的不同二进制文件(用于不同的配置,如体系结构、编译器版本等),在所有平台上使用完全相同的流程。由于它是去中心化的,因此可以轻松运行您自己的服务器来私下托管您自己的包和二进制文件,而无需共享它们。免费的 JFrog Artifactory 社区版 (CE) 是推荐的 Conan 服务器,用于在您的控制下私下托管您自己的包。

Conan 已经成熟且稳定,并坚定地承诺向前兼容(非破坏性策略),并且有一个完整的团队全天候致力于其改进和支持。它得到了一个庞大社区的支持和使用,从 ConanCenter 中的开源贡献者和包创建者到成千上万使用它的团队和公司。

开源

Conan 是免费且开源的,使用宽松的 MIT 许可证。请查看源代码和问题跟踪(用于问题和支持、报告错误以及建议功能请求和改进)https://github.com/conan-io/conan

去中心化包管理器

Conan 是一个具有客户端-服务器架构的去中心化包管理器。这意味着客户端可以从不同的服务器(“远程服务器”)获取包,也可以向这些服务器上传包,类似于“git” push-pull 模型在 git 远程服务器之间进行操作。

在较高层次上,服务器只是存储包。它们不构建也不创建包。包由客户端创建,如果从源代码构建二进制文件,则编译也由客户端应用程序完成。

_images/conan-systems.png

上图中的不同应用程序是

  • Conan 客户端:这是一个控制台/终端命令行应用程序,包含包创建和使用的主要逻辑。Conan 客户端有一个用于包存储的本地缓存,因此它允许您完全离线创建和测试包。只要不需要来自远程服务器的新包,您也可以离线工作。

  • JFrog Artifactory 社区版 (CE) 是推荐的 Conan 服务器,用于在您的控制下私下托管您自己的包。它是 JFrog Artifactory 的免费社区版,用于 Conan 包,包括 WebUI、多种身份验证协议 (LDAP)、虚拟和远程存储库以创建高级拓扑、Rest API 和通用存储库以托管任何工件。

  • conan_server 是与 Conan 客户端一起分发的一个小型服务器。它是一个简单的开源实现,并提供基本功能,但没有 WebUI 或其他高级功能。

  • ConanCenter 是一个中央公共存储库,社区在其中为流行的开源库(如 Boost、Zlib、OpenSSL、Poco 等)贡献包。

二进制文件管理

Conan 最强大的功能之一是它可以为任何可能的平台和配置创建和管理预编译的二进制文件。通过使用预编译的二进制文件并避免重复从源代码构建,它为开发人员和持续集成服务器节省了大量时间,同时还提高了工件的可重复性和可追溯性。

包由“conanfile.py”定义。这是一个定义包的依赖项、源代码、如何从源代码构建二进制文件等的文件。一个包“conanfile.py”配方可以生成任意数量的二进制文件,每个不同的平台和配置一个:操作系统、体系结构、编译器、构建类型等。这些二进制文件可以在所有平台上使用相同的命令创建并上传到服务器,为所有包提供一个单一的真相来源,并且不需要为每个不同的操作系统提供不同的解决方案。

_images/conan-binary_mgmt.png

从服务器安装包也非常高效。仅下载当前平台和配置所需的二进制文件,而不是全部下载。如果找不到兼容的二进制文件,也可以在客户端从源代码构建包。

所有平台、所有构建系统和编译器

Conan 适用于 Windows、Linux(Ubuntu、Debian、RedHat、ArchLinux、Raspbian)、OSX、FreeBSD 和 SunOS,并且由于它是可移植的,因此它可能适用于任何可以运行 Python 的其他平台。它可以定位任何现有的平台:从裸机到桌面、移动设备、嵌入式、服务器和交叉构建。

Conan 也适用于任何构建系统。它内置了集成以支持最流行的构建系统,例如 CMake、Visual Studio (MSBuild)、Autotools 和 Makefiles、Meson、SCons 等,但这不是必需的。甚至不需要所有包都使用相同的构建系统:每个包可以使用自己的构建系统,并依赖于使用不同构建系统的其他包。也可以与任何构建系统集成,包括专有构建系统。

同样,Conan 可以管理任何编译器和任何版本。对于最流行的编译器,有默认定义:gcc、cl.exe、clang、apple-clang、intel,以及不同版本的配置、运行时、C++ 标准库等。此模型也可扩展到任何自定义配置。

稳定性

从 Conan 2.0 及更高版本开始,致力于稳定性,目标是在改进工具和平台的同时不破坏用户空间。这意味着

  • 向前迁移到后续的次要版本 2.1、2.2、…、2.X 永远不应该破坏现有的配方、包或命令行流程

  • 如果出现破坏性更改,将被视为回归并恢复。

  • 错误修复将不被视为破坏性更改,依赖于此类错误的错误行为的配方和包将被视为已损坏。

  • 只有 https://docs.conan.org.cn 中记录的功能才被视为 Conan 公共接口的一部分。私有实现细节以及文档中未包含的任何内容都可能发生更改。

  • 兼容性始终被视为向前兼容。在后续的 2.X 版本中可以添加新的 API、工具、方法和助手。使用这些功能创建的配方和包将与早期 Conan 版本不兼容。

  • 每个次要版本的最新发布的补丁(major.minor.patch)都受支持且稳定。

有一些内容不包含在此承诺中

  • 公共存储库,如 **ConanCenter**,假设使用最新版本的 Conan 客户端,使用旧版本可能会导致使用较新版本的客户端创建的包和配方失败。建议使用您自己的私有存储库来存储您自己的包副本以用于生产,或者作为辅助方案,使用某种锁定机制来避免来自 ConanCenter 中更新的包的潜在中断,这些包需要最新版本的 Conan。

  • 配置和自动工具检测,例如默认配置文件的检测(conan profile detect)可以随时更改。鼓励用户在自己的配置文件中定义其配置以实现可重复性。新版本的 Conan 可能会检测到不同的默认配置文件。

  • 插件或钩子等扩展点的内置默认实现也可能在每个版本中发生变化。用户可以提供自己的扩展点以保持稳定性。

  • 使用 conan new 的包模板的输出可以随时更新以使用最新功能。

  • 输出流 stdout、stderr,即终端输出可以随时更改。不要解析终端输出以进行自动化。

  • 文档或 Conan cli 输出中明确标记为 experimentalpreview 的任何内容。阅读下面的部分以获取这些标签的详细定义。

  • 文档中标记为 deprecated 的任何内容都不应使用,因为它不会获得新的修复,并且将在下一个主要版本中删除。

  • Conan 客户端之外的其他工具和存储库

Conan 需要 Python>=3.6 才能运行。Conan 将在这些 Python 版本被宣布生命周期结束 (EOL) 1 年后停止支持这些版本。

如果您对 Conan 更新、稳定性或此稳定性定义有任何疑问,请在文档问题跟踪器中报告:https://github.com/conan-io/docs

社区

TomTom、奥迪、RTI、大陆集团、Plex、伊莱克斯和梅赛德斯-奔驰等数千家公司以及全球数千名开发人员正在生产环境中使用 Conan。

但 Conan 的一个重要部分是,其中许多用户将回馈贡献,从而创建一个令人惊叹且有帮助的社区