build_id()

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

在一般情况下,每个二进制包都有一个构建文件夹,并且具有与包的 package_id 完全相同的 package_id。但是此行为可以更改,在某些情况下这可能很有用

  • 包构建脚本一次生成多个不同的配置(例如调试和发布工件),而无需单独构建每个配置。

  • 包构建脚本生成一个二进制配置,但可以分别打包不同的工件。例如,如果有一些测试可执行文件,您可能希望创建两个包:一个只包含库以供一般使用,另一个还包含测试(用于合规性、以后的可重复性、调试等)。

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

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

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

此配方将生成一个最终不同的包,并为调试和发布配置生成不同的 package_id。但是,由于 build_id() 将为任何 build_type 生成相同的 build_id,则只会执行一个文件夹和一个 build(),构建调试和发布工件,然后 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() 方法的目的是处理无法轻松更改为每次构建一个配置的旧版构建脚本。