从/向缓存保存和恢复包

警告

此功能为实验性功能，可能会有破坏性更改。更多信息请参阅Conan 稳定性部分。

使用 conan cache save 和 conan cache restore 命令，可以从一个或多个 Conan 缓存中的包创建 .tgz 文件，然后将这些包恢复到另一个 Conan 缓存中。在某些场景下这会非常有用：

  • 在持续集成中，特别是进行分布式构建时，能够移动最近构建的临时包可能非常方便。大多数 CI 系统都具备为此目的在作业之间传输文件的能力。Conan 缓存不是并发的，有时对于并行作业必须使用不同的缓存。

  • 对于气隙（air-gapped）设置，其中包只能通过客户端传输。

  • 开发人员直接与其他开发人员共享一些包以进行测试或检查。

保存包的过程是使用 conan cache save 命令。它可以使用模式，就像 conan list 命令一样，但它也可以接受包列表，就像其他命令（如 remove, upload, download）一样。例如：

$ conan cache save "pkg/*:*"
Saving pkg/1.0: p/pkg1df6df1a3b33c
Saving pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270: p/b/pkgd573962ec2c90/p
Saving pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270 metadata: p/b/pkgd573962ec2c90/p
...
# creates conan_cache_save.tgz

conan_cache_save.tgz 文件包含名为 pkg（任意版本）的包、最新的 recipe 修正版本以及所有包二进制文件的最新包修正版本。文件名称可以通过可选的 --file=xxxx 参数更改。一些重要考虑事项：

  • 该命令保存缓存中“recipe”文件夹的内容，包括子文件夹“export”、“export_sources”、“source”和 recipe “metadata”。

  • 缓存中的“source”文件夹可以通过 conan cache save --no-source 参数跳过。这意味着如果恢复的 recipe 需要在恢复的缓存中构建新的二进制文件，它将没有源文件，并且如果 recipe 的 source() 方法指定，它将尝试下载它们。

  • 该命令保存“package”文件夹和包“metadata”文件夹的内容，但不保存二进制“build”或“download”文件夹，这些被认为是临时文件夹。

  • 如果用户不希望保存这些文件夹中的任何一个，可以在保存它们之前使用 conan cache clean 命令进行清理。

  • 该命令保存缓存文件和工件以及元数据（修订版本、package_id），以便能够在另一个缓存中恢复这些包。但它不保存任何其他缓存状态，例如 settings.yml、global.conf、remotes 等。如果保存的包需要任何其他特定配置，应使用 conan config install 进行管理。

我们可以将这个 conan_cache_save.tgz 文件移动到另一个 Conan 缓存并按如下方式恢复：

$ conan cache restore conan_cache_save.tgz
Restore: pkg/1.0 in p/pkg1df6df1a3b33c
Restore: pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270 in p/b/pkg773791b8c97aa/p
Restore: pkg/1.0:9a4eb3c8701508aa9458b1a73d0633783ecc2270 metadata in p/b/pkg773791b8c97aa/d/metadata
...

如果包已存在于缓存中，恢复过程将覆盖现有包。

注意

最佳实践

  • 保存和恢复包不能替代将包妥善存储（上传）到 Conan 服务器仓库。它仅用作临时机制，例如在 CI 系统中、用于气隙环境等，而不是作为长期存储和检索的手段。

  • 保存和恢复包不能替代对服务器仓库进行适当的备份。实施 Conan 包长期备份的推荐方式是使用某种服务器端备份策略。

  • 目前的存储格式和序列化不保证是面向未来且稳定的。它预计在相同的 Conan 版本中工作，但未来的 Conan 版本可能会破坏用以前版本创建的存储格式。（这与上述不将其用作备份策略的建议一致）