BazelCon 2024 註冊現已開放！

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

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

回報問題查看原始碼夜間 7.3 7.2 7.1 7.0 6.5

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

Bazel 支援使用 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 應用程式專案。

取得範例專案

針對範例專案，請在下列位置使用基本 Android 應用程式專案： Bazel 的範例存放區。

這個應用程式只有一個按鈕，點選後會顯示問候語：

按鈕問候語

圖 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 執行已安裝 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 的路徑來自 ANDROID_NDK_HOME 環境變數。您也可以在 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 應用程式的建構規則：android_library 和 android_binary。

在本教學課程中，您會先使用 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`

執行應用程式

您現在可以前往以下網址，將應用程式部署至已連結的 Android 裝置或模擬器：使用 bazel mobile-install 指令建立指令列。這項指令會使用 Android Debug Bridge (adb)，以便與裝置通訊。您必須先按照 Android Debug Bridge 中的指示設定裝置，才能使用 adb 進行部署。個人中心您也可以在 Android 模擬器上安裝應用程式在執行下方指令前，請確認模擬器正在執行。

輸入下列指令：

bazel mobile-install //src/main:app

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

Bazel 教學課程應用程式

圖 2. Bazel 教學應用程式。

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

請注意，mobile-install 子指令也支援 --incremental 旗標，可用於僅部署應用程式內自上次部署後有變更的部分。

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