常见 C++ build 使用场景

报告问题 查看来源 每晚 · 7.2。 · 7.1敬上 · 7.0。 · 6.5 · 6.4

在这里,您可以找到构建 C++ 项目的一些最常见用例。 调试项目。如果您还没有构建 C++,请开始构建 使用 Bazel 创建项目(完成本教程) Bazel 简介:构建 C++ 项目

有关 cc_library 和 hdrs 头文件的信息,请参见 cc_library

在目标中包含多个文件

您可以使用 glob。 例如:

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

创建此目标后,Bazel 将构建它在.cc.h 包含此目标的 BUILD 文件所在的目录(不包括 子目录)。

使用传递包含

如果某个文件包含标头,则任何以该文件为来源的规则(即 将该文件包含在 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 库上。

添加包含路径

有时,您无法(或不想)在工作区中使用 root 包含路径 根。现有库可能已经有一个 与其在工作区中的路径保持一致。例如,假设您有以下 目录结构:

└── 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 目录是 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"),因此您必须 将该目录添加到 include 路径中。

  • 它需要关联在 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 前缀 存档结构的副产物你可以制作http_archive条形 来添加一个 strip_prefix 属性:

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++ 目标就可以依赖于此规则。