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 1.X 中引入的 Conan 2 将使用现代构建系统集成,如 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 中的默认版本控制方案已推广到任意数量的数字和字母,而不是官方的“semver”,后者只使用 3 个字段。

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,将会在该包内安装配置文件。它还允许使用版本范围轻松更新到范围内的最新版本,并使用锁定文件来实现可复现性。