Quy tắc Android

Quy tắc

android_binary

Xem nguồn quy tắc
android_binary(name, deps, srcs, assets, assets_dir, compatible_with, crunch_png, custom_package, debug_key, debug_signing_keys, debug_signing_lineage_file, densities, deprecation, dex_shards, dexopts, distribs, enable_data_binding, exec_compatible_with, exec_properties, features, incremental_dexing, instruments, javacopts, key_rotation_min_sdk, licenses, main_dex_list, main_dex_list_opts, main_dex_proguard_specs, manifest, manifest_values, multidex, nocompress_extensions, package_id, plugins, proguard_apply_dictionary, proguard_apply_mapping, proguard_generate_mapping, proguard_specs, resource_configuration_filters, resource_files, restricted_to, shrink_resources, tags, target_compatible_with, testonly, visibility)

Tạo ra các tệp gói ứng dụng Android (.apk).

Mục tiêu đầu ra ngầm ẩn

  • name.apk: Tệp gói ứng dụng Android được ký bằng khoá gỡ lỗi và được căn chỉnh theo tệp zip, có thể dùng để phát triển và gỡ lỗi ứng dụng của bạn. Bạn không thể phát hành ứng dụng khi ký bằng khoá gỡ lỗi.
  • name_unsigned.apk: Một phiên bản chưa ký của tệp nêu trên có thể được ký bằng khoá phát hành trước khi phát hành cho công chúng.
  • name_deploy.jar: Một kho lưu trữ Java chứa bao đóng bắc cầu của mục tiêu này.

    Tệp jar triển khai chứa tất cả các lớp mà một trình tải lớp sẽ tìm thấy khi tìm kiếm đường dẫn lớp thời gian chạy của mục tiêu này từ đầu đến cuối.

  • name_proguard.jar: Một kho lưu trữ Java chứa kết quả của việc chạy ProGuard trên name_deploy.jar. Đầu ra này chỉ được tạo nếu bạn chỉ định thuộc tính proguard_specs.
  • name_proguard.map: Kết quả của tệp ánh xạ khi chạy ProGuard trên name_deploy.jar. Đầu ra này chỉ được tạo nếu bạn chỉ định thuộc tính proguard_specs và đặt proguard_generate_mapping hoặc shrink_resources.

Ví dụ

Bạn có thể tìm thấy các ví dụ về quy tắc Android trong thư mục examples/android của cây nguồn Bazel.

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

deps

Danh sách nhãn; mặc định là []

Danh sách các thư viện khác sẽ được liên kết vào mục tiêu nhị phân. Các loại thư viện được phép là: android_library, java_library có ràng buộc androidcc_library bao bọc hoặc tạo ra các thư viện gốc .so cho nền tảng mục tiêu Android.
srcs

Danh sách nhãn; mặc định là []

Danh sách các tệp nguồn được xử lý để tạo mục tiêu.

Các tệp srcs thuộc loại .java được biên dịch. Để dễ đọc, bạn không nên đặt tên của tệp nguồn .java đã tạo vào srcs. Thay vào đó, hãy đặt tên quy tắc phụ thuộc vào srcs, như mô tả bên dưới.

Các tệp srcs thuộc loại .srcjar sẽ được giải nén và biên dịch. (Điều này hữu ích nếu bạn cần tạo một nhóm tệp .java bằng genrule hoặc tiện ích tạo bản dựng.)

assets

Danh sách nhãn; mặc định là []

Danh sách các thành phần cần đóng gói. Đây thường là một glob của tất cả các tệp trong thư mục assets. Bạn cũng có thể tham chiếu các quy tắc khác (bất kỳ quy tắc nào tạo ra tệp) hoặc tệp đã xuất trong các gói khác, miễn là tất cả các tệp đó nằm trong thư mục assets_dir trong gói tương ứng.
assets_dir

Chuỗi; giá trị mặc định là ""

Chuỗi cho biết đường dẫn đến các tệp trong assets. Cặp assetsassets_dir mô tả các tài sản được đóng gói và bạn phải cung cấp cả hai thuộc tính hoặc không cung cấp thuộc tính nào.
crunch_png

Boolean; giá trị mặc định là True

Nén tệp PNG (hoặc không). Việc này không phụ thuộc vào quy trình xử lý 9 ô (luôn được thực hiện). Đây là một giải pháp không dùng nữa cho lỗi aapt đã được khắc phục trong aapt2.
custom_package

Chuỗi; giá trị mặc định là ""

Gói Java mà các nguồn Java sẽ được tạo. Theo mặc định, gói được suy luận từ thư mục chứa tệp BUILD có chứa quy tắc. Bạn có thể chỉ định một gói khác nhưng không nên làm như vậy vì có thể gây ra xung đột đường dẫn lớp với các thư viện khác mà chỉ được phát hiện trong thời gian chạy.
debug_key

Nhãn; mặc định là "@bazel_tools//tools/android:debug_keystore"

Tệp chứa kho khoá gỡ lỗi sẽ được dùng để ký apk gỡ lỗi. Thông thường, bạn không muốn sử dụng một khoá khác ngoài khoá mặc định, vì vậy, bạn nên bỏ qua thuộc tính này.

CẢNH BÁO: Không sử dụng khoá phát hành chính thức, bạn phải bảo vệ nghiêm ngặt và không lưu trữ khoá này trong cây nguồn.

debug_signing_keys

Danh sách nhãn; mặc định là []

Danh sách các tệp, kho khoá gỡ lỗi sẽ được dùng để ký apk gỡ lỗi. Thường thì bạn không muốn dùng các khoá khác ngoài khoá mặc định, vì vậy, bạn nên bỏ qua thuộc tính này.

CẢNH BÁO: Không sử dụng khoá phát hành chính thức, bạn phải bảo vệ nghiêm ngặt và không lưu trữ khoá này trong cây nguồn.

debug_signing_lineage_file

Nhãn; mặc định là None

Tệp chứa dòng ký cho debug_signing_keys. Thường thì bạn không muốn dùng các khoá khác ngoài khoá mặc định, vì vậy, bạn nên bỏ qua thuộc tính này.

CẢNH BÁO: Không sử dụng khoá phát hành chính thức, bạn phải bảo vệ nghiêm ngặt và không lưu trữ khoá này trong cây nguồn.

densities

Danh sách các chuỗi; mặc định là []

Mật độ cần lọc khi tạo apk. Thao tác này sẽ loại bỏ các tài nguyên có thể vẽ dạng raster mà thiết bị có mật độ màn hình được chỉ định sẽ không tải, để giảm kích thước APK. Một phần màn hình tương thích tương ứng cũng sẽ được thêm vào tệp kê khai nếu tệp kê khai đó chưa có danh sách siêu tập hợp.
dex_shards

Số nguyên; giá trị mặc định là 1

Số lượng phân đoạn dexing cần phân tách. Điều này giúp dexing diễn ra nhanh hơn nhiều, nhưng sẽ ảnh hưởng đến thời gian cài đặt và khởi động ứng dụng. Nhị phân càng lớn thì càng nên sử dụng nhiều mảnh. 25 là một giá trị phù hợp để bắt đầu thử nghiệm.

Lưu ý rằng mỗi phân đoạn sẽ tạo ra ít nhất một dex trong ứng dụng cuối cùng. Vì lý do này, bạn không nên đặt giá trị này thành lớn hơn 1 cho các tệp nhị phân phát hành.

dexopts

Danh sách các chuỗi; mặc định là []

Cờ dòng lệnh bổ sung cho công cụ dx khi tạo classes.dex. Chịu sự thay thế "Tạo biến"phân tích cú pháp Bourne shell.
enable_data_binding

Boolean; giá trị mặc định là False

Nếu đúng, quy tắc này sẽ xử lý các biểu thức liên kết dữ liệu trong tài nguyên bố cục được đưa vào thông qua thuộc tính resource_files. Nếu không có chế độ cài đặt này, các biểu thức liên kết dữ liệu sẽ tạo ra lỗi bản dựng.

Để tạo một ứng dụng Android có liên kết dữ liệu, bạn cũng phải làm như sau:

  1. Đặt thuộc tính này cho tất cả các quy tắc Android phụ thuộc bắc cầu vào quy tắc này. Lý do là vì các đối tượng phụ thuộc sẽ kế thừa biểu thức liên kết dữ liệu của quy tắc thông qua việc hợp nhất tài nguyên. Vì vậy, họ cũng cần tạo bằng tính năng liên kết dữ liệu để phân tích cú pháp các biểu thức đó.
  2. Thêm một mục deps = cho thư viện thời gian chạy liên kết dữ liệu vào tất cả các mục tiêu đặt thuộc tính này. Vị trí của thư viện này phụ thuộc vào chế độ thiết lập kho lưu trữ của bạn.
incremental_dexing

Số nguyên; không thể định cấu hình; mặc định là -1

Buộc mục tiêu được tạo có hoặc không có tính năng lập chỉ mục gia tăng, ghi đè các giá trị mặc định và cờ --incremental_dexing.
instruments

Nhãn; mặc định là None

Mục tiêu android_binary để đo lường.

Nếu bạn đặt thuộc tính này, android_binary này sẽ được coi là một ứng dụng kiểm thử cho các kiểm thử đo lường. Sau đó, một mục tiêu android_instrumentation_test có thể chỉ định mục tiêu này trong thuộc tính test_app.

javacopts

Danh sách các chuỗi; mặc định là []

Các lựa chọn trình biên dịch bổ sung cho mục tiêu này. Chịu sự thay thế "Tạo biến"phân tích cú pháp Bourne shell.

Các lựa chọn trình biên dịch này được truyền đến javac sau các lựa chọn trình biên dịch chung.

key_rotation_min_sdk

Chuỗi; giá trị mặc định là ""

Đặt phiên bản nền tảng Android tối thiểu (Cấp độ API) mà khoá ký xoay vòng của APK phải sử dụng để tạo chữ ký của APK. Khoá ký ban đầu cho APK sẽ được dùng cho tất cả các phiên bản trước của nền tảng.
main_dex_list

Nhãn; mặc định là None

Một tệp văn bản chứa danh sách tên tệp lớp. Các lớp do những tệp lớp đó xác định sẽ được đưa vào classes.dex chính. Ví dụ:
          android/support/multidex/MultiDex$V19.class
          android/support/multidex/MultiDex.class
          android/support/multidex/MultiDexApplication.class
          com/google/common/base/Objects.class
                    
Phải được dùng với multidex="manual_main_dex".
main_dex_list_opts

Danh sách các chuỗi; mặc định là []

Các lựa chọn dòng lệnh để truyền đến trình tạo danh sách dex chính. Sử dụng lựa chọn này để ảnh hưởng đến các lớp có trong danh sách dex chính.
main_dex_proguard_specs

Danh sách nhãn; mặc định là []

Các tệp sẽ được dùng làm thông số Proguard để xác định các lớp phải được giữ trong dex chính. Chỉ được phép nếu bạn đặt thuộc tính multidex thành legacy.
manifest

Nhãn; bắt buộc

Tên của tệp kê khai Android, thường là AndroidManifest.xml. Bạn phải xác định nếu resource_files hoặc thành phần được xác định.
manifest_values

Từ điển: Chuỗi -> Chuỗi; mặc định là {}

Một từ điển các giá trị sẽ được ghi đè trong tệp kê khai.

Mọi thực thể của ${name} trong tệp kê khai sẽ được thay thế bằng giá trị tương ứng với tên trong từ điển này.

applicationId, versionCode, versionName, minSdkVersion, targetSdkVersionmaxSdkVersion cũng sẽ ghi đè các thuộc tính tương ứng trong tệp kê khai và thẻ uses-sdk.

packageName sẽ bị bỏ qua và được đặt từ applicationId (nếu được chỉ định) hoặc gói trong tệp kê khai.

Khi bạn đặt manifest_merger thành legacy, chỉ applicationId, versionCodeversionName mới có hiệu lực.

multidex

Chuỗi; giá trị mặc định là "native"

Có chia mã thành nhiều tệp dex hay không.
Các giá trị có thể:
  • native: Chia mã thành nhiều tệp dex khi vượt quá giới hạn chỉ mục 64K dex. Giả định nền tảng gốc hỗ trợ việc tải các lớp multidex trong thời gian chạy. Tính năng này chỉ hoạt động với Android L trở lên.
  • legacy: Chia mã thành nhiều tệp dex khi vượt quá giới hạn chỉ mục 64K dex. Giả định rằng các lớp multidex được tải thông qua mã ứng dụng (tức là không có sự hỗ trợ nền tảng gốc).
  • manual_main_dex: Chia mã thành nhiều tệp dex khi vượt quá giới hạn chỉ mục dex 64K. Bạn cần chỉ định nội dung của tệp dex chính bằng cách cung cấp danh sách các lớp trong một tệp văn bản bằng thuộc tính main_dex_list.
  • off: Biên dịch tất cả mã thành một tệp dex duy nhất, ngay cả khi tệp đó vượt quá giới hạn chỉ mục.
nocompress_extensions

Danh sách các chuỗi; mặc định là []

Danh sách đuôi tệp cần giữ nguyên khi nén trong apk.
package_id

Số nguyên; giá trị mặc định là 0

Mã nhận dạng gói sẽ được chỉ định cho các tài nguyên trong tệp nhị phân này.

Hãy xem đối số --package-id của AAPT2 để biết thêm thông tin. Thông thường, bạn có thể (và nên) để trống giá trị này, dẫn đến giá trị mặc định là 127 (0x7F).

plugins

Danh sách nhãn; mặc định là []

Trình bổ trợ trình biên dịch Java sẽ chạy tại thời điểm biên dịch. Mọi java_plugin được chỉ định trong thuộc tính trình bổ trợ sẽ chạy bất cứ khi nào mục tiêu này được tạo. Các tài nguyên do trình bổ trợ tạo sẽ được đưa vào tệp jar kết quả của mục tiêu.
proguard_apply_dictionary

Nhãn; mặc định là None

Tệp dùng làm ánh xạ cho proguard. Một tệp được phân tách bằng dòng gồm các "từ" để lấy khi đổi tên các lớp và thành viên trong quá trình làm rối mã nguồn.
proguard_apply_mapping

Nhãn; mặc định là None

Tệp dùng làm ánh xạ cho proguard. Một tệp ánh xạ do proguard_generate_mapping tạo ra để được sử dụng lại nhằm áp dụng cùng một hoạt động ánh xạ cho một bản dựng mới.
proguard_generate_mapping

Boolean; không thể định cấu hình; mặc định là False

Có tạo tệp ánh xạ Proguard hay không. Tệp ánh xạ sẽ chỉ được tạo nếu bạn chỉ định proguard_specs. Tệp này sẽ liệt kê mối liên kết giữa tên lớp, phương thức và trường ban đầu với tên đã bị làm rối mã nguồn.

CẢNH BÁO: Nếu bạn sử dụng thuộc tính này, thì quy cách Proguard không được chứa -dontobfuscate cũng như -printmapping.

proguard_specs

Danh sách nhãn; mặc định là []

Các tệp sẽ được dùng làm quy cách Proguard. Tệp này sẽ mô tả bộ thông số kỹ thuật mà Proguard sẽ sử dụng.
resource_configuration_filters

Danh sách các chuỗi; mặc định là []

Một danh sách các bộ lọc cấu hình tài nguyên, chẳng hạn như "en" sẽ giới hạn tài nguyên trong apk chỉ ở những tài nguyên trong cấu hình "en". Để bật tính năng giả lập bản địa hoá, hãy thêm ngôn ngữ giả lập en_XA và/hoặc ar_XB.
resource_files

Danh sách nhãn; mặc định là []

Danh sách các tài nguyên cần đóng gói. Đây thường là một glob của tất cả các tệp trong thư mục res.
Các tệp được tạo (từ genrules) cũng có thể được tham chiếu theo Nhãn tại đây. Hạn chế duy nhất là các đầu ra được tạo phải nằm trong cùng một thư mục "res" như mọi tệp tài nguyên khác được đưa vào.
shrink_resources

Số nguyên; giá trị mặc định là -1

Xác định xem có thực hiện việc rút gọn tài nguyên hay không. Các tài nguyên không được dùng bởi tệp nhị phân sẽ bị xoá khỏi APK. Điều này chỉ được hỗ trợ cho các quy tắc sử dụng tài nguyên cục bộ (tức là các thuộc tính manifestresource_files) và yêu cầu ProGuard. Công cụ này hoạt động theo cách tương tự như công cụ rút gọn tài nguyên Gradle (https://developer.android.com/studio/build/shrink-code.html#shrink-resources).

Những điểm khác biệt đáng chú ý:

  • các tài nguyên trong values/ cũng sẽ bị xoá, cũng như các tài nguyên dựa trên tệp
  • sử dụng strict mode theo mặc định
  • chỉ hỗ trợ việc xoá các tài nguyên mã nhận dạng không dùng đến bằng aapt2
Nếu bạn bật tính năng rút gọn tài nguyên, name_files/resource_shrinker.log cũng sẽ được tạo, nêu chi tiết về quy trình phân tích và xoá đã thực hiện.

Các loại tệp có thể được thu thập dữ liệu bao gồm:

  • shrink_resources = 1: Bật tính năng giảm kích thước tài nguyên Android
  • shrink_resources = 0: Tắt tính năng giảm kích thước tài nguyên Android
  • shrink_resources = -1: Việc rút gọn được kiểm soát bằng cờ --android_resource_shrinking.

aar_import

Xem nguồn quy tắc
aar_import(name, deps, data, aar, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, licenses, restricted_to, srcjar, tags, target_compatible_with, testonly, visibility)

Quy tắc này cho phép sử dụng các tệp .aar làm thư viện cho các quy tắc android_libraryandroid_binary.

Ví dụ

    aar_import(
        name = "google-vr-sdk",
        aar = "gvr-android-sdk/libraries/sdk-common-1.10.0.aar",
    )

    android_binary(
        name = "app",
        manifest = "AndroidManifest.xml",
        srcs = glob(["**.java"]),
        deps = [":google-vr-sdk"],
    )

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

aar

Nhãn; bắt buộc

Tệp .aar cần cung cấp cho các mục tiêu Android phụ thuộc vào mục tiêu này.
exports

Danh sách nhãn; mặc định là []

Các mục tiêu cần xuất sang các quy tắc phụ thuộc vào quy tắc này. Xem java_library.exports.
srcjar

Nhãn; mặc định là None

Tệp JAR chứa mã nguồn cho các tệp JAR đã biên dịch trong AAR.

android_library

Xem nguồn quy tắc
android_library(name, deps, srcs, data, assets, assets_dir, compatible_with, custom_package, deprecation, distribs, enable_data_binding, exec_compatible_with, exec_properties, exported_plugins, exports, exports_manifest, features, idl_import_root, idl_parcelables, idl_preprocessed, idl_srcs, javacopts, licenses, manifest, neverlink, plugins, proguard_specs, resource_files, restricted_to, tags, target_compatible_with, testonly, visibility)

Quy tắc này biên dịch và lưu trữ các nguồn của quy tắc vào một tệp .jar. Thư viện thời gian chạy Android android.jar được đặt ngầm trên đường dẫn lớp biên dịch.

Mục tiêu đầu ra ngầm ẩn

  • libname.jar: Kho lưu trữ Java.
  • libname-src.jar: Một kho lưu trữ chứa các nguồn ("source jar").
  • name.aar: Một gói "aar" của Android chứa kho lưu trữ java và tài nguyên của mục tiêu này. Không chứa bao đóng bắc cầu.

Ví dụ

Bạn có thể tìm thấy các ví dụ về quy tắc Android trong thư mục examples/android của cây nguồn Bazel.

Ví dụ sau đây cho thấy cách thiết lập idl_import_root. Cho phép //java/bazel/helloandroid/BUILD chứa:

android_library(
    name = "parcelable",
    srcs = ["MyParcelable.java"], # bazel.helloandroid.MyParcelable

    # MyParcelable.aidl will be used as import for other .aidl
    # files that depend on it, but will not be compiled.
    idl_parcelables = ["MyParcelable.aidl"] # bazel.helloandroid.MyParcelable

    # We don't need to specify idl_import_root since the aidl file
    # which declares bazel.helloandroid.MyParcelable
    # is present at java/bazel/helloandroid/MyParcelable.aidl
    # underneath a java root (java/).
)

android_library(
    name = "foreign_parcelable",
    srcs = ["src/android/helloandroid/OtherParcelable.java"], # android.helloandroid.OtherParcelable
    idl_parcelables = [
        "src/android/helloandroid/OtherParcelable.aidl" # android.helloandroid.OtherParcelable
    ],

    # We need to specify idl_import_root because the aidl file which
    # declares android.helloandroid.OtherParcelable is not positioned
    # at android/helloandroid/OtherParcelable.aidl under a normal java root.
    # Setting idl_import_root to "src" in //java/bazel/helloandroid
    # adds java/bazel/helloandroid/src to the list of roots
    # the aidl compiler will search for imported types.
    idl_import_root = "src",
)

# Here, OtherInterface.aidl has an "import android.helloandroid.CallbackInterface;" statement.
android_library(
    name = "foreign_interface",
    idl_srcs = [
        "src/android/helloandroid/OtherInterface.aidl" # android.helloandroid.OtherInterface
        "src/android/helloandroid/CallbackInterface.aidl" # android.helloandroid.CallbackInterface
    ],

    # As above, idl_srcs which are not correctly positioned under a java root
    # must have idl_import_root set. Otherwise, OtherInterface (or any other
    # interface in a library which depends on this one) will not be able
    # to find CallbackInterface when it is imported.
    idl_import_root = "src",
)

# MyParcelable.aidl is imported by MyInterface.aidl, so the generated
# MyInterface.java requires MyParcelable.class at compile time.
# Depending on :parcelable ensures that aidl compilation of MyInterface.aidl
# specifies the correct import roots and can access MyParcelable.aidl, and
# makes MyParcelable.class available to Java compilation of MyInterface.java
# as usual.
android_library(
    name = "idl",
    idl_srcs = ["MyInterface.aidl"],
    deps = [":parcelable"],
)

# Here, ServiceParcelable uses and thus depends on ParcelableService,
# when it's compiled, but ParcelableService also uses ServiceParcelable,
# which creates a circular dependency.
# As a result, these files must be compiled together, in the same android_library.
android_library(
    name = "circular_dependencies",
    srcs = ["ServiceParcelable.java"],
    idl_srcs = ["ParcelableService.aidl"],
    idl_parcelables = ["ServiceParcelable.aidl"],
)

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

deps

Danh sách nhãn; mặc định là []

Danh sách các thư viện khác để liên kết. Các loại thư viện được phép là: android_library, java_library có ràng buộc androidcc_library bao bọc hoặc tạo ra các thư viện gốc .so cho nền tảng mục tiêu Android.
srcs

Danh sách nhãn; mặc định là []

Danh sách các tệp .java hoặc .srcjar được xử lý để tạo mục tiêu.

Các tệp srcs thuộc loại .java được biên dịch. Để dễ đọc, bạn không nên đặt tên của tệp nguồn .java đã tạo vào srcs. Thay vào đó, hãy đặt tên quy tắc phụ thuộc vào srcs, như mô tả bên dưới.

Các tệp srcs thuộc loại .srcjar sẽ được giải nén và biên dịch. (Điều này sẽ hữu ích nếu bạn cần tạo một nhóm tệp .java bằng genrule hoặc tiện ích tạo bản dựng.)

Nếu bạn bỏ qua srcs, mọi phần phụ thuộc được chỉ định trong deps sẽ được xuất từ quy tắc này (xem các mục xuất của java_library để biết thêm thông tin về việc xuất các phần phụ thuộc). Tuy nhiên, hành vi này sắp không được dùng nữa; hãy cố gắng không dựa vào hành vi này.

assets

Danh sách nhãn; mặc định là []

Danh sách các thành phần cần đóng gói. Đây thường là một glob của tất cả các tệp trong thư mục assets. Bạn cũng có thể tham chiếu các quy tắc khác (bất kỳ quy tắc nào tạo ra tệp) hoặc tệp đã xuất trong các gói khác, miễn là tất cả các tệp đó nằm trong thư mục assets_dir trong gói tương ứng.
assets_dir

Chuỗi; giá trị mặc định là ""

Chuỗi cho biết đường dẫn đến các tệp trong assets. Cặp assetsassets_dir mô tả các tài sản được đóng gói và bạn phải cung cấp cả hai thuộc tính hoặc không cung cấp thuộc tính nào.
custom_package

Chuỗi; giá trị mặc định là ""

Gói Java mà các nguồn Java sẽ được tạo. Theo mặc định, gói được suy luận từ thư mục chứa tệp BUILD có chứa quy tắc. Bạn có thể chỉ định một gói khác nhưng không nên làm như vậy vì có thể gây ra xung đột đường dẫn lớp với các thư viện khác mà chỉ được phát hiện trong thời gian chạy.
enable_data_binding

Boolean; giá trị mặc định là False

Nếu đúng, quy tắc này sẽ xử lý các biểu thức liên kết dữ liệu trong tài nguyên bố cục được đưa vào thông qua thuộc tính resource_files. Nếu không có chế độ cài đặt này, các biểu thức liên kết dữ liệu sẽ tạo ra lỗi bản dựng.

Để tạo một ứng dụng Android có liên kết dữ liệu, bạn cũng phải làm như sau:

  1. Đặt thuộc tính này cho tất cả các quy tắc Android phụ thuộc bắc cầu vào quy tắc này. Lý do là vì các đối tượng phụ thuộc sẽ kế thừa biểu thức liên kết dữ liệu của quy tắc thông qua việc hợp nhất tài nguyên. Vì vậy, họ cũng cần tạo bằng tính năng liên kết dữ liệu để phân tích cú pháp các biểu thức đó.
  2. Thêm một mục deps = cho thư viện thời gian chạy liên kết dữ liệu vào tất cả các mục tiêu đặt thuộc tính này. Vị trí của thư viện này phụ thuộc vào chế độ thiết lập kho lưu trữ của bạn.
exported_plugins

Danh sách nhãn; mặc định là []

Danh sách java_plugin (ví dụ: trình xử lý chú thích) để xuất sang các thư viện phụ thuộc trực tiếp vào thư viện này.

Danh sách java_plugin được chỉ định sẽ được áp dụng cho mọi thư viện phụ thuộc trực tiếp vào thư viện này, giống như thể thư viện đó đã khai báo rõ ràng các nhãn này trong plugins.

exports

Danh sách nhãn; mặc định là []

Việc đóng tất cả các quy tắc đạt được thông qua các thuộc tính exports được coi là các phần phụ thuộc trực tiếp của bất kỳ quy tắc nào phụ thuộc trực tiếp vào mục tiêu có exports.

exports không phải là các deps trực tiếp của quy tắc mà chúng thuộc về.

exports_manifest

Số nguyên; giá trị mặc định là 1

Có xuất các mục trong tệp kê khai sang các mục tiêu android_binary phụ thuộc vào mục tiêu này hay không. Thuộc tính uses-permissions không bao giờ được xuất.
idl_import_root

Chuỗi; giá trị mặc định là ""

Đường dẫn tương đối theo gói đến gốc của cây gói java chứa các nguồn idl có trong thư viện này.

Đường dẫn này sẽ được dùng làm gốc nhập khi xử lý các nguồn idl phụ thuộc vào thư viện này.

Khi idl_import_root được chỉ định, cả idl_parcelablesidl_srcs đều phải nằm ở đường dẫn do gói java của đối tượng mà chúng đại diện trong idl_import_root chỉ định. Khi bạn không chỉ định idl_import_root, cả idl_parcelablesidl_srcs đều phải nằm ở đường dẫn do gói của chúng chỉ định trong thư mục gốc Java.

Xem ví dụ.

idl_parcelables

Danh sách nhãn; mặc định là []

Danh sách các định nghĩa IDL của Android cần cung cấp dưới dạng các mục nhập. Các tệp này sẽ được cung cấp dưới dạng các mục nhập cho mọi mục tiêu android_library phụ thuộc vào thư viện này, trực tiếp hoặc thông qua bao đóng bắc cầu, nhưng sẽ không được dịch sang Java hoặc biên dịch.

Chỉ nên đưa vào các tệp .aidl tương ứng trực tiếp với các nguồn .java trong thư viện này (ví dụ: các cách triển khai tuỳ chỉnh của Parcelable), nếu không thì nên dùng idl_srcs.

Bạn phải đặt các tệp này đúng cách để trình biên dịch aidl tìm thấy chúng. Hãy xem phần mô tả về idl_import_root để biết thông tin về ý nghĩa của tham số này.

idl_preprocessed

Danh sách nhãn; mặc định là []

Danh sách các định nghĩa IDL Android đã được xử lý trước để cung cấp dưới dạng các mục nhập. Các tệp này sẽ được cung cấp dưới dạng các mục nhập cho mọi mục tiêu android_library phụ thuộc vào thư viện này, trực tiếp hoặc thông qua bao đóng bắc cầu, nhưng sẽ không được dịch sang Java hoặc biên dịch.

Bạn chỉ nên thêm các tệp .aidl đã được xử lý trước tương ứng trực tiếp với các nguồn .java trong thư viện này (ví dụ: các triển khai tuỳ chỉnh của Parcelable), nếu không, hãy dùng idl_srcs cho các định nghĩa IDL của Android cần được dịch sang giao diện Java và dùng idl_parcelable cho các tệp AIDL chưa được xử lý trước.

idl_srcs

Danh sách nhãn; mặc định là []

Danh sách các định nghĩa IDL của Android cần dịch sang giao diện Java. Sau khi các giao diện Java được tạo, chúng sẽ được biên dịch cùng với nội dung của srcs.

Các tệp này sẽ được cung cấp dưới dạng các mục nhập cho mọi mục tiêu android_library phụ thuộc vào thư viện này, trực tiếp hoặc thông qua bao đóng bắc cầu.

Bạn phải đặt các tệp này đúng cách để trình biên dịch aidl tìm thấy chúng. Hãy xem phần mô tả về idl_import_root để biết thông tin về ý nghĩa của tham số này.

javacopts

Danh sách các chuỗi; mặc định là []

Các lựa chọn trình biên dịch bổ sung cho mục tiêu này. Chịu sự thay thế "Tạo biến"phân tích cú pháp Bourne shell.

Các lựa chọn trình biên dịch này được truyền đến javac sau các lựa chọn trình biên dịch chung.

manifest

Nhãn; mặc định là None

Tên của tệp kê khai Android, thường là AndroidManifest.xml. Bạn phải xác định nếu resource_files hoặc thành phần được xác định.

Boolean; giá trị mặc định là False

Chỉ sử dụng thư viện này để biên dịch chứ không phải trong thời gian chạy. Đầu ra của một quy tắc được đánh dấu là neverlink sẽ không được dùng trong quá trình tạo .apk. Hữu ích nếu thư viện sẽ được môi trường thời gian chạy cung cấp trong quá trình thực thi.
plugins

Danh sách nhãn; mặc định là []

Trình bổ trợ trình biên dịch Java sẽ chạy tại thời điểm biên dịch. Mọi java_plugin được chỉ định trong thuộc tính trình bổ trợ sẽ chạy bất cứ khi nào mục tiêu này được tạo. Các tài nguyên do trình bổ trợ tạo sẽ được đưa vào tệp jar kết quả của mục tiêu.
proguard_specs

Danh sách nhãn; mặc định là []

Các tệp sẽ được dùng làm quy cách Proguard. Các thông số này sẽ mô tả bộ thông số kỹ thuật mà Proguard sẽ sử dụng. Nếu được chỉ định, chúng sẽ được thêm vào mọi mục tiêu android_binary tuỳ thuộc vào thư viện này. Các tệp có trong đây chỉ được có các quy tắc bất biến, cụ thể là -dontnote, -dontwarn, assumenosideeffects và các quy tắc bắt đầu bằng -keep. Các lựa chọn khác chỉ có thể xuất hiện trong proguard_specs của android_binary để đảm bảo các lần hợp nhất không trùng lặp.
resource_files

Danh sách nhãn; mặc định là []

Danh sách các tài nguyên cần đóng gói. Đây thường là một glob của tất cả các tệp trong thư mục res.
Các tệp được tạo (từ genrules) cũng có thể được tham chiếu theo Nhãn tại đây. Hạn chế duy nhất là các đầu ra được tạo phải nằm trong cùng một thư mục "res" như mọi tệp tài nguyên khác được đưa vào.

android_instrumentation_test

Xem nguồn quy tắc
android_instrumentation_test(name, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, licenses, local, restricted_to, shard_count, size, support_apks, tags, target_compatible_with, target_device, test_app, testonly, timeout, toolchains, visibility)

Quy tắc android_instrumentation_test chạy các kiểm thử đo lường của Android. Thao tác này sẽ khởi động một trình mô phỏng, cài đặt ứng dụng đang được kiểm thử, ứng dụng kiểm thử và mọi ứng dụng cần thiết khác, đồng thời chạy các kiểm thử được xác định trong gói kiểm thử.

Thuộc tính test_app chỉ định android_binary chứa kiểm thử. Đến lượt android_binary này chỉ định ứng dụng android_binary đang được kiểm thử thông qua thuộc tính instruments.

Ví dụ:

# java/com/samples/hello_world/BUILD

android_library(
    name = "hello_world_lib",
    srcs = ["Lib.java"],
    manifest = "LibraryManifest.xml",
    resource_files = glob(["res/**"]),
)

# The app under test
android_binary(
    name = "hello_world_app",
    manifest = "AndroidManifest.xml",
    deps = [":hello_world_lib"],
)
# javatests/com/samples/hello_world/BUILD

android_library(
    name = "hello_world_test_lib",
    srcs = ["Tests.java"],
    deps = [
      "//java/com/samples/hello_world:hello_world_lib",
      ...  # test dependencies such as Espresso and Mockito
    ],
)

# The test app
android_binary(
    name = "hello_world_test_app",
    instruments = "//java/com/samples/hello_world:hello_world_app",
    manifest = "AndroidManifest.xml",
    deps = [":hello_world_test_lib"],
)

android_instrumentation_test(
    name = "hello_world_uiinstrumentation_tests",
    target_device = ":some_target_device",
    test_app = ":hello_world_test_app",
)

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

support_apks

Danh sách nhãn; mặc định là []

Các APK khác cần cài đặt trên thiết bị trước khi bắt đầu kiểm thử đo lường.
target_device

Nhãn; bắt buộc

android_device mà bạn nên chạy kiểm thử trên đó.

Để chạy kiểm thử trên một trình mô phỏng đang chạy hoặc trên một thiết bị thực, hãy dùng các đối số sau: --test_output=streamed --test_arg=--device_broker_type=LOCAL_ADB_SERVER --test_arg=--device_serial_number=$device_identifier

test_app

Nhãn; bắt buộc

Mục tiêu android_binary chứa các lớp kiểm thử. Mục tiêu android_binary phải chỉ định mục tiêu mà nó đang kiểm thử thông qua thuộc tính instruments.

android_local_test

Xem nguồn quy tắc
android_local_test(name, deps, srcs, data, args, compatible_with, custom_package, densities, deprecation, enable_data_binding, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, javacopts, jvm_flags, licenses, local, manifest, manifest_values, nocompress_extensions, plugins, resource_configuration_filters, resource_jars, resource_strip_prefix, restricted_to, runtime_deps, shard_count, size, stamp, tags, target_compatible_with, test_class, testonly, timeout, toolchains, use_launcher, visibility)

Quy tắc này dành cho kiểm thử đơn vị android_library các quy tắc cục bộ (thay vì trên thiết bị). Thư viện này hoạt động với khung kiểm thử Robolectric của Android. Hãy xem trang web Android Robolectric để biết thông tin chi tiết về cách viết các kiểm thử Robolectric.

Mục tiêu đầu ra ngầm ẩn

  • name.jar: Kho lưu trữ Java của kiểm thử.
  • name-src.jar: Một kho lưu trữ chứa các nguồn ("source jar").
  • name_deploy.jar: Một kho lưu trữ triển khai Java phù hợp để triển khai (chỉ được tạo nếu được yêu cầu rõ ràng).

Ví dụ

Để sử dụng Robolectric với android_local_test, hãy thêm kho lưu trữ của Robolectric vào tệp WORKSPACE:

http_archive(
    name = "robolectric",
    urls = ["https://github.com/robolectric/robolectric-bazel/archive/<COMMIT>.tar.gz"],
    strip_prefix = "robolectric-bazel-<COMMIT>",
    sha256 = "<HASH>",
)
load("@robolectric//bazel:robolectric.bzl", "robolectric_repositories")
robolectric_repositories()
Thao tác này sẽ kéo các quy tắc maven_jar cần thiết cho Robolectric. Sau đó, mỗi quy tắc android_local_test phải phụ thuộc vào @robolectric//bazel:robolectric. Hãy xem ví dụ dưới đây.

android_local_test(
    name = "SampleTest",
    srcs = [
        "SampleTest.java",
    ],
    manifest = "LibManifest.xml",
    deps = [
        ":sample_test_lib",
        "@robolectric//bazel:android-all",
    ],
)

android_library(
    name = "sample_test_lib",
    srcs = [
         "Lib.java",
    ],
    resource_files = glob(["res/**"]),
    manifest = "AndroidManifest.xml",
)

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

deps

Danh sách nhãn; mặc định là []

Danh sách các thư viện cần kiểm thử cũng như các thư viện bổ sung cần liên kết vào mục tiêu. Tất cả tài nguyên, thành phần và tệp kê khai được khai báo trong các quy tắc Android trong bao đóng bắc cầu của thuộc tính này đều có sẵn trong quá trình kiểm thử.

Danh sách các quy tắc được phép trong depsandroid_library, aar_import, java_import, java_libraryjava_lite_proto_library.

srcs

Danh sách nhãn; mặc định là []

Danh sách các tệp nguồn được xử lý để tạo mục tiêu. Bắt buộc, trừ trường hợp đặc biệt được mô tả bên dưới.

Các tệp srcs thuộc loại .java được biên dịch. Để dễ đọc, bạn không nên đặt tên của tệp nguồn .java đã tạo vào srcs. Thay vào đó, hãy đặt tên quy tắc phụ thuộc vào srcs, như mô tả bên dưới.

Các tệp srcs thuộc loại .srcjar sẽ được giải nén và biên dịch. (Điều này sẽ hữu ích nếu bạn cần tạo một nhóm tệp .java bằng genrule hoặc tiện ích tạo bản dựng.)

Tất cả các tệp khác đều bị bỏ qua, miễn là có ít nhất một tệp thuộc loại tệp được mô tả ở trên. Nếu không, lỗi sẽ xảy ra.

Bạn phải cung cấp thuộc tính srcs và không được để trống, trừ phi bạn chỉ định runtime_deps.

custom_package

Chuỗi; giá trị mặc định là ""

Gói Java mà lớp R sẽ được tạo. Theo mặc định, gói được suy luận từ thư mục chứa tệp BUILD có chứa quy tắc. Nếu sử dụng thuộc tính này, bạn cũng cần sử dụng test_class.
densities

Danh sách các chuỗi; mặc định là []

Mật độ cần lọc khi tạo apk. Một phần compatible-screens tương ứng cũng sẽ được thêm vào tệp kê khai nếu tệp kê khai đó chưa chứa một StarlarkListing siêu tập hợp.
enable_data_binding

Boolean; giá trị mặc định là False

Nếu đúng, quy tắc này sẽ xử lý các tham chiếu liên kết dữ liệu được dùng trong các phần phụ thuộc có bật tính năng liên kết dữ liệu mà kiểm thử này sử dụng. Nếu không có chế độ cài đặt này, các phần phụ thuộc liên kết dữ liệu sẽ không có quá trình tạo mã cấp nhị phân cần thiết và có thể gây ra lỗi bản dựng.
javacopts

Danh sách các chuỗi; mặc định là []

Các lựa chọn bổ sung cho trình biên dịch của thư viện này. Chịu sự thay thế "Tạo biến"phân tích cú pháp Bourne shell.

Các lựa chọn trình biên dịch này được truyền đến javac sau các lựa chọn trình biên dịch chung.

jvm_flags

Danh sách các chuỗi; mặc định là []

Danh sách các cờ cần nhúng vào tập lệnh trình bao bọc được tạo để chạy tệp nhị phân này. Tuỳ thuộc vào $(location) và thay thế "Make variable", cũng như Bourne shell tokenization.

Tập lệnh trình bao bọc cho một tệp nhị phân Java bao gồm một định nghĩa CLASSPATH (để tìm tất cả các tệp jar phụ thuộc) và gọi trình thông dịch Java phù hợp. Dòng lệnh do tập lệnh trình bao bọc tạo ra bao gồm tên của lớp chính, theo sau là "$@" để bạn có thể truyền các đối số khác sau tên lớp. Tuy nhiên, các đối số dùng để phân tích cú pháp theo JVM phải được chỉ định trước tên lớp trên dòng lệnh. Nội dung của jvm_flags sẽ được thêm vào tập lệnh trình bao bọc trước khi tên lớp được liệt kê.

Xin lưu ý rằng thuộc tính này không ảnh hưởng đến các đầu ra *_deploy.jar.

manifest

Nhãn; mặc định là None

Tên của tệp kê khai Android, thường là AndroidManifest.xml. Bạn phải xác định nếu resource_files hoặc assets được xác định hoặc nếu bất kỳ tệp kê khai nào trong số các thư viện đang được kiểm thử có thẻ minSdkVersion trong đó.
manifest_values

Từ điển: Chuỗi -> Chuỗi; mặc định là {}

Một từ điển các giá trị sẽ được ghi đè trong tệp kê khai. Mọi thực thể của ${name} trong tệp kê khai sẽ được thay thế bằng giá trị tương ứng với tên trong từ điển này. applicationId, versionCode, versionName, minSdkVersion, targetSdkVersionmaxSdkVersion cũng sẽ ghi đè các thuộc tính tương ứng của tệp kê khai và thẻ uses-sdk. packageName sẽ bị bỏ qua và được đặt từ applicationId (nếu được chỉ định) hoặc gói trong tệp kê khai. Bạn không cần phải có tệp kê khai trên quy tắc để sử dụng manifest_values.
nocompress_extensions

Danh sách các chuỗi; mặc định là []

Danh sách các đuôi tệp cần giữ nguyên trạng thái chưa nén trong apk tài nguyên.
plugins

Danh sách nhãn; mặc định là []

Trình bổ trợ trình biên dịch Java sẽ chạy tại thời điểm biên dịch. Mọi java_plugin được chỉ định trong thuộc tính này sẽ chạy bất cứ khi nào quy tắc này được tạo. Một thư viện cũng có thể kế thừa các trình bổ trợ từ những phần phụ thuộc sử dụng exported_plugins. Các tài nguyên do trình bổ trợ tạo sẽ được đưa vào tệp jar kết quả của quy tắc này.
resource_configuration_filters

Danh sách các chuỗi; mặc định là []

Một danh sách các bộ lọc cấu hình tài nguyên, chẳng hạn như "en" sẽ giới hạn tài nguyên trong apk chỉ ở những tài nguyên trong cấu hình "en".
resource_jars

Danh sách nhãn; mặc định là []

Không dùng nữa: Thay vào đó, hãy dùng java_import và deps hoặc runtime_deps.
resource_strip_prefix

Chuỗi; giá trị mặc định là ""

Tiền tố đường dẫn cần loại bỏ khỏi các tài nguyên Java.

Nếu được chỉ định, tiền tố đường dẫn này sẽ bị xoá khỏi mọi tệp trong thuộc tính resources. Nếu tệp tài nguyên không nằm trong thư mục này thì đó là lỗi. Nếu không được chỉ định (mặc định), đường dẫn của tệp tài nguyên sẽ được xác định theo cùng một logic như gói Java của tệp nguồn. Ví dụ: một tệp nguồn tại stuff/java/foo/bar/a.txt sẽ nằm tại foo/bar/a.txt.

runtime_deps

Danh sách nhãn; mặc định là []

Các thư viện chỉ có sẵn cho tệp nhị phân hoặc kiểm thử cuối cùng trong thời gian chạy. Giống như deps thông thường, các tệp này sẽ xuất hiện trên đường dẫn lớp thời gian chạy, nhưng không giống như các tệp đó, các tệp này sẽ không xuất hiện trên đường dẫn lớp thời gian biên dịch. Các phần phụ thuộc chỉ cần trong thời gian chạy sẽ được liệt kê ở đây. Các công cụ phân tích phần phụ thuộc sẽ bỏ qua những mục tiêu xuất hiện trong cả runtime_depsdeps.
stamp

Số nguyên; giá trị mặc định là 0

Có mã hoá thông tin bản dựng vào tệp nhị phân hay không. Các giá trị có thể sử dụng là:
  • stamp = 1: Luôn đóng dấu thông tin bản dựng vào tệp nhị phân, ngay cả trong các bản dựng --nostamp. Bạn nên tránh chế độ cài đặt này, vì chế độ này có thể loại bỏ tính năng lưu vào bộ nhớ đệm từ xa cho tệp nhị phân và mọi thao tác tiếp theo phụ thuộc vào tệp nhị phân đó.
  • stamp = 0: Luôn thay thế thông tin bản dựng bằng các giá trị hằng số. Điều này giúp lưu vào bộ nhớ đệm kết quả của bản dựng một cách hiệu quả.
  • stamp = -1: Việc nhúng thông tin bản dựng được kiểm soát bằng cờ --[no]stamp.

Các tệp nhị phân được đóng dấu sẽ không được tạo lại trừ phi các phần phụ thuộc của chúng thay đổi.

test_class

Chuỗi; giá trị mặc định là ""

Lớp Java mà trình chạy kiểm thử sẽ tải.

Thuộc tính này chỉ định tên của một lớp Java sẽ được chạy bằng kiểm thử này. Bạn hiếm khi cần đặt thông số này. Nếu bạn bỏ qua đối số này, lớp Java có tên tương ứng với name của quy tắc android_local_test này sẽ được dùng. Bạn cần chú thích lớp kiểm thử bằng org.junit.runner.RunWith.

use_launcher

Boolean; giá trị mặc định là True

Có nên sử dụng trình chạy tuỳ chỉnh cho tệp nhị phân hay không.

Nếu bạn đặt thuộc tính này thành false, thì thuộc tính launcher và cờ --java_launcher có liên quan sẽ bị bỏ qua đối với mục tiêu này.

android_device

Xem nguồn quy tắc
android_device(name, cache, compatible_with, default_properties, deprecation, distribs, exec_compatible_with, exec_properties, features, horizontal_resolution, licenses, platform_apks, ram, restricted_to, screen_density, system_image, tags, target_compatible_with, testonly, vertical_resolution, visibility, vm_heap)

Quy tắc này tạo một trình mô phỏng Android được định cấu hình theo các thông số kỹ thuật đã cho. Bạn có thể khởi động trình mô phỏng này thông qua lệnh bazel run hoặc bằng cách thực thi trực tiếp tập lệnh đã tạo. Bạn nên phụ thuộc vào các quy tắc android_device hiện có thay vì xác định quy tắc của riêng mình.

Quy tắc này là mục tiêu phù hợp cho cờ --run_under đối với bazel test và blaze run. Thao tác này sẽ khởi động một trình mô phỏng, sao chép mục tiêu đang được kiểm thử/chạy vào trình mô phỏng và kiểm thử hoặc chạy mục tiêu đó nếu thích hợp.

android_device hỗ trợ việc tạo hình ảnh KVM nếu system_image cơ bản dựa trên X86 và được tối ưu hoá cho tối đa kiến trúc CPU I686. Để sử dụng KVM, hãy thêm tags = ['requires-kvm'] vào quy tắc android_device.

Mục tiêu đầu ra ngầm ẩn

  • name_images/userdata.dat: Chứa các tệp hình ảnh và ảnh chụp nhanh để khởi động trình mô phỏng
  • name_images/emulator-meta-data.pb: Chứa thông tin được chuyển đổi tuần tự cần thiết để truyền đến trình mô phỏng nhằm khởi động lại trình mô phỏng.

Ví dụ

Ví dụ sau đây minh hoạ cách sử dụng android_device. //java/android/helloandroid/BUILD chứa

android_device(
    name = "nexus_s",
    cache = 32,
    default_properties = "nexus_s.properties",
    horizontal_resolution = 480,
    ram = 512,
    screen_density = 233,
    system_image = ":emulator_images_android_16_x86",
    vertical_resolution = 800,
    vm_heap = 32,
)

filegroup(
    name = "emulator_images_android_16_x86",
    srcs = glob(["androidsdk/system-images/android-16/**"]),
)

//java/android/helloandroid/nexus_s.properties chứa:

ro.product.brand=google
ro.product.device=crespo
ro.product.manufacturer=samsung
ro.product.model=Nexus S
ro.product.name=soju

Quy tắc này sẽ tạo ra hình ảnh và một tập lệnh khởi động. Bạn có thể khởi động trình mô phỏng cục bộ bằng cách thực thi bazel run :nexus_s -- --action=start. Tập lệnh này hiển thị các cờ sau:

  • --adb_port: Cổng để hiển thị adb. Nếu muốn gửi lệnh adb đến trình mô phỏng, thì đây là cổng mà bạn sẽ gửi lệnh adb connect đến.
  • --emulator_port: Cổng để hiển thị bảng điều khiển quản lý telnet của trình mô phỏng.
  • --enable_display: Khởi động trình mô phỏng có màn hình nếu đúng (mặc định là sai).
  • --action: Bắt đầu hoặc kết thúc.
  • --apks_to_install: danh sách các apk cần cài đặt trên trình mô phỏng.

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

cache

Số nguyên; bắt buộc

Kích thước tính bằng megabyte của phân vùng bộ nhớ đệm của trình mô phỏng. Giá trị tối thiểu của tham số này là 16 megabyte.
default_properties

Nhãn; mặc định là None

Một tệp thuộc tính duy nhất sẽ được đặt trong /default.prop trên trình mô phỏng. Điều này cho phép tác giả quy tắc định cấu hình thêm trình mô phỏng để trông giống như một thiết bị thực (Đặc biệt là kiểm soát chuỗi UserAgent và hành vi khác có thể khiến ứng dụng hoặc máy chủ hoạt động khác với một thiết bị cụ thể). Các thuộc tính trong tệp này sẽ ghi đè các thuộc tính chỉ đọc thường do trình mô phỏng đặt, chẳng hạn như ro.product.model.
horizontal_resolution

Số nguyên; bắt buộc

Độ phân giải màn hình ngang tính bằng pixel để mô phỏng. Giá trị tối thiểu là 240.
platform_apks

Danh sách nhãn; mặc định là []

Danh sách các apk sẽ được cài đặt trên thiết bị tại thời điểm khởi động.
ram

Số nguyên; bắt buộc

Dung lượng RAM (tính bằng megabyte) cần mô phỏng cho thiết bị. Đây là chế độ cài đặt cho toàn bộ thiết bị, chứ không chỉ cho một ứng dụng cụ thể được cài đặt trên thiết bị. Giá trị tối thiểu là 64 megabyte.
screen_density

Số nguyên; bắt buộc

Mật độ của màn hình được mô phỏng, tính bằng số pixel trên mỗi inch. Giá trị tối thiểu của thông tin này là 30 ppi.
system_image

Nhãn; bắt buộc

Một nhóm tệp chứa các tệp sau:
  • system.img: Phân vùng hệ thống
  • kernel-qemu: Nhân Linux mà trình mô phỏng sẽ tải
  • ramdisk.img: Hình ảnh initrd dùng trong thời gian khởi động
  • userdata.img: Phân vùng dữ liệu người dùng ban đầu
  • source.properties: Một tệp thuộc tính chứa thông tin về hình ảnh
Các tệp này thuộc về Android SDK hoặc do bên thứ ba cung cấp (ví dụ: Intel cung cấp hình ảnh x86).
vertical_resolution

Số nguyên; bắt buộc

Độ phân giải màn hình dọc tính bằng pixel để mô phỏng. Giá trị tối thiểu là 240.
vm_heap

Số nguyên; bắt buộc

Kích thước tính bằng megabyte của vùng nhớ khối xếp máy ảo mà Android sẽ dùng cho mỗi quy trình. Giá trị tối thiểu là 16 megabyte.

android_ndk_repository

Xem nguồn quy tắc
android_ndk_repository(name, api_level, path, repo_mapping)

Định cấu hình Bazel để sử dụng Android NDK nhằm hỗ trợ việc tạo các mục tiêu Android bằng mã gốc.

Xin lưu ý rằng việc triển khai android_ndk_repository này đang được thay thế bằng một việc triển khai trong Starlark. Tính năng hỗ trợ cho các phiên bản NDK trong tương lai, bao gồm cả phiên bản 25 trở lên, sẽ được triển khai trong phiên bản Starlark của android_ndk_repository. Hãy xem rules_android_ndk để biết phiên bản Starlark.

Xin lưu ý rằng việc tạo bản dựng cho Android cũng yêu cầu quy tắc android_sdk_repository trong tệp WORKSPACE.

Để biết thêm thông tin, hãy đọc tài liệu đầy đủ về cách sử dụng Android NDK với Bazel.

Ví dụ

android_ndk_repository(
    name = "androidndk",
)

Ví dụ trên sẽ xác định vị trí NDK Android của bạn từ $ANDROID_NDK_HOME và phát hiện cấp độ API cao nhất mà NDK đó hỗ trợ.

android_ndk_repository(
    name = "androidndk",
    path = "./android-ndk-r20",
    api_level = 24,
)

Ví dụ trên sẽ sử dụng Android NDK nằm trong không gian làm việc của bạn trong ./android-ndk-r20. Thư viện này sẽ sử dụng các thư viện API cấp 24 khi biên dịch mã JNI.

cpufeatures

Android NDK chứa thư viện cpufeatures. Bạn có thể dùng thư viện này để phát hiện CPU của thiết bị trong thời gian chạy. Ví dụ sau đây minh hoạ cách sử dụng cpufeatures với Bazel.

# jni.cc
#include "ndk/sources/android/cpufeatures/cpu-features.h"
...
# BUILD
cc_library(
    name = "jni",
    srcs = ["jni.cc"],
    deps = ["@androidndk//:cpufeatures"],
)

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

api_level

Số nguyên; không thể định cấu hình; mặc định là 0

Cấp độ API Android để xây dựng. Nếu không được chỉ định, cấp độ API cao nhất đã cài đặt sẽ được dùng.
path

Chuỗi; không thể định cấu hình; mặc định là ""

Đường dẫn tuyệt đối hoặc tương đối đến một Android NDK. Bạn phải đặt thuộc tính này hoặc biến môi trường $ANDROID_NDK_HOME.

Bạn có thể tải Android NDK xuống từ trang web dành cho nhà phát triển Android .

repo_mapping

Từ điển: Chuỗi -> Chuỗi; mặc định là {}

Từ điển từ tên kho lưu trữ cục bộ đến tên kho lưu trữ chung. Điều này cho phép kiểm soát quá trình phân giải phần phụ thuộc của không gian làm việc đối với các phần phụ thuộc của kho lưu trữ này.

Ví dụ: một mục "@foo": "@bar" khai báo rằng, bất cứ khi nào kho lưu trữ này phụ thuộc vào "@foo" (chẳng hạn như một phần phụ thuộc vào "@foo//some:target"), thì kho lưu trữ đó thực sự phải phân giải phần phụ thuộc đó trong "@bar" ("@bar//some:target") được khai báo trên toàn cục.

android_sdk_repository

Xem nguồn quy tắc
android_sdk_repository(name, api_level, build_tools_version, path, repo_mapping)

Định cấu hình Bazel để sử dụng SDK Android cục bộ nhằm hỗ trợ việc tạo các mục tiêu Android.

Ví dụ

Để thiết lập SDK Android cho Bazel, bạn chỉ cần đặt một quy tắc android_sdk_repository có tên "androidsdk" trong tệp WORKSPACE và đặt biến môi trường $ANDROID_HOME thành đường dẫn của SDK Android. Theo mặc định, Bazel sẽ sử dụng cấp độ API Android cao nhất và phiên bản công cụ xây dựng được cài đặt trong SDK Android.
android_sdk_repository(
    name = "androidsdk",
)

Để đảm bảo các bản dựng có thể tái tạo, bạn có thể đặt các thuộc tính path, api_levelbuild_tools_version thành các giá trị cụ thể. Quá trình tạo sẽ thất bại nếu SDK Android không cài đặt cấp độ API hoặc phiên bản công cụ tạo được chỉ định.

android_sdk_repository(
    name = "androidsdk",
    path = "./sdk",
    api_level = 19,
    build_tools_version = "25.0.0",
)

Ví dụ trên cũng minh hoạ cách sử dụng đường dẫn tương đối của không gian làm việc đến SDK Android. Điều này rất hữu ích nếu Android SDK là một phần trong không gian làm việc Bazel của bạn (ví dụ: nếu SDK này được kiểm tra trong tính năng kiểm soát phiên bản).

Thư viện hỗ trợ

Các Thư viện hỗ trợ có trong Android SDK Manager dưới dạng "Kho lưu trữ hỗ trợ của Android". Đây là một bộ thư viện Android phổ biến có phiên bản, chẳng hạn như thư viện Hỗ trợ và AppCompat, được đóng gói dưới dạng một kho lưu trữ Maven cục bộ. android_sdk_repository tạo các mục tiêu Bazel cho từng thư viện này. Các mục tiêu này có thể được dùng trong các phần phụ thuộc của mục tiêu android_binaryandroid_library.

Tên của các mục tiêu được tạo bắt nguồn từ toạ độ Maven của các thư viện trong Kho lưu trữ hỗ trợ Android, được định dạng là @androidsdk//${group}:${artifact}-${version}. Ví dụ sau đây cho thấy cách android_library có thể phụ thuộc vào phiên bản 25.0.0 của thư viện appcompat v7.

android_library(
    name = "lib",
    srcs = glob(["*.java"]),
    manifest = "AndroidManifest.xml",
    resource_files = glob(["res/**"]),
    deps = ["@androidsdk//com.android.support:appcompat-v7-25.0.0"],
)

Đối số

Thuộc tính
name

Tên; bắt buộc

Tên riêng cho mục tiêu này.

api_level

Số nguyên; không thể định cấu hình; mặc định là 0

Cấp độ API Android để tạo theo mặc định. Nếu không được chỉ định, cấp độ API cao nhất đã cài đặt sẽ được sử dụng.

Bạn có thể ghi đè cấp độ API được dùng cho một bản dựng nhất định bằng cờ android_sdk. android_sdk_repository tạo một mục tiêu android_sdk cho từng cấp độ API được cài đặt trong SDK có tên @androidsdk//:sdk-${level}, cho dù bạn có chỉ định thuộc tính này hay không. Ví dụ: để tạo dựa trên cấp độ API không mặc định: bazel build --android_sdk=@androidsdk//:sdk-19 //java/com/example:app.

Để xem tất cả các mục tiêu android_sdk do android_sdk_repository tạo, bạn có thể chạy bazel query "kind(android_sdk, @androidsdk//...)".

build_tools_version

Chuỗi; không thể định cấu hình; mặc định là ""

Phiên bản của công cụ xây dựng Android sẽ sử dụng trong SDK Android. Nếu bạn không chỉ định, thì phiên bản công cụ xây dựng mới nhất đã cài đặt sẽ được dùng.

Bazel yêu cầu công cụ tạo bản dựng phiên bản 30.0.0 trở lên.

path

Chuỗi; không thể định cấu hình; mặc định là ""

Đường dẫn tuyệt đối hoặc tương đối đến một SDK Android. Bạn phải đặt thuộc tính này hoặc biến môi trường $ANDROID_HOME.

Bạn có thể tải Android SDK xuống từ trang web dành cho nhà phát triển Android.

repo_mapping

Từ điển: Chuỗi -> Chuỗi; mặc định là {}

Từ điển từ tên kho lưu trữ cục bộ đến tên kho lưu trữ chung. Điều này cho phép kiểm soát quá trình phân giải phần phụ thuộc của không gian làm việc đối với các phần phụ thuộc của kho lưu trữ này.

Ví dụ: một mục "@foo": "@bar" khai báo rằng, bất cứ khi nào kho lưu trữ này phụ thuộc vào "@foo" (chẳng hạn như một phần phụ thuộc vào "@foo//some:target"), thì kho lưu trữ đó thực sự phải phân giải phần phụ thuộc đó trong "@bar" ("@bar//some:target") được khai báo trên toàn cục.