Conan 2 的新特性

Conan 2 基于 Conan 1.X 在过去几年中学到的经验,带来了许多激动人心的改进。此外,Conan 1.X 也投入了大量精力进行必要的反向移植,以使升级更容易:使用最新 1.X 集成的配方将与 Conan 2 兼容,并且两个版本的二进制文件不会冲突,能够共存于同一个服务器仓库中。

Conan 2 迁移指南

如果您正在使用 Conan 1.X,请阅读 Conan 2 迁移指南,开始为 2.0 准备您的软件包配方,并注意在您仍在 Conan 1.X 中工作时的一些变化。该指南总结了上述反向移植,以使升级更容易。

新的图模型

Conan 2 定义了新的需求特性(headers, libs, build, run, test, package_id_mode, options, transitive_headers, transitive_libs)和软件包类型(static, shared, application, header-only),以更好地表示 C 和 C++ 二进制文件(例如链接静态库或共享库的可执行文件或共享库)之间的关系。

新的公共 Python API

一个新的模块化 Python API 已开放、公开且有文档。这是一个真正的 API,它包含已用于构建 Conan 内置命令的构建块,但它将允许进一步的扩展。有针对不同功能组的子 API,例如 api.listapi.searchapi.removeapi.profileapi.graphapi.uploadapi.remotes 等,这将允许实现高级用户流程、功能和自动化。

另请参阅

新的构建系统集成

Conan 2 在最新的 Conan 1.X 中引入,将使用现代构建系统集成,例如 CMakeDepsCMakeToolchain,它们是完全透明的 CMake 集成(即,使用方的 CMakeLists.txt 完全不需要知道 Conan)。这些集成还可以实现更好的 IDE 集成,例如通过 CMakePresets.json。

另请参阅

新的自定义用户命令

Conan 2 允许使用 Python 编写自定义用户命令来扩展 Conan,这些命令可以被称为 conan xxxx。这些命令可以通过 conan config install 共享和安装,并具有命令和子命令的层级。自定义用户命令使用新的 2.0 公共 Python API 来实现其功能。

新的 CLI

Conan 2 重新设计了 CLI 以提高一致性,消除歧义并改善用户体验。新的 CLI 还会将所有信息、警告和错误消息发送到 stderr,同时将最终结果保留在 stdout 中,允许多种输出格式,如 --format=html--format=json,并使用重定向创建文件 --format=json > myfile.json。CLI 提供的信息将更加结构化和全面,以便更轻松地用于自动化,尤其是在 CI/CD 系统中。

另请参阅

新的部署器

Conan 2 实现了“部署器”,可以在命令行中通过 conan install …. --deployer=mydeploy 调用,通常用于执行从 Conan 缓存到用户文件夹的复制操作。此类部署器可以是内置的(目前提供了“full_deploy”、“direct_deploy”和“runtime_deploy”),也可以是用户定义的,后者可以通过 conan config install 共享和管理。部署器在生成器之前运行,并且可以更改目标文件夹。例如,如果 --deployer=full_deploy 部署器在 CMakeDeps 之前运行,则由 CMakeDeps 生成的文件将指向由 full_deploy 部署器在用户文件夹中完成的本地副本,而不是 Conan 缓存。

部署器可以是多配置的。对不同的配置文件重复运行 conan install . --deployer=full_deploy,可以实现一个完全自包含的项目,包括所有工件、二进制文件和构建文件,该项目完全独立于 Conan,并且不再需要 Conan 来构建。

新的 package_id

Conan 2 定义了一个新的动态 package_id,这是对 Conan 1.X 限制的巨大改进。这个 package_id 将考虑软件包类型和需求类型,以根据场景实现更有意义的策略。例如,众所周知,当应用程序 myapp 链接静态库 mylib 时,静态库 mylib 二进制文件的任何更改都需要重新构建应用程序 myapp。因此,Conan 将默认采用 full_mode 模式,该模式将为 mylib 配方或二进制文件的每次更改生成一个新的 myapp package_id。而静态库 mylib_amylib_b 使用时的依赖关系通常不意味着 mylib_b 的更改总是需要重新构建 mylib_a,并且该关系可以默认采用 minor_mode 模式。在 Conan 2 中,修改 mylib_a 的人可以更好地表达消费者 mylib_b 是否需要重新构建,这取决于版本号的增加(补丁版本号的增加不会触发重新构建,而次版本号的增加会触发)。

此外,Conan 中的默认版本控制方案已推广到任意数量的数字和字母,与仅使用 3 个字段的官方“semver”不同。

compatibility.py

Conan 2 提供了一种新的扩展机制,用于全局定义二进制兼容性。Conan 缓存中的 compatibility.py 文件将用于定义在给定软件包缺少某些二进制文件时应使用哪些二进制文件的回退。Conan 将提供一个默认值以考虑 cppstd 兼容性和可执行文件兼容性,但此扩展完全可由用户配置(也可以通过 conan config install 共享和管理)。

新的锁文件

Conan 2 中的锁文件已大大简化并变得更加灵活。锁文件现在建模为有序引用列表,这允许单个锁文件用于多种配置、合并锁文件、应用部分定义的锁文件、严格或非严格、向锁文件添加用户定义的约束等等。

新的配置和环境管理

新的配置系统在配置文件和命令行中称为 [conf],并在 Conan 1.X 中作为实验性功能引入,现在是配置和控制 Conan 行为的主要机制。其思想是配置系统用于将信息从 Conan(Conan 配置文件)传输到 Conan(Conan 配方,或 Conan 构建系统集成,如 CMakeToolchain)。这个新的配置系统可以定义字符串、布尔值、列表,并且比环境变量更清晰、更结构化、更强大。更好的、更明确的环境管理(也在 Conan 1.X 中引入)现在是从 Conan(配置文件)向工具(如编译器、构建系统)传递信息的方式。

另请参阅

多版本缓存

Conan 缓存已完全重新设计,以允许同时存储多个修订版本。它还缩短了路径,使用了哈希值,从而无需在 Windows 中使用 short_paths。请注意,缓存仍不支持并发,因此并行作业或任务应使用独立的缓存。

新的扩展插件

添加了几个名为“插件”的扩展点,以提供高级且通常与 Conan 配方实现正交的功能。这些插件可以通过 conan config install 共享、管理和安装。

配置文件检查器

提供了一个新的 profile.py 扩展点,可用于在配置文件处理后执行操作。提供了一个默认实现,用于检查给定编译器版本是否能够支持给定的编译器 cppstd,但这是完全可由用户自定义的。

命令封装器

一个新的 cmd_wrapper.py 扩展提供了一种将任何 conanfile.py 命令(即,配方中在 self.run() 内部运行的任何内容)封装到新命令中的方法。此功能对于将构建命令封装在 IncrediBuild 或编译缓存等构建优化工具中非常有用。

软件包签名

新增了一个 sign.py 扩展,用于实现软件包的签名和验证。随着人们对软件供应链安全重要性的认识不断提高,对软件包进行签名和验证的能力变得越来越重要。此扩展点将很快获得基于 Sigstore 的插件实现。

软件包不变性优化

Conan 2 中对 revisions 的彻底使用(已在 Conan 1.X 中作为可选功能引入,参见 https://docs.conan.org.cn/2/versioning/revisions.html),以及工件不变性的声明,使得在下载、安装、更新和上传依赖项时能够改进流程。

Revisions 允许对工件进行精确追溯,从而实现更好的更新流程。例如,只要它们是从相同的配方版本创建的,从不同仓库获取不同配置的二进制文件将更容易。

基于 revisions 的软件包传输、上传和下载也将更加高效。只要给定版本存在于服务器或缓存中,Conan 就不会为该软件包传输任何工件。

软件包列表

Conan 2 允许使用“软件包列表”功能对多个配方和软件包进行批量操作。此功能允许通过一个命令上传、下载、删除和列出多个配方和软件包。

软件包列表还可以从 conan createconan install 命令生成的依赖图创建,因此只需链接两个命令即可将属于给定依赖图的所有软件包上传到服务器。

元数据文件

Conan 2 允许存储、上传、下载和修改与配方和软件包关联的元数据文件。此功能对于管理构建日志、测试可执行文件、测试结果、覆盖率数据以及用于可追溯性、合规性和业务目的的各种其他文件非常有用。

第三方备份源

当为在互联网上拥有源的第三方构建软件包时,这些源可能会被删除或更改。“备份源”可以自动在您自己的服务器上存储这些源的副本,因此无论原始互联网源发生什么,您的构建始终可以完全复现。

从 Conan 软件包安装配置

从 Conan 2.2 开始,不仅可以从 git 仓库和 http 服务器安装配置,还可以从 Conan 软件包安装。对于存储在 Conan 服务器上的 Conan 软件包 myconf/myversion,运行 conan config install-pkg myconf/myversion 将安装该软件包中的配置文件。它还允许使用版本范围轻松更新到范围内的最新版本,并使用锁文件实现可复现性。