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() 方法的目标是处理无法轻易更改为每次都构建一种配置的旧版构建脚本。