Sử dụng Bộ phát triển gốc Android với Bazel

Báo cáo vấn đề Xem nguồn Nightly .

Nếu bạn mới sử dụng Bazel, vui lòng bắt đầu với hướng dẫn Xây dựng Android bằng Bazel.

Tổng quan

Bazel có thể chạy trong nhiều cấu hình bản dựng, trong đó có một số cấu hình sử dụng chuỗi công cụ Bộ phát triển mã gốc Android (NDK). Điều này có nghĩa là các quy tắc cc_librarycc_binary thông thường có thể được biên dịch cho Android ngay trong Bazel. Bazel thực hiện việc này bằng cách sử dụng quy tắc về kho lưu trữ android_ndk_repository.

Điều kiện tiên quyết

Vui lòng đảm bảo rằng bạn đã cài đặt NDK và SDK Android.

Để thiết lập SDK và NDK, hãy thêm đoạn mã sau vào 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.
)

Để biết thêm thông tin về quy tắc android_ndk_repository, hãy xem phần Tạo mục nhập Bách khoa toàn thư.

Nếu bạn đang sử dụng phiên bản Android NDK gần đây (r22 trở lên), hãy sử dụng phương thức triển khai Starlark của android_ndk_repository. Làm theo hướng dẫn trong README.

Bắt đầu nhanh

Để xây dựng C++ cho Android, bạn chỉ cần thêm phần phụ thuộc cc_library vào các quy tắc android_binary hoặc android_library.

Ví dụ: với tệp BUILD sau đây cho một ứng dụng 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",
)

Tệp BUILD này tạo ra biểu đồ mục tiêu sau đây:

Kết quả mẫu

Hình 1. Tạo biểu đồ dự án Android có các phần phụ thuộc cc_library.

Để tạo ứng dụng, bạn chỉ cần chạy:

bazel build //app/src/main:app

Lệnh bazel build biên dịch các tệp Java, tệp tài nguyên Android và quy tắc cc_library rồi đóng gói mọi thứ vào một 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 biên dịch tất cả cc_ libraries thành một tệp đối tượng dùng chung (.so) duy nhất, được nhắm mục tiêu cho ABI armeabi-v7a theo mặc định. Để thay đổi bản dựng này hoặc bản dựng cho nhiều ABI cùng lúc, hãy xem phần định cấu hình ABI mục tiêu.

Thiết lập mẫu

Ví dụ này có trong kho lưu trữ các ví dụ về Brazil.

Trong tệp BUILD.bazel, 3 mục tiêu được xác định bằng các quy tắc android_binary, android_librarycc_library.

Mục tiêu cấp cao nhất android_binary tạo APK.

Mục tiêu cc_library chứa một tệp nguồn C++ có cách triển khai hàm 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());
}

Đích android_library chỉ định các nguồn Java, tệp tài nguyên và phần phụ thuộc vào đích cc_library. Trong ví dụ này, MainActivity.java tải tệp đối tượng dùng chung libapp.so và xác định chữ ký phương thức cho hàm JNI:

public class MainActivity extends AppCompatActivity {

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

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

    public native String stringFromJNI();

}

Định cấu hình ABI mục tiêu

Để định cấu hình ABI mục tiêu, hãy sử dụng cờ --android_platforms như sau:

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

Giống như cờ --platforms, giá trị được chuyển đến --android_platforms là nhãn của mục tiêu platform, sử dụng các giá trị ràng buộc tiêu chuẩn để mô tả thiết bị của bạn.

Ví dụ: đối với thiết bị Android có bộ xử lý ARM 64 bit, bạn sẽ xác định nền tảng như sau:

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

Mọi platform của Android phải sử dụng quy tắc ràng buộc của hệ điều hành @platforms//os:android. Để di chuyển quy tắc ràng buộc về CPU, hãy xem biểu đồ sau:

Giá trị CPU Nền tảng
armeabi-v7a @platforms//cpu:arm
arm64-v8a @platforms//cpu:arm64
x86 @platforms//cpu:x86_32
x86_64 @platforms//cpu:x86_64

Và tất nhiên, đối với một APK đa kiến trúc, bạn sẽ truyền nhiều nhãn, chẳng hạn như --android_platforms=//:arm64,//:x86_64 (giả sử bạn đã xác định các nhãn đó trong tệp BUILD.bazel cấp cao nhất của mình).

Bazel không thể chọn nền tảng Android mặc định nên bạn phải xác định và chỉ định một nền tảng bằng --android_platforms.

Tuỳ thuộc vào bản sửa đổi NDK và cấp độ API Android, bạn có thể sử dụng các ABI sau đây:

Bản sửa đổi NDK ABI
16 trở xuống armeabi, armeabi-v7a, arm64-v8a, mips, mips64, x86, x86_64
17 trở lên armeabi-v7a, arm64-v8a, x86, x86_64

Hãy xem tài liệu về NDK để biết thêm thông tin về các ABI này.

Bạn không nên dùng tệp APK nhiều ABI cho các bản phát hành vì các tệp APK này sẽ làm tăng kích thước của tệp APK, nhưng có thể hữu ích cho việc phát triển và các bản dựng đảm bảo chất lượng.

Chọn một tiêu chuẩn C++

Sử dụng các cờ sau để xây dựng theo tiêu chuẩn C++:

Tiêu chuẩn C++ Cờ
C++98 Mặc định, không cần gắn cờ
C++11 --cxxopt=-std=c++11
C++14 --cxxopt=-std=c++14
C++17 --cxxopt=-std=c++17

Ví dụ:

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

Hãy đọc thêm về cách truyền cờ của trình biên dịch và trình liên kết bằng --cxxopt, --copt--linkopt trong Hướng dẫn sử dụng.

Cờ trình biên dịch và trình liên kết cũng có thể được chỉ định làm thuộc tính trong cc_library bằng cách sử dụng coptslinkopts. Ví dụ:

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

Tạo cc_library cho Android mà không cần sử dụng android_binary

Để tạo một cc_binary hoặc cc_library độc lập cho Android mà không cần sử dụng android_binary, hãy sử dụng cờ --platforms.

Ví dụ: giả sử bạn đã xác định các nền tảng Android trong my/platforms/BUILD:

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

Với phương pháp này, toàn bộ cây bản dựng sẽ bị ảnh hưởng.

Bạn có thể đặt những cờ này vào cấu hình bazelrc (một cờ cho mỗi ABI), trong 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>

Sau đó, để tạo cc_library cho x86 chẳng hạn, hãy chạy:

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

Nhìn chung, hãy sử dụng phương thức này cho các mục tiêu cấp thấp (như cc_library) hoặc khi bạn biết chính xác những gì mình đang xây dựng; dựa vào các chuyển đổi cấu hình tự động từ android_binary cho các mục tiêu cấp cao mà bạn muốn tạo nhiều mục tiêu mà mình không kiểm soát.