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 实现了“部署器”(deployers),可以通过命令行 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 中的锁文件已大大简化,并且变得更加灵活。锁文件现在被建模为排序引用的列表,这允许单个锁文件用于多种配置、合并锁文件、应用部分定义的锁文件、严格或非严格模式、向锁文件添加用户定义的约束等等。

新的配置和环境管理

在 Conan 1.X 中实验性引入的、在配置文件和命令行中称为 [conf] 的新配置系统,现在是配置和控制 Conan 行为的主要机制。其理念是配置系统用于将信息从 Conan(Conan 配置文件)传输到 Conan(Conan 配方,或像 CMakeToolchain 这样的 Conan 构建系统集成)。这个新的配置系统可以定义字符串、布尔值、列表,并且比环境变量更清晰、更有条理、更强大。一种更好、更明确的环境管理方式(同样在 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,将安装该包内的配置文件。它还允许使用版本范围轻松更新到范围内的最新版本,并使用锁文件实现可重现性。