Bazel 教學課程：建構 C++ 專案

回報問題 查看原始碼 夜間 7.4 ，直接在 Google Cloud 控制台實際操作。 7.3 · 7.2 · 7.1 · 7.0 · 6.5

簡介

第一次使用 Bazel？開啟 Google Play 就對了！請按照這個「First Build」教學課程 以簡化使用 Bazel 的簡介。本教學課程將定義重要詞彙 用於 Bazel 環境，並逐步引導您瞭解 Bazel 的基本概念 工作流程您將從所需工具著手，建構並執行三個複雜度逐漸增加的專案，並瞭解複雜度增加的原因和方式。

雖然 Bazel 是支援多語言建構的建構系統，但本教學課程會以 C++ 專案做為範例，並提供適用於多數語言的一般指南和流程。

預估完成時間：30 分鐘。

必要條件

首先請安裝 Bazel (如果您尚未安裝) 本教學課程使用 Git 控管原始碼，因此以獲得最佳結果 安裝 Git

接著，執行 安裝在您選擇的指令列工具中：

git clone https://github.com/bazelbuild/examples

本教學課程的範例專案位於 examples/cpp-tutorial 目錄中。

請參閱下方結構說明：

examples
└── cpp-tutorial
    ├──stage1
    │  ├── main
    │  │   ├── BUILD
    │  │   └── hello-world.cc
    │  └── WORKSPACE
    ├──stage2
    │  ├── main
    │  │   ├── BUILD
    │  │   ├── hello-world.cc
    │  │   ├── hello-greet.cc
    │  │   └── hello-greet.h
    │  └── WORKSPACE
    └──stage3
       ├── main
       │   ├── BUILD
       │   ├── hello-world.cc
       │   ├── hello-greet.cc
       │   └── hello-greet.h
       ├── lib
       │   ├── BUILD
       │   ├── hello-time.cc
       │   └── hello-time.h
       └── WORKSPACE

有三組檔案，每組都代表本教學課程中的一個階段。 在第一階段，您將建構單一目標，並位於單一套件中。在第二階段，您將從單一套件建構二進位檔和程式庫。在第三個也是最後一個階段，您將建構包含多個套件的專案，並以多個目標建構專案。

摘要：簡介

安裝 Bazel (和 Git) 並複製本教學課程的存放區後，您就已為首次使用 Bazel 建構作業奠定基礎。前往下一項 來定義字詞及設定工作區。

開始使用

設定工作區

您必須先設定工作區，才能建構專案。工作區是 存放專案來源檔案和 Bazel 建構輸出內容的目錄。這項服務 也包含下列重要檔案：

  • WORKSPACE file ：可將目錄及其內容識別為 Bazel 工作區，並位於專案目錄結構的根目錄。
  • 一或多個 BUILD files ，可告知 Bazel 如何建構專案的不同部分。工作區內含有 BUILD 檔案的目錄即為套件。(進一步瞭解套件 其他部分)。

在日後的專案中，如要將目錄指定為 Bazel 工作區，請在該目錄中建立名為 WORKSPACE 的空白檔案。為了配合本教學課程，每個階段都已包含 WORKSPACE 檔案。

附註：Bazel 在建構專案時，所有輸入都必須位於 同一個工作區除非連結，否則位於不同工作區的檔案是彼此獨立的。進一步瞭解工作區規則 請參閱這份指南。

瞭解 BUILD 檔案

BUILD 檔案包含多種不同類型的 Bazel 指示。每項 BUILD 檔案需要至少一個規則 是一組指示指示 Bazel 如何建構所需輸出內容 例如可執行的二進位檔或程式庫這個模型中每個建構規則的執行個體 BUILD 檔案稱為目標 並指向一組特定的來源檔案和dependencies。 目標也可以指向其他目標。

請查看 cpp-tutorial/stage1/main 目錄中的 BUILD 檔案：

cc_binary(
    name = "hello-world",
    srcs = ["hello-world.cc"],
)

在我們的範例中，hello-world 目標會將 Bazel 的內建項目執行個體化 cc_binary rule。 這項規則會告知 Bazel 從 hello-world.cc 來源檔案 (沒有依附元件)。

摘要：開始使用

您現在已熟悉一些重要字詞，以及這些詞彙的用意 這個專案和 Bazel在下一節中，您將建構及測試 專案的第 1 階段。

第 1 階段：單一目標、單一套件

現在該來著手進行專案的第一部分了。如需視覺參考， 專案的第 1 階段的結構如下

examples
└── cpp-tutorial
    └──stage1
       ├── main
       │   ├── BUILD
       │   └── hello-world.cc
       └── WORKSPACE

執行下列指令，移至 cpp-tutorial/stage1 目錄：

cd cpp-tutorial/stage1

接著執行：

bazel build //main:hello-world

在目標標籤中，//main: 部分是 BUILD 檔案相對於工作區根目錄的位置，而 hello-world 則是 BUILD 檔案中的目標名稱。

Bazel 會產生如下所示的內容：

INFO: Found 1 target...
Target //main:hello-world up-to-date:
  bazel-bin/main/hello-world
INFO: Elapsed time: 2.267s, Critical Path: 0.25s

您剛剛建構了第一個 Bazel 目標。Bazel 會將建構輸出內容放在 bazel-bin 目錄，位於 工作區

接下來，請測試您新建的二進位檔：

bazel-bin/main/hello-world

這會產生列印的「Hello world」訊息。

以下是第 1 階段的依附元件圖：

hello-world 的依附元件圖會顯示單一目標和單一來源檔案。

摘要：第 1 階段

現在您已完成第一個建構作業，因此大致瞭解建構方式 的結構在下一個階段，您將透過新增其他目標來增加複雜度。

階段 2：多個建構目標

雖然一個目標就足以滿足小型專案的需求，而您可能想要 導入多個目標和套件這樣一來，您就能快速進行增量建構作業 (也就是 Bazel 只會重建變更的項目)，並透過一次建構多個專案部分來加快建構作業。 教學課程會新增目標，接下來則會新增套件

這是您在第 2 階段使用的目錄：

    ├──stage2
    │  ├── main
    │  │   ├── BUILD
    │  │   ├── hello-world.cc
    │  │   ├── hello-greet.cc
    │  │   └── hello-greet.h
    │  └── WORKSPACE

請參考下方 cpp-tutorial/stage2/main 目錄中的 BUILD 檔案：

cc_library(
    name = "hello-greet",
    srcs = ["hello-greet.cc"],
    hdrs = ["hello-greet.h"],
)

cc_binary(
    name = "hello-world",
    srcs = ["hello-world.cc"],
    deps = [
        ":hello-greet",
    ],
)

Bazel 會先利用這個 BUILD 檔案建構 hello-greet 程式庫。 (使用 Bazel 內建的 cc_library rule) 然後是 hello-world 二進位檔。hello-world 目標中的 deps 屬性會告訴 Bazel，建構 hello-world 二進位檔時需要 hello-greet 程式庫。

您必須先變更 請執行以下指令，切換至 cpp-tutorial/stage2 目錄：

cd ../stage2

您現在可以使用下列熟悉的指令建構新的二進位檔：

bazel build //main:hello-world

同樣地，Bazel 會產生類似以下的內容：

INFO: Found 1 target...
Target //main:hello-world up-to-date:
  bazel-bin/main/hello-world
INFO: Elapsed time: 2.399s, Critical Path: 0.30s

您現在可以測試剛建構的二進位檔，它會傳回另一個「Hello world」：

bazel-bin/main/hello-world

如果現在修改 hello-greet.cc 並重新建構專案，Bazel 只會重新編譯該檔案。

查看依附元件圖表時，您會發現 hello-world 依附額外輸入內容 名為 hello-greet：

`hello-world` 的依附元件圖會在檔案修改後顯示依附元件變更。

摘要：第 2 階段

您現在已建構含有兩個目標的專案。hello-world 目標版本 一個來源檔案，並依附另一個目標 (//main:hello-greet)，而 建立兩個額外的來源檔案在下一節中，我們將進一步新增其他套件。

階段 3：多個套件

下一個階段加入另一層小工具，並使用 管理多個套件請參閱下方 cpp-tutorial/stage3 目錄的結構和內容：

└──stage3
   ├── main
   │   ├── BUILD
   │   ├── hello-world.cc
   │   ├── hello-greet.cc
   │   └── hello-greet.h
   ├── lib
   │   ├── BUILD
   │   ├── hello-time.cc
   │   └── hello-time.h
   └── WORKSPACE

可以看到現在有兩個子目錄，且每個子目錄都包含 BUILD 檔案。因此，在 Bazel 中，工作區現在包含兩個套件：lib 和 main。

請看看 lib/BUILD 檔案：

cc_library(
    name = "hello-time",
    srcs = ["hello-time.cc"],
    hdrs = ["hello-time.h"],
    visibility = ["//main:__pkg__"],
)

在 main/BUILD 檔案中：

cc_library(
    name = "hello-greet",
    srcs = ["hello-greet.cc"],
    hdrs = ["hello-greet.h"],
)

cc_binary(
    name = "hello-world",
    srcs = ["hello-world.cc"],
    deps = [
        ":hello-greet",
        "//lib:hello-time",
    ],
)

主套件中的 hello-world 目標會依附 lib 套件中的 hello-time 目標 (因此是目標標籤 //lib:hello-time) - Bazel 會透過 deps 屬性瞭解這一點。您可以在依附元件圖中看到這項資訊：

`hello-world` 的依附元件圖表會顯示主套件中的目標如何依附 `lib` 套件中的目標。

為了讓建構作業成功，您可以使用可見度屬性，讓 lib/BUILD 中的 //lib:hello-time 目標明確顯示在 main/BUILD 中的目標。這是因為根據預設，只有同一個帳戶的其他目標才能查看 BUILD 檔案。Bazel 會使用目標可見度來避免發生問題，例如程式庫包含實作細節，而這些細節會外洩至公開 API。

接著建構這個專案的最終版本。切換至 cpp-tutorial/stage3 執行以下命令：

cd  ../stage3

再次執行下列指令：

bazel build //main:hello-world

Bazel 會產生如下所示的內容：

INFO: Found 1 target...
Target //main:hello-world up-to-date:
  bazel-bin/main/hello-world
INFO: Elapsed time: 0.167s, Critical Path: 0.00s

現在請測試本教學課程的最後一個二進位檔，看看最後的 Hello world 訊息：

bazel-bin/main/hello-world

摘要：階段 3

您現在已將專案建構為兩個套件，其中包含三個目標，並瞭解 掌握依附元件 可在專案中使用 Bazel 執行在下一節中，我們將說明如何繼續您的 Bazel 學習之旅。

後續步驟

您現在已完成使用 Bazel 進行的第一個基本建構作業，但這只是開始。以下是一些繼續透過 Bazel 學習的資源：

祝您建構愉快！