本地食谱索引仓库

本地食谱索引是 Conan 中引入的一种实验性仓库类型，旨在增强 C/C++ 包食谱管理的灵活性。这种仓库类型允许用户将本地目录用作 Conan 远程仓库，其中目录结构模仿了 conan-center-index GitHub 仓库的结构。

此设置在以下场景中特别有用：

  • 从私有 conan-center-index 分支构建二进制文件。

  • 分享您自己的某些库或工具的食谱，由于许可限制或专有性质，它们不适合 ConanCenter。请查看文档的专门部分 本地食谱索引仓库，了解如何将其用于此目的。

从私有 conan-center-index 分支构建二进制文件

正如我们在 Conan DevOps 指南的上一节 中介绍的，一些组织，特别是大型企业，更倾向于不使用从互联网下载的二进制文件。相反，他们使用 conan-center-index 食谱在内部构建自己的二进制文件。这些组织通常需要定制这些食谱以满足不适用于更广泛社区的独特要求，这使得此类贡献不适合上游仓库。

local-recipes-index 允许用户维护一个与 conan-center-index GitHub 仓库结构相同的本地文件夹，并将其用作包食谱的来源。这种新型仓库只包含食谱，因此需要在使用包的每台机器上从源代码构建包二进制文件。为了在团队之间共享二进制文件，我们仍然推荐 使用 Artifactory 等 Conan 远程服务器 用于生产目的。

../_images/local-repo-general-flow-diagram.png

local-recipes-index 仓库允许您轻松地从 conan-center-index 的分支构建二进制文件，然后将其托管在 Artifactory 等 Conan 远程仓库上。与 上一节 中解释的过程的主要区别在于，它能够立即测试多个本地更改，而无需在每次修改食谱时进行导出。

请注意，在这种情况下，不建议将 ConanCenter 的二进制文件与本地构建的二进制文件混合使用，原因如下：

  • 二进制兼容性：ConanCenter CI 和用户 CI 之间的设置可能存在细微差异。维护所有二进制文件的一致设置可以缓解一些问题。

  • 完全控制构建：自己构建所有二进制文件可确保您对编译环境和依赖项版本拥有完全控制权。

相反，建议从分支构建所有直接和传递依赖项。首先，删除上游 ConanCenter，因为它将不再使用，所有内容都将来自我们自己的分支

$ conan remote remove conancenter

然后我们将克隆我们的分支（在本例中，我们直接克隆上游用于演示目的，但您将克隆您自己的分支）

$ git clone https://github.com/conan-io/conan-center-index

将其添加为我们的 mycenter 远程仓库

# Add the mycenter remote pointing to the local folder
$ conan remote add mycenter ./conan-center-index

就这样！现在您可以列出并使用 conan-center-index 本地文件夹中的包了

$ conan list "zlib/*" -r=mycenter
mycenter
  zlib
    zlib/1.2.11
    zlib/1.2.12
    zlib/1.2.13
    zlib/1.3
    zlib/1.3.1

我们也可以从这个仓库安装包，例如我们可以执行

$ conan install --requires=zlib/1.3
...
======== Computing dependency graph ========
zlib/1.3: Not found in local cache, looking in remotes...
zlib/1.3: Checking remote: mycenter
zlib/1.3: Downloaded recipe revision 5c0f3a1a222eebb6bff34980bcd3e024
Graph root
    cli
Requirements
    zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024 - Downloaded (mycenter)

======== Computing necessary packages ========
Requirements
    zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024:72c852c5f0ae27ca0b1741e5fd7c8b8be91a590a - Missing
ERROR: Missing binary: zlib/1.3:72c852c5f0ae27ca0b1741e5fd7c8b8be91a590a

正如我们所看到的，Conan 成功地从 mycenter 获取了 zlib/1.3 的食谱，但随后由于没有二进制文件而失败。这是预期的，仓库只包含食谱，不包含二进制文件。我们可以使用 --build=missing 参数从源代码构建二进制文件

$ conan install --requires=zlib/1.3 --build=missing
...
zlib/1.3: package(): Packaged 2 '.h' files: zconf.h, zlib.h
zlib/1.3: package(): Packaged 1 file: LICENSE
zlib/1.3: package(): Packaged 1 '.a' file: libz.a
zlib/1.3: Created package revision 0466b3475bcac5c2ce37bb5deda835c3
zlib/1.3: Package '72c852c5f0ae27ca0b1741e5fd7c8b8be91a590a' created
zlib/1.3: Full package reference: zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024:72c852c5f0ae27ca0b1741e5fd7c8b8be91a590a#0466b3475bcac5c2ce37bb5deda835c3
zlib/1.3: Package folder /home/conan/.conan2/p/b/zlib1ed9fe13537a2/p
WARN: deprecated: Usage of deprecated Conan 1.X features that will be removed in Conan 2.X:
WARN: deprecated:     'cpp_info.names' used in: zlib/1.3

======== Finalizing install (deploy, generators) ========
cli: Generating aggregated env files
cli: Generated aggregated env files: ['conanbuild.sh', 'conanrun.sh']
Install finished successfully

我们现在可以在本地缓存中看到二进制包

$ conan list "zlib:*"
Local Cache
  zlib
    zlib/1.3
    revisions
      5c0f3a1a222eebb6bff34980bcd3e024 (2024-04-10 11:50:34 UTC)
      packages
        72c852c5f0ae27ca0b1741e5fd7c8b8be91a590a
        info
          settings
            arch: x86_64
            build_type: Release
            compiler: gcc
            compiler.version: 9
            os: Linux
          options
            fPIC: True
            shared: False

最后，将二进制包上传到我们的 Artifactory 仓库，使其可供我们的组织、用户和 CI 作业使用

$ conan remote add myartifactoryrepo <artifactory_url>
$ conan upload zlib* -r=myartifactoryrepo -c

这样，包的消费者不仅可以享受预编译的二进制文件，避免总是从源代码重新构建所有依赖项，而且这将提供更强的保证，确保依赖项正确构建和工作，所有依赖项和传递依赖项协同良好等。将二进制创建过程与二进制消费过程解耦是实现更快、更可靠地使用依赖项的方式。

请记住，在生产环境中，conan upload 命令应由 CI 而非开发人员执行，遵循 Conan 准则。这种方法确保包消费者享受预编译的二进制文件和依赖项之间的一致性。

修改本地食谱索引仓库文件

这种方法的优点之一是我们在每个食谱中所做的所有更改都会自动提供给 Conan 客户端。例如，对 recipes/zlib/config.yml 文件的更改会立即被 Conan 客户端识别。如果您编辑该文件并删除所有版本，只保留最新版本，然后我们 list 食谱

$ conan list "zlib/*" -r=mycenter
mycenter
  zlib
    zlib/1.3.1

当某些食谱更改时，请注意当前的 Conan 主目录已经包含包的缓存副本，因此除非我们明确使用 --update，否则它不会更新，就像任何其他 Conan 远程仓库一样。

因此，如果我们对 recipes/zlib/all/conanfile.py 中的 zlib 食谱进行更改并重复

$ conan install --requires=zlib/1.3.1 -r=mycenter --update --build=missing

我们将立即在我们的 Conan 主目录中拥有从新的修改后的食谱从源代码本地构建的新包二进制文件。

在生产环境中使用本地食谱索引仓库

使用此新功能时应考虑几个重要点

  • 它专为第三方包设计，其中一个仓库中的食谱正在创建源位于其他地方的包。为了打包您自己的代码，建议的标准做法是将 conanfile.py 食谱与源代码一起添加，并使用标准的 conan create 流程。

  • local-recipes-index 仓库指向文件系统中的本地文件夹。虽然用户可以选择使用 git 仓库或其他版本控制机制同步该文件夹，但 Conan 对此是不可知的，因为它只知道文件系统中指向仓库（当前）状态的文件夹。用户可以选择直接运行 git 命令来切换分支/提交/标签，Conan 将自动识别更改

  • 这种方法在源代码级别运行，不生成包二进制文件。对于开发和生产环境的部署，使用 Artifactory 等远程包服务器至关重要。需要注意的是，此功能不能替代 Conan 的远程包服务器，后者在托管包以供常规使用方面发挥着至关重要的作用。

  • 此外，请注意，服务器远程仓库可以保留更改历史记录，存储多个食谱修订版本。相比之下，local-recipes-index 远程仓库在任何给定时间只能表示单个快照。

  • ConanCenter 不使用 python-requires，因为这是一种更适合第一方包的机制。目前在 local-recipes-index 仓库中使用 python-requires 是可能的（并且是实验性的），但前提是 python-requires 也位于同一索引仓库中。不打算或计划支持在其他仓库或用户 Conan 缓存中拥有这些 python-requires。

此外，此功能不支持直接在食谱中放置服务器 URL；远程仓库必须使用 conan remote add 显式添加。将抽象包要求（例如“zlib/1.3.1”）与其特定来源解耦对于正确解析依赖项和利用 Conan 的图功能至关重要，包括版本冲突检测和解决、版本范围解析、选择预发布版本、platform_requires、replace_requires 等。这种分离还有助于实施现代 DevOps 实践，例如包不变性、完全可重定位性和包推广。

另请参阅