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

รายงานปัญหา ดูแหล่งที่มา ตอนกลางคืน · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ถ้าคุณเพิ่งเริ่มใช้ 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 ขึ้นไป) ให้ใช้ การใช้งาน android_ndk_repository ของ Starlark ทำตามวิธีการใน 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

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

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

ในไฟล์ 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 เป้าหมาย ให้ใช้แฟล็ก --android_platforms ดังนี้

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

ค่าที่ส่งไปยัง --android_platforms มีลักษณะเช่นเดียวกับธง --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 เริ่มต้นไม่ได้ จึงต้องมีการระบุ 1 แพลตฟอร์ม ระบุด้วย --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

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

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

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

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

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

แฟล็กเหล่านี้อยู่ในการกำหนดค่า 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 สำหรับเป้าหมายระดับสูงที่คุณคาดไว้ เพื่อสร้างเป้าหมายจำนวนมากที่คุณไม่สามารถควบคุมได้