从缓存保存和恢复软件包

警告

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

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

  • 在持续集成 (CI) 中，尤其是在进行分布式构建时，能够移动最近构建的临时软件包可能非常方便。大多数 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（任何版本）、最后一个配方修订版和所有软件包二进制文件的最后一个软件包修订版。可以使用可选的 --file=xxxx 参数更改文件名。一些重要的注意事项：

  • 该命令保存缓存“recipe”文件夹的内容，其中包含“export”、“export_sources”、“source”子文件夹以及配方“metadata”。

  • 可以使用 conan cache save --no-source 参数跳过缓存中的“source”文件夹。这意味着，如果恢复的配方需要在恢复的缓存中构建新二进制文件，它将没有源文件，并且如果配方的 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 版本可能会破坏使用先前版本创建的存储格式。（这与上述不将其用作备份策略的建议一致）