假设您需要在构建过程中运行工具。例如,您可能希望生成或预处理源文件,或者压缩二进制文件。在本教程中,您将创建一个用于调整图片大小的宏。
宏适用于简单的任务。如果您想执行更复杂的操作,例如添加对新编程语言的支持,请考虑创建规则。规则可让您拥有更大的控制权和更大的灵活性。
要创建可调整图片大小的宏,最简单的方法是使用 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],
outs = ["small_" + src],
cmd = "convert $< -resize " + size + " $@",
**kwargs
)
注意事项:
按照惯例,宏具有
name
参数,就像规则一样。如需记录宏的行为,请使用 Python 中的 docstring。
如需调用
genrule
或任何其他原生规则,请使用native.
。使用
**kwargs
将额外参数转发到底层genrule
(其工作原理与在 Python 中类似)。这很有用,因为用户可以使用visibility
或tags
等标准特性。
现在,使用 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"],
)