搭配 Bazel 使用 Android 原生開發套件

回報問題 查看來源 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

如果您是 Bazel 新手,請先參閱「使用 Bazel 建構 Android 應用程式」教學課程。

總覽

Bazel 可在許多不同的建構設定中執行,包括使用 Android Native Development Kit (NDK) 工具鍊的設定。也就是說,您可以在 Bazel 中直接為 Android 編譯一般 cc_librarycc_binary 規則。Bazel 會使用 android_ndk_repository 存放區規則來完成這項作業。

必要條件

請確認您已安裝 Android SDK 和 NDK。

如要設定 SDK 和 NDK,請在 WORKSPACE 中加入下列程式碼片段:

android_sdk_repository(
    name = "androidsdk", # Required. Name *must* be "androidsdk".
    path = "/path/to/sdk", # Optional. Can be omitted if `ANDROID_HOME` environment variable is set.
)

android_ndk_repository(
    name = "androidndk", # Required. Name *must* be "androidndk".
    path = "/path/to/ndk", # Optional. Can be omitted if `ANDROID_NDK_HOME` environment variable is set.
)

如要進一步瞭解 android_ndk_repository 規則,請參閱「建構百科全書條目」。

快速入門

如要為 Android 建構 C++,只要將 cc_library 依附元件新增至 android_binaryandroid_library 規則即可。

舉例來說,假設 Android 應用程式的 BUILD 檔案如下:

# In <project>/app/src/main/BUILD.bazel

cc_library(
    name = "jni_lib",
    srcs = ["cpp/native-lib.cpp"],
)

android_library(
    name = "lib",
    srcs = ["java/com/example/android/bazel/MainActivity.java"],
    resource_files = glob(["res/**/*"]),
    custom_package = "com.example.android.bazel",
    manifest = "LibraryManifest.xml",
    deps = [":jni_lib"],
)

android_binary(
    name = "app",
    deps = [":lib"],
    manifest = "AndroidManifest.xml",
)

這個 BUILD 檔案會產生下列目標圖表:

搜尋結果範例

圖 1. 使用 cc_library 依附元件建構 Android 專案的圖表。

如要建構應用程式,只要執行下列指令即可:

bazel build //app/src/main:app

bazel build 指令會編譯 Java 檔案、Android 資源檔案和 cc_library 規則,並將所有內容封裝到 APK 中:

$ zipinfo -1 bazel-bin/app/src/main/app.apk
nativedeps
lib/armeabi-v7a/libapp.so
classes.dex
AndroidManifest.xml
...
res/...
...
META-INF/CERT.SF
META-INF/CERT.RSA
META-INF/MANIFEST.MF

Bazel 會將所有 cc_libraries 編譯成單一共用物件 (.so) 檔案,預設目標為 armeabi-v7a ABI。如要變更這項設定或同時為多個 ABI 建構,請參閱設定目標 ABI 一節。

設定範例

這個範例位於 Bazel 範例存放區

BUILD.bazel 檔案中,系統會使用 android_binaryandroid_librarycc_library 規則定義三個目標。

android_binary 頂層目標會建構 APK。

cc_library 目標包含單一 C++ 來源檔案,其中含有 JNI 函式實作:

#include <jni.h>
#include <string>

extern "C"
JNIEXPORT jstring

JNICALL
Java_com_example_android_bazel_MainActivity_stringFromJNI(
        JNIEnv *env,
        jobject /* this */) {
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

android_library 目標會指定 Java 來源、資源檔案,以及對 cc_library 目標的依附元件。在本範例中,MainActivity.java 會載入共用物件檔案 libapp.so,並定義 JNI 函式的方法簽章:

public class MainActivity extends AppCompatActivity {

    static {
        System.loadLibrary("app");
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
       // ...
    }

    public native String stringFromJNI();

}

設定 STL

如要設定 C++ STL,請使用 --android_crosstool_top 標記。

bazel build //:app --android_crosstool_top=target label

@androidndk 中可用的 STL 如下:

STL 目標標籤
STLport @androidndk//:toolchain-stlport
libc++ @androidndk//:toolchain-libcpp
gnustl @androidndk//:toolchain-gnu-libstdcpp

在 r16 以下版本中,預設 STL 為 gnustl。如果是 r17 以上版本,則為 libc++。為方便起見,目標 @androidndk//:default_crosstool 會別名為對應的預設 STL。

請注意,自 r18 起,STLport 和 gnustl 將會移除,因此 NDK 中只會留下 libc++ 這項 STL。

如要進一步瞭解這些 STL,請參閱 NDK 說明文件

設定目標 ABI

如要設定目標 ABI,請使用 --fat_apk_cpu 旗標,如下所示:

bazel build //:app --fat_apk_cpu=comma-separated list of ABIs

根據預設,Bazel 會為 armeabi-v7a 建構原生 Android 程式碼。如要為 x86 建構 (例如模擬器),請傳遞 --fat_apk_cpu=x86。如要為多種架構建立胖 APK,可以指定多個 CPU:--fat_apk_cpu=armeabi-v7a,x86

如果指定多個 ABI,Bazel 會建構 APK,其中包含每個 ABI 的共用物件。

視 NDK 修訂版本和 Android API 級別而定,可用的 ABI 如下:

NDK 修訂版本 ABI
16 以下 armeabi、armeabi-v7a、arm64-v8a、mips、mips64、x86、x86_64
17 歲以上 armeabi-v7a、arm64-v8a、x86、x86_64

如要進一步瞭解這些 ABI,請參閱 NDK 說明文件

不建議在發布版本中使用多 ABI 笨重 APK,因為這會增加 APK 的大小,但對於開發和 QA 版本來說可能很有用。

選取 C++ 標準

使用下列標記,根據 C++ 標準建構:

C++ 標準 檢舉
C++98 預設值,不需要任何標記
C++11 --cxxopt=-std=c++11
C++14 --cxxopt=-std=c++14

例如:

bazel build //:app --cxxopt=-std=c++11

如要進一步瞭解如何使用 --cxxopt--copt--linkopt 傳遞編譯器和連結器標記,請參閱使用者手冊

編譯器和連接器標記也可以在 cc_library 中指定為屬性,方法是使用 coptslinkopts。例如:

cc_library(
    name = "jni_lib",
    srcs = ["cpp/native-lib.cpp"],
    copts = ["-std=c++11"],
    linkopts = ["-ldl"], # link against libdl
)

與平台和工具鍊整合

Bazel 的設定模型正朝向平台工具鍊發展。如果您的建構作業使用 --platforms 標記選取要建構的架構或作業系統,您需要將 --extra_toolchains 標記傳遞至 Bazel,才能使用 NDK。

舉例來說,如要與 Go 規則提供的 android_arm64_cgo 工具鍊整合,請傳遞 --extra_toolchains=@androidndk//:all--platforms 旗標。

bazel build //my/cc:lib \
  --platforms=@io_bazel_rules_go//go/toolchain:android_arm64_cgo \
  --extra_toolchains=@androidndk//:all

您也可以直接在 WORKSPACE 檔案中註冊:

android_ndk_repository(name = "androidndk")
register_toolchains("@androidndk//:all")

註冊這些工具鍊會告知 Bazel,在解析架構和作業系統限制時,於 NDK BUILD 檔案 (適用於 NDK 20) 中尋找這些工具鍊:

toolchain(
  name = "x86-clang8.0.7-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:x86_32",
  ],
  toolchain = "@androidndk//:x86-clang8.0.7-libcpp",
)

toolchain(
  name = "x86_64-clang8.0.7-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:x86_64",
  ],
  toolchain = "@androidndk//:x86_64-clang8.0.7-libcpp",
)

toolchain(
  name = "arm-linux-androideabi-clang8.0.7-v7a-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:arm",
  ],
  toolchain = "@androidndk//:arm-linux-androideabi-clang8.0.7-v7a-libcpp",
)

toolchain(
  name = "aarch64-linux-android-clang8.0.7-libcpp_toolchain",
  toolchain_type = "@bazel_tools//tools/cpp:toolchain_type",
  target_compatible_with = [
      "@platforms//os:android",
      "@platforms//cpu:aarch64",
  ],
  toolchain = "@androidndk//:aarch64-linux-android-clang8.0.7-libcpp",
)

運作方式:Android 設定轉換簡介

android_binary 規則可明確要求 Bazel 在 Android 相容的設定中建構依附元件,因此 Bazel 建構作業「可正常運作」,不需要任何特殊標記,但 ABI 和 STL 設定的 --fat_apk_cpu--android_crosstool_top 除外。

在幕後,這項自動設定會使用 Android 設定轉換

相容的規則 (例如 android_binary) 會自動將依附元件的設定變更為 Android 設定,因此只有建構作業中特定於 Android 的子樹狀結構會受到影響。建構圖的其他部分會使用頂層目標設定處理。如果建構圖中有路徑支援,甚至可能在兩種設定中處理單一目標。

一旦 Bazel 處於與 Android 相容的設定 (在頂層指定,或因層級較高的轉換點而處於此設定),遇到的其他轉換點就不會進一步修改設定。

唯一會觸發轉換至 Android 設定的內建位置是 android_binarydeps 屬性。

舉例來說,如果您嘗試建構具有 cc_library 依附元件的 android_library 目標,但沒有任何標記,可能會遇到缺少 JNI 標頭的錯誤:

ERROR: project/app/src/main/BUILD.bazel:16:1: C++ compilation of rule '//app/src/main:jni_lib' failed (Exit 1)
app/src/main/cpp/native-lib.cpp:1:10: fatal error: 'jni.h' file not found
#include <jni.h>
         ^~~~~~~
1 error generated.
Target //app/src/main:lib failed to build
Use --verbose_failures to see the command lines of failed build steps.

理想情況下,這些自動轉換應可讓 Bazel 在大多數情況下執行正確操作。不過,如果 Bazel 指令列上的目標已低於任何這類轉換規則 (例如 C++ 開發人員測試特定 cc_library),則必須使用自訂 --crosstool_top

不使用 android_binary 建構 Android 專用的 cc_library

如要為 Android 建構獨立的 cc_binarycc_library,而不使用 android_binary,請使用 --crosstool_top--cpu--host_crosstool_top 標記。

例如:

bazel build //my/cc/jni:target \
      --crosstool_top=@androidndk//:default_crosstool \
      --cpu=<abi> \
      --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

在本範例中,頂層 cc_librarycc_binary 目標是使用 NDK 工具鍊建構而成。不過,這會導致 Bazel 自己的主機工具使用 NDK 工具鍊 (因此適用於 Android) 建構,因為主機工具鍊是從目標工具鍊複製而來。如要解決這個問題,請將 --host_crosstool_top 的值指定為 @bazel_tools//tools/cpp:toolchain,明確設定主機的 C++ 工具鍊。

採用這種做法會影響整個建構樹狀結構。

這些標記可以放入 bazelrc config (每個 ABI 各一個),位於 project/.bazelrc 中:

common:android_x86 --crosstool_top=@androidndk//:default_crosstool
common:android_x86 --cpu=x86
common:android_x86 --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

common:android_armeabi-v7a --crosstool_top=@androidndk//:default_crosstool
common:android_armeabi-v7a --cpu=armeabi-v7a
common:android_armeabi-v7a --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

# In general
common:android_<abi> --crosstool_top=@androidndk//:default_crosstool
common:android_<abi> --cpu=<abi>
common:android_<abi> --host_crosstool_top=@bazel_tools//tools/cpp:toolchain

然後,如要為 x86 建構 cc_library,請執行:

bazel build //my/cc/jni:target --config=android_x86

一般來說,這個方法適用於低階目標 (例如 cc_library),或您確切知道要建構的內容時;對於您預期要建構大量不受控目標的高階目標,請依賴 android_binary 的自動設定轉換。