创建旧版宏

报告问题 查看源代码 每夜 build · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

重要提示:本教程适用于旧版宏。如果您只需支持 Bazel 8 或更高版本,我们建议您改用符号宏;请参阅创建符号宏

假设您需要在构建过程中运行某个工具。例如,您可能需要生成或预处理源文件,或者压缩二进制文件。在本教程中,您将创建一个用于调整图片大小的旧版宏。

宏适用于简单的任务。如果您想执行更复杂的操作(例如添加对新编程语言的支持),不妨考虑创建规则。规则可为您提供更大的控制力和灵活性。

若要创建用于调整图片大小的宏,最简单的方法是使用 genrule

genrule(
    name = "logo_miniature",
    srcs = ["logo.png"],
    outs = ["small_logo.png"],
    cmd = "convert $< -resize 100x100 $@",
)

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    data = [":logo_miniature"],
)

如果您需要调整更多图片的大小,不妨重复使用该代码。为此,请在单独的 .bzl 文件中定义一个函数,并将该文件命名为 miniature.bzl

def miniature(name, src, size = "100x100", **kwargs):
    """Create a miniature of the src image.

    The generated file is prefixed with 'small_'.
    """
    native.genrule(
        name = name,
        srcs = [src],
        # Note that the line below will fail if `src` is not a filename string
        outs = ["small_" + src],
        cmd = "convert $< -resize " + size + " $@",
        **kwargs
    )

以下是一些注意事项:

  • 按照惯例,与规则一样,旧版宏也具有 name 参数。

  • 如需记录旧版宏的行为,请使用与 Python 中类似的 docstring

  • 如需调用 genrule 或任何其他原生规则,请在前面加上 native.

  • 使用 **kwargs 将额外的参数转发给底层 genrule(其运作方式与 Python 中完全相同)。这样做非常有用,因为用户可以使用 visibilitytags 等标准属性。

现在,使用 BUILD 文件中的宏:

load("//path/to:miniature.bzl", "miniature")

miniature(
    name = "logo_miniature",
    src = "image.png",
)

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    data = [":logo_miniature"],
)

最后,一个警告注意:该宏假定 src 是文件名字符串(否则,outs = ["small_" + src] 将失败)。因此,src = "image.png" 可以正常运行;但如果 BUILD 文件改用 src = "//other/package:image.png"src = select(...) 会怎么样?

您应务必在宏的文档中声明此类假设。遗憾的是,旧版宏(尤其是大型宏)往往很脆弱,因为您可能很难发现并记录代码中的所有此类假设,当然,有些宏用户也不会阅读文档。我们建议您尽可能改用符号宏,因为它们对属性类型具有内置检查。