您可以在此处找到一些最常见的用例,了解如何使用 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
文件(不包括子目录)。
使用传递性包含
如果某个文件包含头文件,则以该文件为来源(即在 srcs
、hdrs
或 textual_hdrs
属性中包含该文件)的任何规则都应依赖于所包含头文件的库规则。反之,只有直接依赖项需要指定为依赖项。例如,假设 sandwich.h
包含 bread.h
,而 bread.h
包含 flour.h
。sandwich.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 目录。例如,假设您有以下目录结构:
└── 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"
。为了使该包含路径有效,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{: .external}。您可以在 MODULE.bazel
文件中添加对它的依赖项,以下载 Google Test 并使其在您的代码库中可用:
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//:gtest_main",
"//main:hello-greet",
],
)
如需让 hello-greet
对 hello-test
可见,您必须在 ./main/BUILD
中向 visibility
属性添加 "//test:__pkg__",
。
现在,您可以使用 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++ 目标就可以依赖此规则。