การใช้ชุดพัฒนาซอฟต์แวร์แบบเนทีฟของ Android กับ Bazel

หากคุณเพิ่งเริ่มใช้ Bazel ให้เริ่มจากบทแนะนำการสร้าง Android ด้วย Bazel

ภาพรวม

Bazel ใช้งานได้ในการกำหนดค่าบิลด์ที่หลากหลาย รวมถึงการกำหนดค่าบิลด์หลายรายการที่ใช้เครื่องมือเชน Android Native Development Kit (NDK) ซึ่งหมายความว่าระบบจะรวบรวมกฎ cc_library และ cc_binary ปกติสำหรับ Android ได้โดยตรงภายใน Bazel 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 NDK เวอร์ชันล่าสุด (r22 ขึ้นไป) ให้ใช้ Starlark ของ android_ndk_repository ทำตามวิธีการใน README

คู่มือเริ่มต้นฉบับย่อ

หากต้องการสร้าง C++ สำหรับ Android เพียงเพิ่มทรัพยากร Dependency ของ cc_library ลงในกฎ android_binary หรือ android_library

เช่น ระบุไฟล์ BUILD ต่อไปนี้สำหรับแอป Android

# 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 สร้างกราฟของโปรเจ็กต์ Android ที่มีทรัพยากร Dependency ของ cc_library

หากต้องการสร้างแอป เพียงเรียกใช้

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) ไฟล์เดียว ซึ่งกำหนดเป้าหมายสำหรับ ABI ของ armeabi-v7a โดยค่าเริ่มต้น หากต้องการเปลี่ยนหรือสร้างสำหรับ ABI หลายรายการพร้อมกัน โปรดดูส่วนการกำหนดค่า ABI เป้าหมาย

ตัวอย่างการตั้งค่า

ตัวอย่างนี้มีอยู่ในที่เก็บข้อมูลตัวอย่าง Bazel

ในไฟล์ BUILD.bazel มีการกำหนดกลุ่มเป้าหมาย 3 รายการด้วยกฎ 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();

}

หมายเหตุ: ชื่อของไลบรารีแบบเนทีฟมาจากชื่อของเป้าหมาย android_binary ระดับบนสุด ในตัวอย่างนี้คือ app

กำลังกำหนดค่า ABI เป้าหมาย

หากต้องการกำหนดค่า ABI เป้าหมาย ให้ใช้แฟล็ก --android_platforms ดังนี้

bazel build //:app --android_platforms=comma-separated list of platforms

เช่นเดียวกับแฟล็ก --platforms ค่าที่ส่งไปยัง --android_platforms คือป้ายกำกับของเป้าหมาย platform โดยใช้ค่าข้อจำกัดมาตรฐานเพื่ออธิบายอุปกรณ์

เช่น สำหรับอุปกรณ์ Android ที่มีโปรเซสเซอร์ ARM 64 บิต คุณจะกำหนดแพลตฟอร์มดังนี้

platform(
    name = "android_arm64",
    constraint_values = [
        "@platforms//os:android",
        "@platforms//cpu:arm64",
    ],
)

platform ของ Android ทุกรายการควรใช้ข้อจํากัดของระบบปฏิบัติการ @platforms//os:android หากต้องการย้ายข้อมูลข้อจํากัดของ 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 เริ่มต้นด้วย --android_platforms

มี ABI ต่อไปนี้ให้ใช้งานโดยขึ้นอยู่กับการแก้ไข NDK และระดับ Android API

การแก้ไข NDK	ABI
16 ปีหรือต่ำกว่า	Armeabi, Armeabi-v7a, arm64-v8a, Mips, Mips64, x86, x86_64
17 ปีขึ้นไป	Armeabi-v7a, arm64-v8a, x86, x86_64

ดูข้อมูลเพิ่มเติมเกี่ยวกับ ABI เหล่านี้ได้ในเอกสาร NDK

ไม่แนะนำให้ใช้ APK แบบ Multi-ABI Fat กับบิลด์ที่เผยแพร่เนื่องจากจะเพิ่มขนาดของ 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

อ่านเพิ่มเติมเกี่ยวกับการส่งแฟล็กคอมไพเลอร์และ Linker ด้วย --cxxopt, --copt และ --linkopt ในคู่มือผู้ใช้

คุณยังระบุแฟล็กคอมไพเลอร์และ Linker เป็นแอตทริบิวต์ใน cc_library โดยใช้ copts และ linkopts ได้ด้วย เช่น

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

การสร้าง cc_library สำหรับ Android โดยไม่ใช้ android_binary

หากต้องการสร้าง cc_binary หรือ cc_library แบบสแตนด์อโลนสำหรับ Android โดยไม่ใช้ android_binary ให้ใช้ Flag --platforms

ตัวอย่างเช่น สมมติว่าคุณกำหนดแพลตฟอร์ม Android ใน my/platforms/BUILD ดังนี้

bazel build //my/cc/jni:target \
      --platforms=//my/platforms:x86_64

ด้วยวิธีการนี้ แผนผังบิลด์ทั้งหมดจะได้รับผลกระทบ

หมายเหตุ: เป้าหมายทั้งหมดในบรรทัดคำสั่งต้องเข้ากันได้กับการสร้างสำหรับ Android เมื่อระบุแฟล็กเหล่านี้ ซึ่งอาจทำให้ใช้ไวลด์การ์ดของ Bazel เช่น /... และ :all ได้ยาก

แฟล็กเหล่านี้อยู่ในการกำหนดค่า bazelrc (1 รายการสำหรับ ABI แต่ละรายการ) ได้ใน project/.bazelrc

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>

จากนั้น หากต้องการสร้าง cc_library สำหรับ x86 ตัวอย่างเช่น ให้เรียกใช้

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

โดยทั่วไป ให้ใช้วิธีนี้สำหรับเป้าหมายระดับต่ำ (เช่น cc_library) หรือเมื่อรู้อยู่แล้วว่าคุณกำลังสร้างอะไร อาศัยการเปลี่ยนแปลงการกำหนดค่าอัตโนมัติจาก android_binary สำหรับเป้าหมายระดับสูงที่คาดว่าจะสร้างเป้าหมายจำนวนมากที่คุณไม่สามารถควบคุมได้