简介

Conan 是一个用于 C 和 C++ 语言的依赖项和包管理器。它是免费和开源的，可在所有平台（Windows、Linux、macOS、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 的“push-pull”模型到/从 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 公共接口的一部分。私有实现细节以及文档中未包含的所有内容都可能更改。

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

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

此承诺不包括以下事项：

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

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

  • 作为插件或钩子的扩展点的内置默认实现也可能随每个版本更改。用户可以提供自己的实现以获得稳定性。

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

  • 输出流 stdout、stderr，即终端输出，可以随时更改。请勿解析终端输出进行自动化处理。

  • 文档中或 Conan 命令行输出中明确标记为 experimental 或 preview 的任何内容。有关这些标签的详细定义，请阅读以下部分。

  • 文档中标记为 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 的一个重要部分是，许多这些用户会回馈社区，从而创建一个令人惊叹和乐于助人的社区。