常见 C++ build 使用场景

您可以在这里找到一些最常见的使用场景,了解如何使用 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 文件(不包括子目录)。

使用传递性 include

如果某个文件包含头文件,则以该文件作为来源的任何规则(即 在 srcshdrstextual_hdrs 属性中包含该文件)都应 依赖于所包含头文件的库规则。相反,只需将直接依赖项指定为依赖项即可。例如,假设 sandwich.h 包含 bread.h,而 bread.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 库,而 bread 库又依赖于 flour 库。

添加 include 路径

有时,您无法(或不想)将 include 路径根植于工作区根目录。现有库可能已经有一个 include 目录,该目录与工作区中的路径不匹配。例如,假设您有以下目录结构:

└── my-project
    ├── legacy
       └── some_lib
           ├── BUILD
           ├── include
              └── some_lib.h
           └── some_lib.cc
    └── MODULE.bazel

Bazel 会将 some_lib.h 预期为以 legacy/some_lib/include/some_lib.h 的形式添加,但假设 some_lib.cc 添加了 "some_lib.h"。如需使该 include 路径有效,legacy/some_lib/BUILD 需要指定 some_lib/include 目录是一个 include 目录:

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

这对于外部依赖项尤其有用,因为它们的头文件必须以 / 前缀添加。

添加外部库

假设您使用的是 Google 测试 {: .external}。 您可以在 MODULE.bazel 文件中添加对它的依赖项,以下载 Google 测试并使其在您的代码库中可用:

bazel_dep(name = "googletest", version = "1.15.2")

编写和运行 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/googletest/include",
      "-Iexternal/gtest/googletest",
    ],
    deps = [
        "@googletest//:main",
        "//main:hello-greet",
    ],
)

如需使 hello-greethello-test 可见,您必须将 "//test:__pkg__", 添加到 visibility 属性中 ./main/BUILD

现在,您可以使用 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++ 目标就可以依赖于此规则。