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.list
、api.search
、api.remove
、api.profile
、api.graph
、api.upload
、api.remotes
等,它们将允许实现高级用户流程、功能和自动化。
另请参阅
新的构建系统集成¶
在最新的 Conan 1.X 中引入,Conan 2 将使用现代构建系统集成,如 CMakeDeps
和 CMakeToolchain
,它们是完全透明的 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_a
与 mylib_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/en/latest/versioning/revisions.html),以及声明工件的 **不变性**,可以改进流程、下载、安装和更新依赖项以及上传依赖项。
revisions
允许对工件进行准确的跟踪,从而可以实现更好的更新流程。例如,只要它们是从同一个配方版本创建的,就可以更容易地从不同的存储库获取不同配置的不同二进制文件。
基于 revisions
,包的传输、上传和下载也将更加高效。只要服务器或缓存中存在给定的版本,Conan 根本不会传输该包的工件。
包列表¶
Conan 2 允许使用“包列表”功能对多个配方和包执行批量操作。此功能允许使用单个命令上传、下载、删除和列出多个配方和包。
包列表也可以从 conan create
或 conan install
命令生成的依赖关系图创建,因此可以通过链接两个命令将属于给定依赖关系图的所有包上传到服务器。
元数据文件¶
Conan 2 允许存储、上传、下载和修改与配方和包关联的元数据文件。此功能对于管理构建日志、测试可执行文件、测试结果、覆盖率数据以及跟踪、合规性和业务目的所需的许多其他不同文件非常有用。
另请参阅
第三方备份源¶
在为使用互联网上源代码的第三方构建包时,这些源代码可能会被删除或更改。“备份源”可以自动将这些源代码的副本存储在您自己的服务器上,因此无论原始互联网源代码发生什么变化,您的构建始终都是完全可重现的。
另请参阅
从 Conan 包安装配置¶
从 Conan 2.2 开始,不仅可以从 Git 存储库和 HTTP 服务器安装配置,还可以从 Conan 包安装配置。对 Conan 服务器中存储的 Conan 包 myconf/myversion
执行 conan config install-pkg myconf/myversion
,可以将配置文件安装到该包中。它还允许使用版本范围轻松更新到范围内的最新版本,并使用锁定文件来实现可重现性。