简介

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

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

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

开源

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

去中心化的包管理器

Conan 是一个具有客户端-服务器架构的去中心化包管理器。这意味着客户端可以从不同的服务器(“远程”)获取包,以及将包上传到不同的服务器,类似于“git”推/拉模型到/从 git 远程仓库。

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

_images/conan-systems.png

上图中不同的应用程序是

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

  • JFrog Artifactory Community Edition (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

社区

Conan 已被 TomTom、Audi、RTI、Continental、Plex、Electrolux 和 Mercedes-Benz 等数千家公司以及全球数千名开发人员在生产中使用。

但 Conan 的一个重要组成部分是,许多这些用户会回馈社区,创建一个令人惊叹且乐于助人的社区