核心指南

良好实践

• build() 应该简单，在 generate() 中准备构建：recipe 的 generate() 方法的目的是尽可能地准备构建。用户调用 conan install 将会执行此方法，并且生成的文件应该允许用户尽可能容易地进行“原生”构建（直接调用 “cmake”、“meson” 等）。因此，尽可能避免在 build() 方法中包含任何逻辑，并将其移动到 generate() 方法，这有助于开发人员实现与本地缓存中 conan create 构建产生的构建相同的本地构建。

• 在生产环境中始终使用您自己的 profile，而不是依赖自动检测到的 profile，因为这种自动检测的输出可能会随时间变化，从而导致意外的结果。Profile（和许多其他配置）可以使用 conan config install 进行管理。

• 开发人员不应能够上传到服务器上的“开发”和“生产”仓库。只有 CI 构建在服务器上具有写入权限。开发人员应该只具有读取权限，最多只能访问一些“playground”仓库，用于与同事一起工作和分享内容，但这些仓库中的软件包永远不会被使用、移动或复制到开发或生产仓库。

• test_package 的目的是验证软件包的正确创建，而不是用于功能测试。test_package 的目的是检查软件包是否已正确创建（即，它是否已将头文件、库文件等正确打包到正确的文件夹中），而不是软件包的功能是否正确。因此，它应该尽可能简单，例如构建和运行一个使用头文件并链接到打包库的可执行文件就足够了。这样的执行也应该尽可能简单。build() 方法中应完成任何类型的单元测试和功能测试。

• 所有输入源必须对所有二进制配置都是通用的：所有“source”输入，包括 conanfile.py、conandata.yml、exports 和 exports_source、source() 方法、在 source() 方法中应用的补丁，都不能依赖于任何条件、平台、操作系统或编译器，因为它们在所有配置之间共享。此外，所有这些内容的行尾符应该相同，建议始终在所有平台上仅使用换行符，并且不要在 Windows 中转换或检出为 crlf，因为这将导致不同的 recipe 版本。

• 保持 ``python_requires`` 尽可能简单。避免传递 python_requires，使其尽可能减少，并且最多在“扁平”结构中显式地 require 它们，而没有 python_requires require 其他 python_requires。如果不是绝对必要，请避免继承（通过 python_requires_extend），并尽可能避免多重继承，因为它极其复杂，并且其工作方式与内置的 Python 继承不同。

• 目前 Conan 缓存不是并发的。避免任何类型的并发或并行，例如不同的并行 CI 作业应使用不同的缓存（使用 CONAN_HOME 环境变量）。这在未来可能会改变，我们将致力于在缓存中提供并发性，但在那之前，对于并发任务，请使用隔离的缓存。

• 避免将 ‘force’ 和 ‘override’ 特性作为版本控制机制。 不建议将用于解决冲突的 force 和 override 特性作为一般的版本控制解决方案，而仅作为解决版本冲突的临时解决方法。应尽可能避免使用它，建议更新图中的版本或版本范围，以避免没有 overrides 和 forces 的冲突。

• 请不要滥用 ‘tool_requires’。这些仅用于在“build”上下文中运行的可执行文件，如 cmake 和 ninja，而不是用于必须使用 requires 或 test_requires 的库或类似库的依赖项。

• 调用 Conan 时，位置参数应在任何命名参数之前指定。例如，conan install . -s="os=Windows" 是正确的，但 conan install -s="os=Windows" . 是不正确的。同样，建议在命名参数的名称和值之间使用 = 而不是空格。这是为了避免解析命令行参数时出现一些歧义情况。

• 强烈建议不要将 user/channel 用于任何质量、阶段、成熟度或可变信息。channel 部分非常过时，在大多数情况下应避免使用，或者使用固定的字符串，如 stable。user 可以用于组织内部的私有软件包，而对于来自 ConanCenter 或 conan-center-index Github 仓库分支的软件包，建议在不使用任何 user 或 channel 的情况下使用它们，例如 zlib/1.3.1 ConanCenter 引用，即使是为了自定义这些第三方库的 recipe 和软件包。

• 管理软件包质量、阶段或成熟度晋升的方式是使用不同的服务器仓库，并且众所周知的开发人员最佳实践建议通过在这些不同的服务器仓库之间晋升（复制）不可变的工件或软件包来管理管道，例如在软件包通过一些质量检查后，将软件包从 staging 仓库复制到 production 仓库。但非常重要的是，这种晋升绝不能以任何方式更改这些软件包，这些软件包必须是完全不可变的，甚至不能更改其 user/channel，这就是为什么以上几点不鼓励使用 user 和 channel 的原因，软件包和工件必须是不可变的。

禁止的做法

• Conan 不是可重入的：无法从 Conan 自身调用 Conan 进程。这包括从 recipe 代码、hooks、插件以及基本上所有在调用 Conan 时已经执行的代码中调用 Conan。这样做将导致未定义的行为。例如，从 conanfile.py 运行 conan search 是无效的。这包括间接调用，例如在构建脚本（如 CMakeLists.txt）中运行 Conan，而此构建脚本已经作为 Conan 调用的结果正在执行。出于同样的原因，Conan Python API 不能从 recipes 中使用：Conan Python API 只能从 Conan 自定义命令或用户 Python 脚本中调用，但绝不能从 conanfile.py recipes、hooks、扩展、插件或 Conan 执行的任何其他代码中调用。

• 设置和配置 (conf) 在 recipes 中是只读的：无法在 recipes 中定义设置和配置或为其赋值。不应在 recipes 中执行诸如 self.settings.compiler = "gcc" 之类的操作。那是未定义的行为，随时可能崩溃，或者只是被忽略。设置和配置只能在 profiles、命令行参数或 profile.py 插件中定义。

• Recipes 保留名称：Conan conanfile.py recipes 用户属性和方法应始终以 _ 开头。Conan 保留“public”命名空间用于所有属性和方法，_conan 用于私有属性和方法。使用任何未记录的 Python 函数、方法、类、属性，即使它在 Python 意义上是“public”的，如果该元素未在本文档中记录，也是未定义的行为。

• Conan 工件是不可变的：Conan 软件包和工件一旦进入 Conan 缓存，就被认为是不可变的。任何尝试修改导出的源、recipe、conandata.yml 或任何导出的或打包的工件的行为都是未定义的行为。例如，不可能在 package_info() 方法或 package_id() 方法中修改软件包的内容，这些方法绝不应修改、删除或在软件包内部创建新文件。如果需要修改某些软件包，可以使用您自己的自定义 deployer。

• Conan 缓存路径是内部实现细节：Conan 缓存路径是内部实现细节。Conan recipes 提供了诸如 self.build_folder 之类的抽象来表示有关文件夹的必要信息，以及诸如 conan cache path 之类的命令来获取有关当前文件夹的信息。在调试时可以只读方式检查 Conan 缓存，但不允许通过 Conan 命令行或公共 API 以外的任何其他方式编辑、修改或删除 Conan 缓存中的工件或文件。

• recipes 中使用的源必须是不可变的。一旦 recipe 导出到 Conan 缓存，就期望源是不可变的，也就是说，将来检索源将始终检索完全相同的源。不允许使用移动目标，例如 git 分支或服务器上持续重写的文件的下载。git 检出必须是不可变的 tag 或 commit，并且 download()/get() 必须使用校验和来验证服务器文件是否未更改。不使用不可变的源将是未定义的行为。