本页面假定您熟悉 Bazel,并提供了有关如何构建项目以充分利用 Bazel 功能的准则和建议。
总体目标如下:
- 使用精细的依赖项来实现并行性和增量性。
- 以便妥善封装依赖项。
- 使代码结构清晰且可测试。
- 创建易于理解和维护的 build 配置。
这些准则并非强制性要求:很少有项目能够遵循 所有资源正如 lint 的手册页面所述, 让第一个人生成真正的程序,并且该程序不会产生任何错误。 严格检查。”不过,尽可能采用这些原则应该可以让项目更易于阅读、不易出错且构建速度更快。
本页面使用 此 RFC。
运行 build 和测试
项目应始终能够在其稳定分支上成功运行 bazel build //...
和 bazel test //...
。对于必要但在特定情况下无法构建的目标(例如,需要特定的 build 标志、无法在特定平台上构建、需要许可协议),应尽可能具体地进行标记(例如“requires-osx
”)。这种标记方式可让您以比“手动”标记更精细的级别过滤目标,并让检查 BUILD
文件的用户了解目标的限制。
第三方依赖项
您可以声明第三方依赖项:
- 在
WORKSPACE
文件中将其声明为远程仓库。 - 或者,将它们放在工作区目录下的
third_party/
目录中。
取决于二进制文件
应尽可能从源代码构建所有内容。一般来说,这意味着
这样,您便不再依赖于 some-library.so
库,而是创建一个
BUILD
文件并从其源代码构建 some-library.so
,然后依赖于它
目标。
始终从源代码构建可以确保构建不使用 是使用不兼容的标志或其他架构构建的。此外,一些功能(例如覆盖率、静态分析或动态分析)仅适用于源代码。
版本控制
尽可能从主干构建所有代码。版本必须
请避免在目标名称中包含版本(例如 //guava
、
而不是 //guava-20.0
)。此命名使库更易于更新(只有一个
目标需要更新)。对菱形依赖项的适应能力也更好
问题:如果一个库依赖于 guava-19.0
,而另一个库依赖于 guava-20.0
,
最终可能会出现一个尝试依赖于两个不同版本的库。
如果您创建了误导性的别名来将两个目标指向一个 guava
库,则 BUILD
文件会误导用户。
使用 .bazelrc
文件
对于项目专用选项,请使用 workspace/.bazelrc
的配置文件(请参阅 bazelrc 格式)。
想要支持您不按用户设置的项目 想要签入源代码控制,请添加以下代码行:
try-import %workspace%/user.bazelrc
(或任何其他文件名)并将 user.bazelrc
添加到 .gitignore
。
软件包
每个包含可构建文件的目录都应该是一个软件包。如果 BUILD
是指其子目录(如 srcs = ["a/b/C.java"]
)中的文件,
一个指示符,表示应将 BUILD
文件添加到该子目录中。越长
循环依赖关系
无意间创建,目标的范围将逐渐扩大,
必须更新反向依赖项。