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 Emulator 或實體裝置上部署及執行應用程式。

事前準備

安裝 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.xmlsrc/main/java/com/example/bazel/AndroidManifest.xml
Android 來源檔案 src/main/java/com/example/bazel/MainActivity.javaGreeter.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)

您也可以加入 pathapi_levelbuild_tools_version 屬性,明確指定 Android SDK 的絕對路徑、API 級別,以及要使用的建構工具版本。如未指定 api_levelbuild_tools_versionandroid_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 原生開發套件與 Bazel 搭配使用」。

api_level 是 SDK 和 NDK 指定的 Android API 版本,例如 Android 6.0 為 23,Android 7.1 則為 25。如果未明確設定,android_sdk_repositoryandroid_ndk_repositoryapi_level 預設會預設為可用的最高 API 級別。

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

建立 BUILD 檔案

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

BUILD 檔案是 Bazel 中稱為「套件階層」的概念。套件階層是疊加在工作區中目錄結構的邏輯結構。每個套件都是一個目錄 (及其子目錄),內含一組相關的來源檔案和 BUILD 檔案。套件也包含任何子目錄,但不包括包含自有 BUILD 檔案的子目錄。套件名稱是相對於 WORKSPACEBUILD 檔案路徑。

請注意,Bazel 的套件階層在概念上與 BUILD 檔案所在的 Android 應用程式目錄 Java 套件階層不同,但目錄整理方式可能完全相同。

就本教學課程中的簡易 Android 應用程式而言,src/main/ 中的來源檔案會包含單一 Bazel 套件。較複雜的專案可能會有許多巢狀套件。

新增 android_library 規則

BUILD 檔案包含多種 Bazel 的宣告類型。最重要的類型是建構規則,此規則會告知 Bazel 如何從一組來源檔案或其他依附元件,建構中間或最終的軟體輸出內容。Bazel 提供 android_libraryandroid_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 Emulator 中安裝應用程式。請先確認模擬器正在執行,再執行下列指令。

輸入下列指令:

bazel mobile-install //src/main:app

接下來,請找出並啟動「Bazel 教學課程應用程式」:

Bazel 教學課程應用程式

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

恭喜!您已安裝第一個以 Bazel 建構的 Android 應用程式。

請注意,mobile-install 子指令也支援 --incremental 旗標,您可以透過旗標,僅部署自上次部署作業後變更的應用程式部分。

它也支援 --start_app 旗標,可在安裝時立即啟動應用程式。

其他資訊

如需詳細資訊,請參閱以下頁面:

祝建設愉快!