配置

报告问题 查看源代码

本页介绍 Starlark 配置的优势和基本用法（Bazel 的 API，用于自定义项目的构建方式）。其中介绍了如何定义构建设置并提供了示例。

这样您就可以：

  • 为您的项目定义自定义标志，以消除对 --define 的需求
  • 编写转换，以采用与父级不同的配置来配置依赖项（例如 --compilation_mode=opt 或 --cpu=arm）
  • 将更好的默认设置融入到规则中（例如使用指定的 SDK 自动构建 //my:android_app）

等等，全部都来自 .bzl 文件（不需要 Bazel 版本）。如需查看示例，请参阅 bazelbuild/examples 代码库。

用户定义的 build 设置

构建设置是一条配置信息。可以将配置视为键值对映射。设置 --cpu=ppc 和 --copt="-DFoo" 会生成类似于 {cpu: ppc, copt: "-DFoo"} 的配置。每个条目都是构建设置。

cpu 和 copt 等传统标志是原生设置，它们的键已定义，其值在原生 Bazel Java 代码内设定。Bazel 用户只能通过命令行和以原生方式维护的其他 API 进行读取和写入。更改原生标志以及公开这些标志的 API 需要 Bazel 版本。用户定义的 build 设置在 .bzl 文件中进行定义（因此不需要 Bazel 版本来注册更改）。也可以通过命令行设置（如果指定为 flags，请参见下文），但也可以通过用户定义的转换进行设置。

定义 build 设置

端到端示例

build_setting rule() 参数

构建设置与任何其他规则一样，采用 Starlark rule() 函数的 build_setting 属性来区分规则。

# example/buildsettings/build_settings.bzl
string_flag = rule(
    implementation = _impl,
    build_setting = config.string(flag = True)
)

build_setting 属性接受一个用于指定构建设置类型的函数。该类型仅限于一组基本的 Starlark 类型，例如 bool 和 string。如需了解详情，请参阅 config 模块文档。您可以在规则的实现函数中实现更复杂的输入。详见下文。

config 模块的函数接受可选的布尔值参数 flag，该参数默认设为 false。如果 flag 设置为 true，则用户可以在命令行上构建 build 设置，也可以在规则编写过程中通过默认值和转换来设置 build 设置。并非所有设置都应该可供用户设置。例如，作为规则编写者想要在测试规则中启用某种调试模式，您可能不希望用户在其他非测试规则中随意启用该功能。

使用 ctx.build_setting_value

与所有规则一样，build 设置规则也具有实现函数。可通过 ctx.build_setting_value 方法访问构建设置的基本 Starlark 类型值。此方法仅适用于 build 设置规则的 ctx 对象。这些实现方法可以直接转发 build 设置值或对其执行额外的操作，例如类型检查或更复杂的结构创建。您将如何实现 enum 类型的构建设置：

# example/buildsettings/build_settings.bzl
TemperatureProvider = provider(fields = ['type'])

temperatures = ["HOT", "LUKEWARM", "ICED"]

def _impl(ctx):
    raw_temperature = ctx.build_setting_value
    if raw_temperature not in temperatures:
        fail(str(ctx.label) + " build setting allowed to take values {"
             + ", ".join(temperatures) + "} but was set to unallowed value "
             + raw_temperature)
    return TemperatureProvider(type = raw_temperature)

temperature = rule(
    implementation = _impl,
    build_setting = config.string(flag = True)
)

定义多集字符串标记

字符串设置有一个额外的 allow_multiple 参数，该参数支持在命令行或 bazelrcs 中多次设置该标志。它们的默认值仍会使用字符串类型属性进行设置：

# example/buildsettings/build_settings.bzl
allow_multiple_flag = rule(
    implementation = _impl,
    build_setting = config.string(flag = True, allow_multiple = True)
)

# example/BUILD
load("//example/buildsettings:build_settings.bzl", "allow_multiple_flag")
allow_multiple_flag(
    name = "roasts",
    build_setting_default = "medium"
)

每个标志设置都被视为一个值：

$ bazel build //my/target --//example:roasts=blonde \
    --//example:roasts=medium,dark

上面的值会解析为 {"//example:roasts": ["blonde", "medium,dark"]}，并且 ctx.build_setting_value 会返回列表 ["blonde", "medium,dark"]。

实例化 build 设置

使用 build_setting 参数定义的规则具有隐式强制 build_setting_default 属性。此属性采用由 build_setting 参数声明的相同类型。

# example/buildsettings/build_settings.bzl
FlavorProvider = provider(fields = ['type'])

def _impl(ctx):
    return FlavorProvider(type = ctx.build_setting_value)

flavor = rule(
    implementation = _impl,
    build_setting = config.string(flag = True)
)

# example/BUILD
load("//example/buildsettings:build_settings.bzl", "flavor")
flavor(
    name = "favorite_flavor",
    build_setting_default = "APPLE"
)

预定义的设置

端到端示例

Skylib 库包含一组预定义的设置，您无需编写自定义 Starlark 即可实例化这些设置。

例如，如需定义一个可接受一组有限字符串值的设置，请使用以下代码：

# example/BUILD
load("@bazel_skylib//rules:common_settings.bzl", "string_flag")
string_flag(
    name = "myflag",
    values = ["a", "b", "c"],
    build_setting_default = "a",
)

如需查看完整列表，请参阅通用构建设置规则。

使用构建设置

具体取决于 build 设置

如果目标想要读取一条配置信息，可以通过直接属性依赖项直接依赖于 build 设置。

# example/rules.bzl
load("//example/buildsettings:build_settings.bzl", "FlavorProvider")
def _rule_impl(ctx):
    if ctx.attr.flavor[FlavorProvider].type == "ORANGE":
        ...

drink_rule = rule(
    implementation = _rule_impl,
    attrs = {
        "flavor": attr.label()
    }
)

# example/BUILD
load("//example:rules.bzl", "drink_rule")
load("//example/buildsettings:build_settings.bzl", "flavor")
flavor(
    name = "favorite_flavor",
    build_setting_default = "APPLE"
)
drink_rule(
    name = "my_drink",
    flavor = ":favorite_flavor",
)

语言可能会希望创建一个规范的构建设置集，让该语言的所有规则都依赖于这组设置。虽然 fragments 的原生概念不再是 Starlark 配置环境中的硬编码对象，但是转换此概念的一种方法是使用通用的隐式属性集。例如：

# kotlin/rules.bzl
_KOTLIN_CONFIG = {
    "_compiler": attr.label(default = "//kotlin/config:compiler-flag"),
    "_mode": attr.label(default = "//kotlin/config:mode-flag"),
    ...
}

...

kotlin_library = rule(
    implementation = _rule_impl,
    attrs = dicts.add({
        "library-attr": attr.string()
    }, _KOTLIN_CONFIG)
)

kotlin_binary = rule(
    implementation = _binary_impl,
    attrs = dicts.add({
        "binary-attr": attr.label()
    }, _KOTLIN_CONFIG)

在命令行中使用构建设置

与大多数原生标志类似，您可以使用命令行来设置标记为标志的构建设置。build 设置的名称是使用 name=value 语法的完整目标路径：

$ bazel build //my/target --//example:string_flag=some-value # allowed
$ bazel build //my/target --//example:string_flag some-value # not allowed

支持特殊的布尔语法：

$ bazel build //my/target --//example:boolean_flag
$ bazel build //my/target --no//example:boolean_flag

使用 build 设置别名

您可以为 build 设置的目标路径设置别名，以便从命令行轻松阅读。别名的功能类似于原生标志，并且还使用双短划线选项语法。

通过将 --flag_alias=ALIAS_NAME=TARGET_PATH 添加到 .bazelrc 来设置别名。例如，如需将别名设置为 coffee，请使用以下代码：

# .bazelrc
build --flag_alias=coffee=//experimental/user/starlark_configurations/basic_build_setting:coffee-temp

最佳做法：多次设置别名会使最新的别名优先。使用唯一别名名称以避免意外解析结果。

如需使用该别名，请输入它来代替构建设置目标路径。 将上述 coffee 示例设置为用户的 .bazelrc：

$ bazel build //my/target --coffee=ICED

来替代

$ bazel build //my/target --//experimental/user/starlark_configurations/basic_build_setting:coffee-temp=ICED

最佳实践：虽然可以在命令行中设置别名，但将它们放在 .bazelrc 中可以减少命令行杂乱无章。

标签类型的 build 设置

端到端示例

与其他 build 设置不同，无法使用 build_setting 规则参数定义标签类型的设置。而 Bazel 有两个内置规则：label_flag 和 label_setting。这些规则将设置构建设置的实际目标提供方。label_flag 和 label_setting 可通过转换读取/写入，并且用户可以像设置其他 build_setting 规则一样设置 label_flag。它们的唯一区别在于它们无法自定义定义。

标签类型设置最终将取代后期默认设置的功能。延迟绑定的默认特性是标签类型特性，其最终值可能会受配置的影响。在 Starlark 中，这将取代 configuration_field API。

# example/rules.bzl
MyProvider = provider(fields = ["my_field"])

def _dep_impl(ctx):
    return MyProvider(my_field = "yeehaw")

dep_rule = rule(
    implementation = _dep_impl
)

def _parent_impl(ctx):
    if ctx.attr.my_field_provider[MyProvider].my_field == "cowabunga":
        ...

parent_rule = rule(
    implementation = _parent_impl,
    attrs = { "my_field_provider": attr.label() }
)


# example/BUILD
load("//example:rules.bzl", "dep_rule", "parent_rule")

dep_rule(name = "dep")

parent_rule(name = "parent", my_field_provider = ":my_field_provider")

label_flag(
    name = "my_field_provider",
    build_setting_default = ":dep"
)

build 设置和 select()

端到端示例

用户可以使用 select() 在 build 设置中配置属性。构建设置目标可以传递给 config_setting 的 flag_values 属性。与配置匹配的值将作为 String 进行传递，然后解析为匹配的构建设置类型。

config_setting(
    name = "my_config",
    flag_values = {
        "//example:favorite_flavor": "MANGO"
    }
)

用户定义的转换

配置转换会在 build 图中转换一个配置目标的转换。

设置规则必须包含特殊属性：

  "_allowlist_function_transition": attr.label(
      default = "@bazel_tools//tools/allowlists/function_transition_allowlist"
  )

通过添加过渡，您可以轻松扩大构建图的大小。这会在软件包中创建许可名单，您可以在其中创建此规则的目标。上述代码块中的默认值将所有内容列入许可名单。但是，如果您想限制谁使用您的规则，您可以将该属性设置为指向您自己的自定义许可名单。如果您想了解转换对您的构建性能有何影响，或者需要相关建议或帮助，请与 bazel-discuss@googlegroups.com 联系。

定义

转换定义了规则之间的配置更改。例如，“转换我的依赖项所依赖的 CPU 不同于其父项”之类的请求将由转换处理。

正式地说，过渡是从输入配置到一项或多项输出配置的函数。大多数过渡均为 1 对 1，例如“使用 --cpu=ppc 替换输入配置”。1:2 以上的过渡也存在，但有一些特殊限制。

在 Starlark 中，转换的定义方式与规则非常相似，定义了一个 transition() 函数和一个实现函数。

# example/transitions/transitions.bzl
def _impl(settings, attr):
    _ignore = (settings, attr)
    return {"//example:favorite_flavor" : "MINT"}

hot_chocolate_transition = transition(
    implementation = _impl,
    inputs = [],
    outputs = ["//example:favorite_flavor"]
)

transition() 函数接受一个实现函数、一组要读取的构建设置(inputs) 和一组要写入的构建设置 (outputs)。该实现函数有两个参数：settings 和 attr。settings 是在 transition() 的 inputs 参数中声明的所有设置的字典 {String:Object}。

attr 是附加到过渡效果的规则的属性和值字典。作为传出边缘过渡附加时，这些属性的值都会全部配置 select-select() 后。以传入的边缘转换形式附加时，attr 不包含任何使用选择器解析值的属性。如果传入的 --foo 过渡转换读取 bar 属性，然后同时选择 --foo 来设置 bar 属性，则传入的边缘转换有机会读取转换中错误的 bar 值。

实现函数必须返回要应用的新 build 设置值的字典（如果有多个输出配置转换，则应返回字典列表）。返回的字典密钥集必须包含传递给转换函数的 outputs 参数的那组构建设置。即使 build 设置在转换过程中实际上并未更改，也是如此，其原始值必须在返回的字典中明确传递。

定义 1:2 以上的过渡

端到端示例

传出边缘转换可以将单个输入配置映射到两个或更多输出配置。这对于定义捆绑多架构代码的规则非常有用。

1:2+ 转换是通过在转换实现函数中返回字典列表来定义的。

# example/transitions/transitions.bzl
def _impl(settings, attr):
    _ignore = (settings, attr)
    return [
        {"//example:favorite_flavor" : "LATTE"},
        {"//example:favorite_flavor" : "MOCHA"},
    ]

coffee_transition = transition(
    implementation = _impl,
    inputs = [],
    outputs = ["//example:favorite_flavor"]
)

他们还可以设置自定义实现函数可用于读取单个依赖项的自定义键：

# example/transitions/transitions.bzl
def _impl(settings, attr):
    _ignore = (settings, attr)
    return {
        "Apple deps": {"//command_line_option:cpu": "ppc"},
        "Linux deps": {"//command_line_option:cpu": "x86"},
    }

multi_arch_transition = transition(
    implementation = _impl,
    inputs = [],
    outputs = ["//command_line_option:cpu"]
)

附加过渡效果

端到端示例

过渡效果可以附加到两个位置：传入边缘和传出边缘。实际上，这意味着规则可以转换自己的配置（传入的边缘转换）和转换依赖项的配置（向外的边缘转换）。

注意：目前无法将 Starlark 过渡附加到原生广告规则。如需执行此操作，请发送电子邮件至 bazel-discuss@googlegroups.com，以寻求解决方法。

传入边缘转换

传入的边缘转换通过将 transition 对象（由 transition() 创建）附加到 rule() 的 cfg 参数来激活：

# example/rules.bzl
load("example/transitions:transitions.bzl", "hot_chocolate_transition")
drink_rule = rule(
    implementation = _impl,
    cfg = hot_chocolate_transition,
    ...

传入的边缘转换必须是 1:1 转换。

传出边缘转换

向外边缘转换通过将 transition 对象（由 transition() 创建）附加到特性的 cfg 参数来激活：

# example/rules.bzl
load("example/transitions:transitions.bzl", "coffee_transition")
drink_rule = rule(
    implementation = _impl,
    attrs = { "dep": attr.label(cfg = coffee_transition)}
    ...

传出边缘转换可以是 1:1 或 1:2+。

如需了解如何读取这些键，请参阅通过转换访问特性。

原生选项转换

端到端示例

Starlark 转换还可以通过选项名称的特殊前缀声明原生构建配置选项上的读写操作。

# example/transitions/transitions.bzl
def _impl(settings, attr):
    _ignore = (settings, attr)
    return {"//command_line_option:cpu": "k8"}

cpu_transition = transition(
    implementation = _impl,
    inputs = [],
    outputs = ["//command_line_option:cpu"]

不支持的原生选项

Bazel 不支持在 "//command_line_option:define" 上使用 --define 进行转换。您可以改用自定义构建设置。一般情况下，不建议在构建 build 时使用 --define，而使用 build 设置。

Bazel 不支持在 --config 上进行转换。这是因为 --config 是一种扩展到其他标志的“扩展”标志。

需要注意的是，--config 可能包含不会影响 build 配置的标志，例如 --spawn_strategy。根据设计，Bazel 无法将此类标志绑定到各个目标。这意味着，在过渡期间没有统一的方法来应用它们。

解决方法之一是，您可以明确列出转换中属于配置一部分的标志。这需要在两个位置维护 --config 的扩展，这是一个已知的界面缺陷。

启用多 build 转换功能

在设定允许多个值的 build 设置时，必须使用列表来设定此设置的值。

# example/buildsettings/build_settings.bzl
string_flag = rule(
    implementation = _impl,
    build_setting = config.string(flag = True, allow_multiple = True)
)

# example/BUILD
load("//example/buildsettings:build_settings.bzl", "string_flag")
string_flag(name = "roasts", build_setting_default = "medium")

# example/transitions/rules.bzl
def _transition_impl(settings, attr):
    # Using a value of just "dark" here will throw an error
    return {"//example:roasts" : ["dark"]},

coffee_transition = transition(
    implementation = _transition_impl,
    inputs = [],
    outputs = ["//example:roasts"]
)

空操作转换

如果转换返回 {}、[] 或 None，这种简写形式将所有设置保留为原始值。这比将每项输出明确设为其自身更方便。

# example/transitions/transitions.bzl
def _impl(settings, attr):
    _ignore = (attr)
    if settings["//example:already_chosen"] is True:
      return {}
    return {
      "//example:favorite_flavor": "dark chocolate",
      "//example:include_marshmallows": "yes",
      "//example:desired_temperature": "38C",
    }

hot_chocolate_transition = transition(
    implementation = _impl,
    inputs = ["//example:already_chosen"],
    outputs = [
        "//example:favorite_flavor",
        "//example:include_marshmallows",
        "//example:desired_temperature",
    ]
)

使用转换访问特性

端到端示例

将过渡效果附加到传出边缘（无论过渡效果是 1:1 还是 1:2+ 过渡效果）时，ctx.attr 必须强制是列表。该列表中元素的顺序未指定。

# example/transitions/rules.bzl
def _transition_impl(settings, attr):
    return {"//example:favorite_flavor" : "LATTE"},

coffee_transition = transition(
    implementation = _transition_impl,
    inputs = [],
    outputs = ["//example:favorite_flavor"]
)

def _rule_impl(ctx):
    # Note: List access even though "dep" is not declared as list
    transitioned_dep = ctx.attr.dep[0]

    # Note: Access doesn't change, other_deps was already a list
    for other_dep in ctx.attr.other_deps:
      # ...


coffee_rule = rule(
    implementation = _rule_impl,
    attrs = {
        "dep": attr.label(cfg = coffee_transition)
        "other_deps": attr.label_list(cfg = coffee_transition)
    })

如果转换为 1:2+ 并设置自定义键，则 ctx.split_attr 可用于读取每个键的单独依赖项：

# example/transitions/rules.bzl
def _impl(settings, attr):
    _ignore = (settings, attr)
    return {
        "Apple deps": {"//command_line_option:cpu": "ppc"},
        "Linux deps": {"//command_line_option:cpu": "x86"},
    }

multi_arch_transition = transition(
    implementation = _impl,
    inputs = [],
    outputs = ["//command_line_option:cpu"]
)

def _rule_impl(ctx):
    apple_dep = ctx.split_attr.dep["Apple deps"]
    linux_dep = ctx.split_attr.dep["Linux deps"]
    # ctx.attr has a list of all deps for all keys. Order is not guaranteed.
    all_deps = ctx.attr.dep

multi_arch_rule = rule(
    implementation = _rule_impl,
    attrs = {
        "dep": attr.label(cfg = multi_arch_transition)
    })

点击此处查看完整示例。

与平台和工具链集成

如今，许多原生标志（如 --cpu 和 --crosstool_top）都与工具链解析有关。将来，这些类型的标志的显式转换可能会被替换为目标平台上的转换。

内存和性能注意事项

向 build 添加过渡（并因此引入新配置）会产生费用：较大的 build 图、不易理解的 build 图以及较慢的 build。在构建规则中使用转换时，有必要考虑这些费用。以下示例说明了转换如何导致构建图的指数增长。

不良行为 build：案例研究

可伸缩性图表

图 1. 显示顶级目标及其依赖项的可伸缩性图表。

此图显示了顶级目标 //pkg:app，它有两个目标：//pkg:1_0 和 //pkg:1_1。这两个目标都依赖于 //pkg:2_0 和 //pkg:2_1。这两个目标都依赖于 //pkg:3_0 和 //pkg:3_1。这种情况会一直持续到 //pkg:n_0 和 //pkg:n_1，这都依赖于一个目标 //pkg:dep。

构建//pkg:app需要 \(2n+2\) 目标：

  • //pkg:app
  • //pkg:dep
  • \(i\) \([1..n]\)的//pkg:i_0和//pkg:i_1

假设您实现一个标记 --//foo:owner=<STRING> 且 //pkg:i_b 适用

depConfig = myConfig + depConfig.owner="$(myConfig.owner)$(b)"

换句话说，//pkg:i_b 会将 b 附加到 --owner 的所有依赖项的旧值。

这会生成以下配置的目标：

//pkg:app                              //foo:owner=""
//pkg:1_0                              //foo:owner=""
//pkg:1_1                              //foo:owner=""
//pkg:2_0 (via //pkg:1_0)              //foo:owner="0"
//pkg:2_0 (via //pkg:1_1)              //foo:owner="1"
//pkg:2_1 (via //pkg:1_0)              //foo:owner="0"
//pkg:2_1 (via //pkg:1_1)              //foo:owner="1"
//pkg:3_0 (via //pkg:1_0 → //pkg:2_0)  //foo:owner="00"
//pkg:3_0 (via //pkg:1_0 → //pkg:2_1)  //foo:owner="01"
//pkg:3_0 (via //pkg:1_1 → //pkg:2_0)  //foo:owner="10"
//pkg:3_0 (via //pkg:1_1 → //pkg:2_1)  //foo:owner="11"
...

//pkg:dep 会生成 \(2^n\) 配置的目标：config.owner= \(b_i\) “ \(\{0,1\}\)”中的所有目标。\(b_0b_1...b_n\)

这会让 build 图比目标图呈指数级增长，并造成相应的内存和性能后果。

待办事项：添加衡量和缓解这些问题的策略。

深入阅读

如需详细了解如何修改 build 配置，请参阅：