相约 2023 年 BazelCon 将于 10 月 24 日至 25 日在 Google 慕尼黑举办!报名现已开放! 了解详情

常见 C++ 构建用例

报告问题 查看源代码

在这里,您可以找到使用 Bazel 构建 C++ 项目的一些最常见的使用场景。如果尚未完成 Bazel 构建 C++ 项目,请完成教程:Bazel:构建 C++ 项目

如需了解 cc_library 和 hdrs 头文件,请参阅 cc_library

在一个目标中添加多个文件

您可以使用 glob 在单个目标中包含多个文件。 例如:

cc_library(
    name = "build-all-the-files",
    srcs = glob(["*.cc"]),
    hdrs = glob(["*.h"]),
)

设置此目标后,Bazel 会构建其在包含此目标文件的 BUILD 文件(不包括子目录)所在的目录中找到的所有 .cc.h 文件。

使用传递包括

如果某个文件包含头文件,则以该文件为源的任何规则(即,在 srcshdrstextual_hdrs 属性中拥有该文件)应依赖于所包含头文件的库规则。相反,只需要将直接依赖项指定为依赖项。例如,假设 sandwich.h 包含 bread.hbread.h 包含 flour.hsandwich.h 不包含 flour.h(想要添加三明治中的面粉?),因此 BUILD 文件将如下所示:

cc_library(
    name = "sandwich",
    srcs = ["sandwich.cc"],
    hdrs = ["sandwich.h"],
    deps = [":bread"],
)

cc_library(
    name = "bread",
    srcs = ["bread.cc"],
    hdrs = ["bread.h"],
    deps = [":flour"],
)

cc_library(
    name = "flour",
    srcs = ["flour.cc"],
    hdrs = ["flour.h"],
)

此处,sandwich 库依赖于 bread 库,后者依赖于 flour 库。

添加包含路径

有时,您无法(或者不想)在根根目录下添加根路径。现有库可能已包含与其工作区中的路径不匹配的包含目录。例如,假设您具有以下目录结构:

└── my-project
    ├── legacy
    │   └── some_lib
    │       ├── BUILD
    │       ├── include
    │       │   └── some_lib.h
    │       └── some_lib.cc
    └── WORKSPACE

Bazel 希望将 some_lib.h 添加为 legacy/some_lib/include/some_lib.h,但假设 some_lib.cc 包含 "some_lib.h"。为了使该包含路径有效,legacy/some_lib/BUILD 需要将 some_lib/include 目录指定为包含目录:

cc_library(
    name = "some_lib",
    srcs = ["some_lib.cc"],
    hdrs = ["include/some_lib.h"],
    copts = ["-Ilegacy/some_lib/include"],
)

这对于外部依赖项特别有用,因为其头文件必须附带 / 前缀。

包括外部库

假设您使用的是 Google Test。您可以使用 WORKSPACE 文件中的某一代码库函数下载 Google Test,并使其在您的代码库中可用:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "gtest",
    url = "https://github.com/google/googletest/archive/release-1.10.0.zip",
    sha256 = "94c634d499558a76fa649edb13721dce6e98fb1e7018dfaeba3cd7a083945e91",
    build_file = "@//:gtest.BUILD",
)

然后,创建 gtest.BUILD,这是一个用于编译 Google Test 的 BUILD 文件。Google Test 有几项“特殊”要求,这使得其 cc_library 规则变得更加复杂:

  • googletest-release-1.10.0/src/gtest-all.cc #include 会删除 googletest-release-1.10.0/src/ 中的所有其他文件:将其从编译中排除,以防止出现重复符号的链接错误。

  • 它使用相对于 googletest-release-1.10.0/include/ 目录 ("gtest/gtest.h") 的头文件,因此您必须将该目录添加到包含路径。

  • 需要在 pthread 中进行关联,因此请添加为 linkopt

因此,最终规则如下所示:

cc_library(
    name = "main",
    srcs = glob(
        ["googletest-release-1.10.0/src/*.cc"],
        exclude = ["googletest-release-1.10.0/src/gtest-all.cc"]
    ),
    hdrs = glob([
        "googletest-release-1.10.0/include/**/*.h",
        "googletest-release-1.10.0/src/*.h"
    ]),
    copts = [
        "-Iexternal/gtest/googletest-release-1.10.0/include",
        "-Iexternal/gtest/googletest-release-1.10.0"
    ],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

这有点混乱:所有前缀都是 googletest-release-1.10.0 作为归档结构的副产品。您可以通过添加 strip_prefix 属性来让 http_archive 移除此前缀:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "gtest",
    url = "https://github.com/google/googletest/archive/release-1.10.0.zip",
    sha256 = "94c634d499558a76fa649edb13721dce6e98fb1e7018dfaeba3cd7a083945e91",
    build_file = "@//:gtest.BUILD",
    strip_prefix = "googletest-release-1.10.0",
)

然后,gtest.BUILD 将如下所示:

cc_library(
    name = "main",
    srcs = glob(
        ["src/*.cc"],
        exclude = ["src/gtest-all.cc"]
    ),
    hdrs = glob([
        "include/**/*.h",
        "src/*.h"
    ]),
    copts = ["-Iexternal/gtest/include"],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

现在,cc_ 规则可以依赖于 @gtest//:main

编写和运行 C++ 测试

例如,您可以创建一个测试 ./test/hello-test.cc,例如:

#include "gtest/gtest.h"
#include "main/hello-greet.h"

TEST(HelloTest, GetGreet) {
  EXPECT_EQ(get_greet("Bazel"), "Hello Bazel");
}

然后,为您的测试创建 ./test/BUILD 文件:

cc_test(
    name = "hello-test",
    srcs = ["hello-test.cc"],
    copts = ["-Iexternal/gtest/include"],
    deps = [
        "@gtest//:main",
        "//main:hello-greet",
    ],
)

如需向 hello-test 显示 hello-greet,您必须将 "//test:__pkg__", 添加到 ./main/BUILD 中的 visibility 属性。

现在,您可以使用 bazel test 运行测试。

bazel test test:hello-test

这会生成以下输出:

INFO: Found 1 test target...
Target //test:hello-test up-to-date:
  bazel-bin/test/hello-test
INFO: Elapsed time: 4.497s, Critical Path: 2.53s
//test:hello-test PASSED in 0.3s

Executed 1 out of 1 tests: 1 test passes.

添加对预编译库的依赖项

如果您想使用只有编译版本(例如标头和 .so 文件)的库,请将其封装在 cc_library 规则中:

cc_library(
    name = "mylib",
    srcs = ["mylib.so"],
    hdrs = ["mylib.h"],
)

这样,工作区中的其他 C++ 目标就可以依赖于此规则。