Các trường hợp sử dụng bản dựng C++ phổ biến

Báo cáo sự cố Xem nguồn

Tại đây, bạn sẽ tìm thấy một số trường hợp sử dụng phổ biến nhất để xây dựng các dự án C++ bằng Bazel. Nếu bạn chưa thực hiện việc này, hãy bắt đầu xây dựng dự án C++ bằng Bazel bằng cách hoàn thành hướng dẫn Giới thiệu về Bazel: Xây dựng dự án C++.

Để biết thông tin về tệp tiêu đề cc_library và hdrs, hãy xem cc_library.

Bao gồm nhiều tệp trong một mục tiêu

Bạn có thể đưa nhiều tệp vào một mục tiêu bằng toàn cầu. Ví dụ:

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

Với mục tiêu này, Bazel sẽ tạo tất cả các tệp .cc.h mà nó tìm thấy trong cùng một thư mục với tệp BUILD chứa mục tiêu này (ngoại trừ các thư mục con).

Sử dụng bao gồm bắc cầu

Nếu một tệp có tiêu đề, thì mọi quy tắc có tệp đó dưới dạng nguồn (nghĩa là có tệp đó trong thuộc tính srcs, hdrs hoặc textual_hdrs) đều phải phụ thuộc vào quy tắc thư viện của tiêu đề đi kèm. Ngược lại, bạn chỉ cần chỉ định các phần phụ thuộc trực tiếp làm phần phụ thuộc. Ví dụ: giả sử sandwich.h bao gồm bread.hbread.h bao gồm flour.h. sandwich.h không bao gồm flour.h (ai muốn có bột trong bánh mì kẹp?), vì vậy, tệp BUILD sẽ có dạng như sau:

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"],
)

Ở đây, thư viện sandwich phụ thuộc vào thư viện bread. Thư viện này lại phụ thuộc vào thư viện flour.

Thêm đường dẫn bao gồm

Đôi khi, bạn không thể (hoặc không muốn) thư mục gốc bao gồm các đường dẫn ở thư mục gốc của không gian làm việc. Các thư viện hiện có có thể đã có thư mục include không khớp với đường dẫn của thư mục đó trong không gian làm việc của bạn. Ví dụ: giả sử bạn có cấu trúc thư mục sau:

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

Bazel dự kiến sẽ đưa some_lib.h vào legacy/some_lib/include/some_lib.h, nhưng giả sử some_lib.cc bao gồm "some_lib.h". Để làm cho đường dẫn bao gồm này hợp lệ, legacy/some_lib/BUILD cần chỉ định rằng thư mục some_lib/include là một thư mục bao gồm:

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

Điều này đặc biệt hữu ích cho các phần phụ thuộc bên ngoài, vì các tệp tiêu đề của các phần phụ thuộc đó phải được đưa vào bằng tiền tố /.

Bao gồm các thư viện bên ngoài

Giả sử bạn đang sử dụng Google Test {: .external}. Bạn có thể sử dụng một trong các hàm kho lưu trữ trong tệp WORKSPACE để tải Google Test xuống và cung cấp hàm đó trong kho lưu trữ của bạn:

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",
)

Sau đó, hãy tạo gtest.BUILD, một tệp BUILD dùng để biên dịch Google Test. Kiểm thử của Google có một số yêu cầu "đặc biệt" khiến quy tắc cc_library trở nên phức tạp hơn:

  • googletest-release-1.10.0/googletest/src/gtest-all.cc #includes tất cả các tệp khác trong googletest-release-1.10.0/googletest/src/: loại trừ tệp đó khỏi trình biên dịch để ngăn lỗi liên kết đối với các biểu tượng trùng lặp.

  • Thư mục này sử dụng các tệp tiêu đề có liên quan đến thư mục googletest-release-1.10.0/googletest/include/ ("gtest/gtest.h"), vì vậy, bạn phải thêm thư mục đó vào đường dẫn bao gồm.

  • Ứng dụng này cần liên kết trong pthread, vì vậy, hãy thêm dưới dạng linkopt.

Do đó, quy tắc cuối cùng sẽ có dạng như sau:

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

Điều này khá phức tạp: mọi thứ đều có tiền tố googletest-release-1.10.0 là sản phẩm phụ trong cấu trúc của kho lưu trữ. Bạn có thể khiến http_archive loại bỏ tiền tố này bằng cách thêm thuộc tính 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",
)

Khi đó, gtest.BUILD sẽ có dạng như sau:

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

Giờ đây, các quy tắc cc_ có thể phụ thuộc vào @gtest//:main.

Viết và chạy kiểm thử C++

Ví dụ: bạn có thể tạo một ./test/hello-test.cc kiểm thử, chẳng hạn như:

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

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

Sau đó, hãy tạo tệp ./test/BUILD cho các kiểm thử của bạn:

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

Để hiển thị hello-greet cho hello-test, bạn phải thêm "//test:__pkg__", vào thuộc tính visibility trong ./main/BUILD.

Bây giờ, bạn có thể sử dụng bazel test để chạy kiểm thử.

bazel test test:hello-test

Kết quả sau đây:

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.

Thêm phần phụ thuộc trên thư viện được biên dịch trước

Nếu bạn muốn sử dụng một thư viện mà bạn chỉ có phiên bản đã biên dịch (ví dụ: tiêu đề và tệp .so), hãy gói thư viện đó trong một quy tắc cc_library:

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

Bằng cách này, các mục tiêu C++ khác trong không gian làm việc của bạn có thể phụ thuộc vào quy tắc này.