介绍

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

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

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

开源

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

去中心化的包管理器

Conan 是一个具有客户端-服务器架构的去中心化包管理器。这意味着客户端可以从不同的服务器(“远程”)获取包,也可以向其上传包,类似于“git”与 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、Red Hat、ArchLinux、Raspbian)、OSX、FreeBSD 和 SunOS 上运行,并且由于它是可移植的,它可能在任何可以运行 Python 的其他平台上运行。它可以以任何现有平台为目标:从裸机到桌面、移动设备、嵌入式、服务器和交叉编译。

Conan 也适用于任何构建系统。它内置了对最流行的系统(如 CMake、Visual Studio (MSBuild)、Autotools 和 Makefile、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 版本向后不兼容。

  • 每个次要版本的最新发布的补丁(主版本.次版本.补丁版本)才受支持和稳定。

此承诺不包括以下内容

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

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

  • 作为插件或钩子的内置默认扩展点实现也可能随着每次发布而更改。用户可以提供自己的扩展点以确保稳定性。

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

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

  • 文档或 Conan cli 输出中明确标记为 experimental(实验性)或 preview(预览)的任何内容。请阅读下面的部分以获取这些标签的详细定义。

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

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

Conan 运行需要 Python >= 3.7。在 Python 版本宣布生命周期结束 (EOL) 后一年,Conan 将弃用对该 Python 版本的支持。

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

社区

Conan 正在被 TomTom、Audi、RTI、Continental、Plex、Electrolux 和 Mercedes-Benz 等数千家公司和全球数以万计的开发人员用于生产。但 Conan 的一个基本部分是,其中许多用户会回馈,形成一个很棒且乐于助人的社区