C++ 和 Bazel

报告问题 查看来源 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

本页面包含可帮助您将 Bazel 与 C++ 项目搭配使用的资源。其中包含指向教程、构建规则以及其他特定于使用 Bazel 构建 C++ 项目的信息的链接。

使用 Bazel

以下资源可帮助您在 C++ 项目中使用 Bazel:

最佳做法

除了常规 Bazel 最佳实践之外,以下是针对 C++ 项目的最佳实践。

BUILD 文件

创建 BUILD 文件时,请遵循以下准则:

  • 每个 BUILD 文件应包含目录中每个编译单元的一个 cc_library 规则目标。

  • 您应尽可能细化 C++ 库,以最大限度地提高增量并实现 build 并行化。

  • 如果 srcs 中只有一个源文件,请将库命名为与该 C++ 文件的名称相同。此库应包含 C++ 文件、任何匹配的头文件以及库的直接依赖项。例如:

    cc_library(
        name = "mylib",
        srcs = ["mylib.cc"],
        hdrs = ["mylib.h"],
        deps = [":lower-level-lib"]
    )
    
  • 在文件中,每个 cc_library 目标使用一个 cc_test 规则目标。将目标命名为 [library-name]_test,将源文件命名为 [library-name]_test.cc。 例如,上述 mylib 库目标的测试目标如下所示:

    cc_test(
        name = "mylib_test",
        srcs = ["mylib_test.cc"],
        deps = [":mylib"]
    )
    

包含路径

请遵循以下有关包含路径的准则:

  • 使所有 include 路径都相对于工作区目录。

  • 对于非系统头文件,请使用带引号的 include (#include "foo/bar/baz.h"),而不是尖括号 (#include <foo/bar/baz.h>)。

  • 避免使用 UNIX 目录快捷方式,例如 .(当前目录)或 ..(父目录)。

  • 对于需要指向项目代码库外部的 include(例如需要前缀的外部代码库 include)的旧版或 third_party 代码,请在 cc_library 规则目标上使用 include_prefixstrip_include_prefix 实参。

工具链功能

以下可选功能可提高 C++ 项目的整洁度。您可以使用 --features 命令行标志或 repopackagecc_* 规则的 features 属性来启用它们:

  • parse_headers 功能使得在使用 --process_headers_in_dependencies 标志时,C++ 编译器会解析(但不编译)构建目标及其依赖项中的所有头文件。这有助于捕获仅包含头文件的库中的问题,并确保头文件是自包含的,并且独立于其包含顺序。
  • layering_check 功能会强制执行以下规则:目标只能包含其直接依赖项提供的头文件。默认工具链支持在 Linux 上使用 clang 作为编译器的此功能。