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

รายงานปัญหา ดูซอร์สโค้ด รุ่น Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

ภาพรวม

Bazel ทำงานได้ในการกำหนดค่าการสร้างที่หลากหลาย รวมถึงการกำหนดค่าหลายรายการที่ใช้ชุดเครื่องมือ Native Development Kit (NDK) ของ Android ซึ่งหมายความว่าสามารถคอมไพล์กฎ 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 ได้ที่รายการในสารานุกรมของ Build

หากคุณใช้ Android NDK เวอร์ชันล่าสุด (r22 ขึ้นไป) ให้ใช้android_ndk_repository ที่ใช้ Starlark ทำตามวิธีการในREADME

การเริ่มใช้งานอย่างง่าย

หากต้องการสร้าง C++ สำหรับ Android ให้เพิ่ม 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 ที่มี 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) ไฟล์เดียว โดยกำหนดเป้าหมายเป็น armeabi-v7a ABI โดยค่าเริ่มต้น หากต้องการเปลี่ยนค่านี้หรือสร้างสำหรับ 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();

}

การกำหนดค่า ABI เป้าหมาย

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

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

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

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

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

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

การแก้ไข 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++

ใช้ Flag ต่อไปนี้เพื่อสร้างตามมาตรฐาน 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

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

นอกจากนี้ คุณยังระบุ Flag คอมไพเลอร์และ 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

การใช้แนวทางนี้จะส่งผลต่อทั้งโครงสร้างการบิลด์

คุณใส่ Flag เหล่านี้ลงในการกำหนดค่า 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 สำหรับเป้าหมายระดับสูงซึ่งคุณคาดว่าจะสร้างเป้าหมายจำนวนมากที่คุณไม่ได้ควบคุม