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

回報問題 查看來源

簡介

第一次使用 Bazel 嗎？開啟 Google Play 就對了！請按照這個「第一個建構」教學課程，簡化 Bazel 的使用說明。本教學課程將定義用於 Bazel 結構定義的重要字詞，並逐步說明 Bazel 工作流程的基本概念。您可以從需要的工具開始建構及執行三個日益複雜的專案，並瞭解這些專案比較複雜的方式和原因。

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

預計完成時間：30 分鐘。

先備知識

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

接著，在您選擇的指令列工具中執行下列指令，以從 Bazel 的 GitHub 存放區擷取範例專案：

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 檔案中每個建構規則的執行個體都稱為「目標」，並指向一組特定的來源檔案和「依附元件」。目標也可以指向其他目標。

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

有了這個 BUILD 檔案，Bazel 會先建構 hello-greet 程式庫 (使用 Bazel 內建的 cc_library rule)，接著建構 hello-world 二進位檔。hello-world 目標中的 deps 屬性會告知 Bazel 需要 hello-greet 程式庫建構 hello-world 二進位檔。

建構這個新版專案之前，您必須先變更目錄，並執行下列指令來切換至 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-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` 套件中的目標。

為了讓建構成功，您可以使用瀏覽權限屬性，向 main/BUILD 中的目標明確顯示 lib/BUILD 中的 //lib:hello-time 目標。這是因為根據預設目標只會向同一 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 學習的資源：

祝您建構愉快！