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 中的默认版本控制方案已推广到任意数量的数字和字母,而不是仅使用 3 个字段的官方“semver”。

compatibility.py

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

新的 lockfiles

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

新的配置和环境管理

新的配置系统,在配置文件和命令行中称为 [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 将安装该包中的配置文件。它还允许使用版本范围轻松更新到范围内的最新版本,并使用 lockfiles 实现可重现性。