如果您是 Bazel 新手,請先參閱「使用 Bazel 建構 Android」教學課程。
總覽
Bazel 可以在許多不同的建構設定中執行,包括部分使用 Android Native Development Kit (NDK) 工具鍊的建構設定。也就是說,一般 cc_library
和 cc_binary
規則可直接在 Bazel 中為 Android 編譯。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
規則,請參閱 Build 百科全書條目。
如果您使用的是最新版 Android NDK (r22 以上版本),請使用 android_ndk_repository
的 Starlark 實作項目。請按照README 中的操作說明進行。
快速入門
如要建構 Android 適用的 C++,只要在 android_binary
或 android_library
規則中加入 cc_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_binary
、android_library
和 cc_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();
}
設定目標 ABI
如要設定目標 ABI,請使用 --android_platforms
旗標,如下所示:
bazel build //:app --android_platforms=comma-separated list of platforms
就像 --platforms
標記一樣,傳遞至 --android_platforms
的值是 platform
目標的標籤,使用標準限制值來描述裝置。
舉例來說,如果是搭載 64 位元 ARM 處理器的 Android 裝置,您可以這樣定義平台:
platform(
name = "android_arm64",
constraint_values = [
"@platforms//os:android",
"@platforms//cpu:arm64",
],
)
每個 Android platform
都應使用 @platforms//os:android
OS 限制。如要遷移 CPU 限制,請查看下列圖表:
CPU 值 | 平台 |
---|---|
armeabi-v7a |
@platforms//cpu:armv7 |
arm64-v8a |
@platforms//cpu:arm64 |
x86 |
@platforms//cpu:x86_32 |
x86_64 |
@platforms//cpu:x86_64 |
當然,如果是多架構 APK,您傳遞了多個標籤,例如:--android_platforms=//:arm64,//:x86_64
(假設您在頂層 BUILD.bazel
檔案中定義了這些標籤)。
Bazel 無法選取預設的 Android 平台,因此必須使用 --android_platforms
定義並指定一個平台。
視 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 |
C++17 | --cxxopt=-std=c++17 |
例如:
bazel build //:app --cxxopt=-std=c++11
如要進一步瞭解如何使用 --cxxopt
、--copt
和 --linkopt
傳遞編譯器和連結器標記,請參閱使用者手冊。
您也可以使用 copts
和 linkopts
,在 cc_library
中將編譯器和連結器標記指定為屬性。例如:
cc_library(
name = "jni_lib",
srcs = ["cpp/native-lib.cpp"],
copts = ["-std=c++11"],
linkopts = ["-ldl"], # link against libdl
)
不使用 android_binary
建構 Android 版 cc_library
如要為 Android 建構獨立的 cc_binary
或 cc_library
,且不使用 android_binary
,請使用 --platforms
標記。
舉例來說,假設您已在 my/platforms/BUILD
中定義 Android 平台:
bazel build //my/cc/jni:target \
--platforms=//my/platforms:x86_64
採用這種做法會影響整個建構樹狀結構。
這些標記可放入 project/.bazelrc
中的 bazelrc
設定 (每個 ABI 一個):
common:android_x86 --platforms=//my/platforms:x86
common:android_armeabi-v7a --platforms=//my/platforms:armeabi-v7a
# In general
common:android_<abi> --platforms=//my/platforms:<abi>
接著,如要為 x86
建構 cc_library
,請執行:
bazel build //my/cc/jni:target --config=android_x86
一般來說,請針對低階目標 (例如 cc_library
) 或您確切知道要建構的內容時使用此方法;針對高階目標,請依賴從 android_binary
進行的自動設定轉換,因為您預期會建構許多您無法控制的目標。