build_id()

build_id() 方法允许重用相同的构建来创建缓存中不同的二进制包,从而可能节省构建时间,因为它能避免一些不必要的重新构建。因此,这是一种优化方法。

在一般情况下,每个二进制包都有一个构建文件夹,其 package_id 与包完全相同。然而,这种行为是可以改变的,在以下几种情况下可能很有用

  • 包构建脚本在同一次运行中同时生成多个不同的配置(例如 debug 和 release 产物),而无法分别构建每个配置。

  • 包构建脚本生成一个二进制配置,但可以打包不同的产物。例如,如果有一些测试可执行文件,您可能想要创建两个包:一个仅包含用于通用用途的库,另一个也包含测试(用于合规性、后续可重现性、调试等)。

在第一种情况下,例如我们可以这样写

settings = "os", "compiler", "arch", "build_type"

def build_id(self):
    self.info_build.settings.build_type = "Any"

这个 recipe 将为 debug 和 release 配置生成最终不同的包,并具有不同的 package_id。但是由于 build_id() 将为任何 build_type 生成相同的 build_id,因此只会执行一个文件夹和一个 build(),构建 debug 和 release 产物,然后将为每个配置调用 package() 方法,并且它应该根据 self.settings.build_type 值有条件地打包产物。如果使用不同的编译器或架构,仍然会执行不同的构建。

还可以更改其他信息,例如自定义包选项

def build_id(self):
    self.info_build.options.myoption = 'MyValue' # any value possible
    self.info_build.options.fullsource = 'Always'

如果 build_id() 方法不修改 info_build 数据,并且它仍然产生与 package_id 不同的 id,则将应用标准行为。考虑以下情况

settings = "os", "compiler", "arch", "build_type"

def build_id(self):
    if self.settings.os == "Windows":
        self.info_build.settings.build_type = "Any"

只有当包是为 Windows 构建时,才会产生不同的 build_id,因此对于所有 build_type 值只运行一次 build()。在任何其他操作系统中的行为将是标准的,就像没有定义 build_id() 方法一样,对于每个 build_type 运行不同的 build()

注意

最佳实践

Conan 强烈建议为每个不同的配置使用一个具有自己 package_id 的包二进制文件。build_id() 方法的目标是处理无法轻易更改为每次构建一个配置的旧版构建脚本。