本頁面由 Cloud Translation API 翻譯而成。

Bazel 教學課程：建構 Android 應用程式

注意：使用 Bazel 建構 Android 應用程式時有一些已知的限制。請前往 GitHub team-Android 熱點清單，查看已知問題清單。雖然 Bazel 團隊與開放原始碼軟體 (OSS) 貢獻者會積極解決已知問題，但使用者應瞭解 Android Studio 並未正式支援 Bazel 專案。

本教學課程說明如何使用 Bazel 建構簡易的 Android 應用程式。

Bazel 支援使用 Android 規則建構 Android 應用程式。

本教學課程的適用對象為 Windows、macOS 和 Linux 使用者，且不需要 Bazel 或 Android 應用程式開發經驗。您不需要在本教學課程中編寫任何 Android 程式碼。

課程內容

在本教學課程中，您會瞭解如何執行下列作業：

安裝 Bazel 和 Android Studio，並下載範例專案來設定環境。
設定 Bazel 工作區，其中包含應用程式原始碼，以及識別工作區目錄頂層的 WORKSPACE 檔案。
更新 WORKSPACE 檔案，納入必要外部依附元件 (例如 Android SDK) 的參照。
建立 BUILD 檔案。
使用 Bazel 建構應用程式。
在 Android 模擬器或實體裝置上部署及執行應用程式。

事前準備

安裝 Bazel

開始教學課程前，請先安裝下列軟體：

Bazel.按照安裝操作說明進行安裝。
Android Studio：如要安裝，請按照這裡的步驟下載 Android Studio。執行設定精靈以下載 SDK 並設定環境。
(選用) Git.使用 git 下載 Android 應用程式專案。

取得範例專案

針對範例專案，請在 Bazel 的範例存放區中使用基本的 Android 應用程式專案。

此應用程式有單一按鈕，可在使用者點選時列印問候語：

按鈕問候語

圖 1 Android 應用程式按鈕問候語。

使用 git 複製存放區 (或直接下載 ZIP 檔案)：

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

本教學課程的範例專案位於 examples/android/tutorial。在本教學課程的其餘部分，您將在這個目錄中執行指令。

查看來源檔案

查看應用程式的來源檔案。

.
├── README.md
└── src
    └── main
        ├── AndroidManifest.xml
        └── java
            └── com
                └── example
                    └── bazel
                        ├── AndroidManifest.xml
                        ├── Greeter.java
                        ├── MainActivity.java
                        └── res
                            ├── layout
                            │   └── activity_main.xml
                            └── values
                                ├── colors.xml
                                └── strings.xml

主要檔案和目錄如下：

名稱	位置
Android 資訊清單檔案	`src/main/AndroidManifest.xml`和`src/main/java/com/example/bazel/AndroidManifest.xml`
Android 來源檔案	`src/main/java/com/example/bazel/MainActivity.java`和`Greeter.java`
資源檔案目錄	`src/main/java/com/example/bazel/res/`

使用 Bazel 進行建構

設定工作區

「工作區」目錄包含一或多項軟體專案的來源檔案，且根層級有 WORKSPACE 檔案。

WORKSPACE 檔案可能空白，或是包含建構專案所需的外部依附元件參照項目。

首先，請執行下列指令來建立空白的 WORKSPACE 檔案：

作業系統	指令
Linux、macOS	`touch WORKSPACE`
Windows (命令提示字元)	`type nul > WORKSPACE`
Windows (PowerShell)	`New-Item WORKSPACE -ItemType file`

執行 Bazel

現在您可以使用下列指令檢查 Bazel 是否正常執行：

bazel info workspace

如果 Bazel 輸出目前目錄的路徑，就可以出發了！如果 WORKSPACE 檔案不存在，您會看到下列錯誤訊息：

ERROR: The 'info' command is only supported from within a workspace.

與 Android SDK 整合

Bazel 必須執行 Android SDK 建構工具以建構應用程式。這代表您必須在 WORKSPACE 檔案中新增一些資訊，讓 Bazel 知道要在哪裡找到這些資訊。

在 WORKSPACE 檔案中新增下列程式碼：

android_sdk_repository(name = "androidsdk")

這會在 ANDROID_HOME 環境變數參照的路徑中使用 Android SDK，並自動偵測該位置內安裝的最高 API 級別和最新版建構工具。

您可以將 ANDROID_HOME 變數設為 Android SDK 的位置。使用 Android Studio 的 SDK Manager 找出已安裝 SDK 的路徑。假設 SDK 安裝在預設位置，您可以使用下列指令設定 ANDROID_HOME 變數：

作業系統	指令
Linux	`export ANDROID_HOME=$HOME/Android/Sdk/`
macOS	`export ANDROID_HOME=$HOME/Library/Android/sdk`
Windows (命令提示字元)	`set ANDROID_HOME=%LOCALAPPDATA%\Android\Sdk`
Windows (PowerShell)	`$env:ANDROID_HOME="$env:LOCALAPPDATA\Android\Sdk"`

上述指令只會為目前的殼層工作階段設定變數。如要永久顯示這些資料，請執行下列指令：

作業系統	指令
Linux	`echo "export ANDROID_HOME=$HOME/Android/Sdk/" >> ~/.bashrc`
macOS	`echo "export ANDROID_HOME=$HOME/Library/Android/Sdk/" >> ~/.bashrc`
Windows (命令提示字元)	`setx ANDROID_HOME "%LOCALAPPDATA%\Android\Sdk"`
Windows (PowerShell)	`[System.Environment]::SetEnvironmentVariable('ANDROID_HOME', "$env:LOCALAPPDATA\Android\Sdk", [System.EnvironmentVariableTarget]::User)`

您也可以加入 path、api_level 和 build_tools_version 屬性，明確指定 Android SDK 的絕對路徑、API 級別和要使用的建構工具版本。如未指定 api_level 和 build_tools_version，android_sdk_repository 規則會使用 SDK 提供的相應最新版本。您可以指定這些屬性的任何組合，只要這些屬性存在於 SDK 中即可，例如：

android_sdk_repository(
    name = "androidsdk",
    path = "/path/to/Android/sdk",
    api_level = 25,
    build_tools_version = "30.0.3"
)

在 Windows 上，請注意 path 屬性必須使用混合樣式路徑，也就是具有正斜線的 Windows 路徑：

android_sdk_repository(
    name = "androidsdk",
    path = "c:/path/to/Android/sdk",
)

選用步驟：如要將原生程式碼編譯至 Android 應用程式，您還需要下載 Android NDK，並在 WORKSPACE 檔案中加入以下這一行，告知 Bazel 可以在哪裡找到該程式碼：

android_ndk_repository(name = "androidndk")

與 android_sdk_repository 類似，根據預設，系統會透過 ANDROID_NDK_HOME 環境變數推論 Android NDK 的路徑。您也可以使用 android_ndk_repository 上的 path 屬性明確指定路徑。

詳情請參閱將 Android Native Development Kit 與 Bazel 搭配使用。

api_level 是 SDK 和 NDK 的目標 Android API 版本，例如 Android 6.0 為 23，Android 7.1 則為 25。如未明確設定，api_level 會預設為 android_sdk_repository 和 android_ndk_repository 可用的最高 API 級別。

您不需要將 SDK 和 NDK 的 API 級別設為相同的值。這個頁面包含從 Android 版本到支援 NDK 的 API 級別的對應表。

建立 BUILD 檔案

BUILD 檔案說明一組建構輸出內容之間的關係，例如來自 aapt 的已編譯 Android 資源，或 javac 的類別檔案，以及其依附元件。這些依附元件可能是工作區或其他建構輸出內容中的來源檔案 (Java、C++)。BUILD 檔案是以名為 Starlark 的語言編寫。

BUILD 檔案是 Bazel 中稱為套件階層的概念的一部分。套件階層是一種邏輯結構，覆蓋工作區中的目錄結構。每個套件都是一個目錄 (及其子目錄)，其中包含一組相關的來源檔案和 BUILD 檔案。套件也包含所有子目錄，不包括含有自己的 BUILD 檔案的子目錄。「套件名稱」是相對於 WORKSPACE 的 BUILD 檔案路徑。

請注意，Bazel 的套件階層在概念上與 Android 應用程式目錄的 Java 套件階層 (即 BUILD 檔案的所在位置) 不同，雖然目錄的整理方式可能相同。

針對本教學課程中的簡易 Android 應用程式，src/main/ 中的來源檔案內含單一 Bazel 套件。較複雜的專案可能會有多個巢狀套件。

新增 android_library 規則

BUILD 檔案包含多種不同類型的 Bazel 宣告。最重要的類型是建構規則，這會告知 Bazel 如何從一組來源檔案或其他依附元件建構中繼或最終軟體輸出。Bazel 提供 android_library 和 android_binary 兩種建構規則，可用來建構 Android 應用程式。

針對本教學課程，您必須先使用 android_library 規則，指示 Bazel 從應用程式原始碼和資源檔案建構 Android 程式庫模組。接下來，請使用 android_binary 規則告知 Bazel 如何建構 Android 應用程式套件。

在 src/main/java/com/example/bazel 目錄中建立新的 BUILD 檔案，並宣告新的 android_library 目標：

src/main/java/com/example/bazel/BUILD:

package(
    default_visibility = ["//src:__subpackages__"],
)

android_library(
    name = "greeter_activity",
    srcs = [
        "Greeter.java",
        "MainActivity.java",
    ],
    manifest = "AndroidManifest.xml",
    resource_files = glob(["res/**"]),
)

android_library 建構規則包含一組屬性，用於指定 Bazel 從來源檔案建構程式庫模組所需的資訊。另請注意，規則名稱是 greeter_activity。您可以在 android_binary 規則中，使用這個名稱做為依附元件來參照規則。

新增 android_binary 規則

android_binary 規則會為您的應用程式建構 Android 應用程式套件 (.apk 檔案)。

在 src/main/ 目錄中建立新的 BUILD 檔案，並宣告新的 android_binary 目標：

src/main/BUILD:

android_binary(
    name = "app",
    manifest = "AndroidManifest.xml",
    deps = ["//src/main/java/com/example/bazel:greeter_activity"],
)

這裡，deps 屬性會參照您在上方 BUILD 檔案中加入的 greeter_activity 規則輸出內容。換句話說，Bazel 在建構這項規則的輸出內容時，會先檢查 greeter_activity 程式庫規則的輸出內容是否已建構完成，並且是最新的內容。如果沒有，Bazel 會在建構後使用該輸出內容建構應用程式套件檔案。

現在請儲存並關閉檔案。

建構應用程式

請嘗試建構應用程式！執行下列指令來建構 android_binary 目標：

bazel build //src/main:app

build 子指令會指示 Bazel 建構接下來的目標。系統會將目標指定為 BUILD 檔案中的建構規則名稱，以及相對於工作區目錄的套件路徑。在這個範例中，目標為 app，套件路徑為 //src/main/。

請注意，有時您可以根據指令列中的目前工作目錄和目標名稱，省略套件路徑或目標名稱。如要進一步瞭解目標標籤和路徑，請參閱標籤。

Bazel 將開始建構範例應用程式。在建構程序中，其輸出內容會類似以下所示：

INFO: Analysed target //src/main:app (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //src/main:app up-to-date:
  bazel-bin/src/main/app_deploy.jar
  bazel-bin/src/main/app_unsigned.apk
  bazel-bin/src/main/app.apk

找出建構輸出內容

Bazel 會將中繼和最終建構作業的輸出內容放入一組每位使用者、每個工作區的輸出目錄。這些目錄會自專案目錄頂層的以下位置建立符號連結，其中 WORKSPACE 是：

bazel-bin 會儲存二進位執行檔和其他可執行的建構輸出內容
bazel-genfiles 會儲存 Bazel 規則產生的中介來源檔案
bazel-out 會儲存其他類型的建構輸出內容

Bazel 會將使用 android_binary 規則產生的 Android .apk 檔案儲存在 bazel-bin/src/main 目錄中，其中子目錄名稱 src/main 衍生自 Bazel 套件的名稱。

在命令提示字元中，列出此目錄的內容並找出 app.apk 檔案：

作業系統	指令
Linux、macOS	`ls bazel-bin/src/main`
Windows (命令提示字元)	`dir bazel-bin\src\main`
Windows (PowerShell)	`ls bazel-bin\src\main`

執行應用程式

您現在可以使用 bazel mobile-install 指令，透過指令列將應用程式部署至已連結的 Android 裝置或模擬器。這個指令會使用 Android Debug Bridge (adb) 與裝置通訊。您必須先按照 Android Debug Bridge 中的操作說明設定裝置，才能使用 adb。您也可以選擇在 Android Studio 隨附的 Android 模擬器上安裝應用程式。在執行下方指令前，請確認模擬器正在執行。

輸入下列指令：

bazel mobile-install //src/main:app

接著，尋找並啟動「Bazel Tutorial App」：

Bazel 教學課程應用程式

圖 2. Bazel 教學課程應用程式。

恭喜！您已安裝第一個透過 Bazel 建構的 Android 應用程式。

請注意，mobile-install 子指令也支援 --incremental 標記，該標記只能用來部署自上次部署後變更的應用程式部分。

它也支援使用 --start_app 標記，在安裝時立即啟動應用程式。

其他資訊

詳情請參閱以下頁面：

在 GitHub 上開啟問題
進一步瞭解行動裝置安裝
使用 rules_jvm_external 整合來自 Maven 存放區的外部依附元件，例如 AppCompat、Guava 和 JUnit
使用 robolectric-bazel 整合執行 Robolectric 測試。
使用 Android 檢測設備測試測試應用程式
使用 NDK 將 C 和 C++ 程式碼整合到 Android 應用程式中
查看更多下列 Bazel 專案範例：

祝您建構愉快！