Quy tắc
android_binary
Xem nguồn quy tắcandroid_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 các tệp gói ứng dụng Android (.apk).
Các mục tiêu đầu ra ngầm ẩn
name.apk
: Một ứng dụng Android tệp của gói được ký bằng khoá gỡ lỗi và zipaligned có thể dùng để phát triển và gỡ lỗi cho ứng dụng của bạn. Bạn không thể phát hành ứng dụng của mình khi được ký bằng khoá gỡ lỗi.name_unsigned.apk
: Phiên bản chưa ký của tệp ở trên có thể được ký bằng các khoá phát hành trước khi phát hành sang cho cộng đồng.name_deploy.jar
: Một kho lưu trữ Java chứa đóng bắc cầu của mục tiêu này.Tệp triển khai chứa tất cả các lớp mà một trình tải lớp đã 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ênname_deploy.jar
. Đầu ra này chỉ được tạo nếu Thuộc tính proguard_specs là đã chỉ định.name_proguard.map
: Kết quả tệp ánh xạ của chạy ProGuard trênname_deploy.jar
. Đầu ra này chỉ được tạo nếu Thuộc tính proguard_specs là được chỉ định và proguard_generate_mapping hoặc shrink_resources được đặt.
Ví dụ
Bạn có thể xem ví dụ về các 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 duy nhất cho mục tiêu này. |
deps
|
Danh sách nhãn; giá trị mặc định là android_library ,
java_library với điều kiện ràng buộc android và
cc_library gói hoặc tạo .so thư viện gốc cho
Nền tảng nhắm mục tiêu Android.
|
srcs
|
Danh sách nhãn; giá trị mặc định là Hệ thống biên dịch các tệp
|
assets
|
Danh sách nhãn; giá trị mặc định là glob của tất cả các tệp trong
Thư mục assets . Bạn cũng có thể tham khảo các quy tắc khác (bất kỳ quy tắc nào tạo ra
tệp) hoặc tệp được 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
|
String; giá trị mặc định là assets .
Cặp assets và assets_dir mô tả gói được đóng gói
chỉ cung cấp thành phần và 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à |
custom_package
|
String; giá trị mặc định là |
debug_key
|
Nhãn; giá trị mặc định là CẢNH BÁO: Không sử dụng khoá sản xuất. Các khoá này phải được bảo vệ nghiêm ngặt và không được lưu giữ trong cây nguồn. |
debug_signing_keys
|
Danh sách nhãn; giá trị mặc định là CẢNH BÁO: Không sử dụng khoá sản xuất. Các khoá này phải được bảo vệ nghiêm ngặt và không được lưu giữ trong cây nguồn. |
debug_signing_lineage_file
|
Nhãn; giá trị mặc định là CẢNH BÁO: Không sử dụng khoá sản xuất. Các khoá này phải được bảo vệ nghiêm ngặt và không được lưu giữ trong cây nguồn. |
densities
|
Danh sách các chuỗi; giá trị mặc định là |
dex_shards
|
Số nguyên; giá trị mặc định là Lưu ý rằng mỗi phân đoạn sẽ dẫn đến ít nhất một tệp 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 nhiều hơn 1 cho tệp nhị phân phát hành. |
dexopts
|
Danh sách các chuỗi; giá trị mặc định là |
enable_data_binding
|
Boolean; giá trị mặc định là Để 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:
|
incremental_dexing
|
Số nguyên; không thể định cấu hình; giá trị mặc định là |
instruments
|
Nhãn; giá trị mặc định là Mục tiêu Nếu bạn đặt thuộc tính này, |
javacopts
|
Danh sách các chuỗi; giá trị mặc định là Các tuỳ chọn trình biên dịch này được chuyển đến javac sau các tuỳ chọn của trình biên dịch chung. |
key_rotation_min_sdk
|
String; giá trị mặc định là |
main_dex_list
|
Nhãn; giá trị mặc định là android/support/multidex/MultiDex$V19.class android/support/multidex/MultiDex.class android/support/multidex/MultiDexApplication.class com/google/common/base/Objects.classPhải được sử dụng với multidex="manual_main_dex" .
|
main_dex_list_opts
|
Danh sách các chuỗi; giá trị mặc định là |
main_dex_proguard_specs
|
Danh sách nhãn; giá trị mặc định là multidex được đặt thành legacy .
|
manifest
|
Nhãn; bắt buộc Tên của tệp kê khai Android, thường làAndroidManifest.xml .
Phải được xác định nếu tệp resource_file hoặc nội dung đã được xác định.
|
manifest_values
|
Từ điển: Chuỗi -> String; giá trị mặc định là
Mọi thực thể của
Khi bạn đặt |
multidex
|
String; giá trị mặc định là Các giá trị có thể có:
|
nocompress_extensions
|
Danh sách các chuỗi; giá trị mặc định là |
package_id
|
Số nguyên; giá trị mặc định là Xem đối số |
plugins
|
Danh sách nhãn; giá trị mặc định là java_plugin được chỉ định trong
thuộc tính trình bổ trợ sẽ được chạy bất cứ khi nào
mục tiêu này sẽ được tạo. Tài nguyên được tạo bởi
plugin sẽ được bao gồm trong ngăn kết quả của
mục tiêu.
|
proguard_apply_dictionary
|
Nhãn; giá trị mặc định là |
proguard_apply_mapping
|
Nhãn; giá trị mặc định là proguard_generate_mapping tạo
được sử dụng lại để áp dụng cùng một mối liên kết cho bản dựng mới.
|
proguard_generate_mapping
|
Boolean; không thể định cấu hình; giá trị mặc định là proguard_specs được
đã chỉ định. Tệp này sẽ liệt kê mối liên kết giữa ban đầu và
lớp, phương thức và tên trường bị làm rối mã nguồn.
CẢNH BÁO: Nếu thuộc tính này được sử dụng, Proguard
quy cách không được chứa |
proguard_specs
|
Danh sách nhãn; giá trị mặc định là |
resource_configuration_filters
|
Danh sách các chuỗi; giá trị mặc định là en_XA và/hoặc ar_XB .
|
resource_files
|
Danh sách nhãn; giá trị mặc định là glob của tất cả các tệp trong
Thư mục res .
Các tệp đã tạo (từ genrules) có thể được tham chiếu bằng Bạn cũng có thể Gắn nhãn tại đây. Hạn chế duy nhất là các dữ liệu đầu ra được tạo phải nằm trong cùng một " res " như bất kỳ thư mục nào khác
tệp tài nguyên được bao gồm.
|
shrink_resources
|
Số nguyên; giá trị mặc định là manifest và resource_files ) đồng thời yêu cầu ProGuard.
Công cụ này hoạt động gần như giống với trình rút gọn tài nguyên Gradle
(https://developer.android.com/studio/build/shrink-code.html#shrink-resources).
Điểm khác biệt đáng chú ý:
name_files/resource_shrinker.log
cũng sẽ được tạo để cung cấp thông tin chi tiết về quá trình phân tích và xoá đã được thực hiện.
Các loại tệp có thể được thu thập dữ liệu bao gồm:
|
android_library
Xem nguồn quy tắcandroid_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 vào một tệp .jar
.
Thư viện Android Runtime android.jar
được ngầm thiết lập
đường dẫn lớp biên dịch.
Các mục tiêu đầu ra ngầm ẩn
libname.jar
: Một tệp lưu trữ Java.libname-src.jar
: Tệp lưu trữ chứa nguồn ("jar nguồn").name.aar
: Một "aar" trên Android gói chứa kho lưu trữ java và tài nguyên của mục tiêu này. Tham số này không chứa đóng bắt buộc.
Ví dụ
Bạn có thể xem ví dụ về các quy tắc Android trong thư mục examples/android
của
Cây nguồn Bazel.
Ví dụ sau 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 duy nhất cho mục tiêu này. |
deps
|
Danh sách nhãn; giá trị mặc định là android_library ,
java_library với điều kiện ràng buộc android và
cc_library gói hoặc tạo .so thư viện gốc
cho nền tảng mục tiêu Android.
|
srcs
|
Danh sách nhãn; giá trị mặc định là .java hoặc .srcjar
được xử lý để tạo mục tiêu.
Hệ thống biên dịch các tệp
Nếu |
assets
|
Danh sách nhãn; giá trị mặc định là glob của tất cả các tệp trong
Thư mục assets . Bạn cũng có thể tham khảo các quy tắc khác (bất kỳ quy tắc nào tạo ra
tệp) hoặc tệp được 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
|
String; giá trị mặc định là assets .
Cặp assets và assets_dir mô tả gói được đóng gói
chỉ cung cấp thành phần và cả hai thuộc tính hoặc không cung cấp thuộc tính nào.
|
custom_package
|
String; giá trị mặc định là |
enable_data_binding
|
Boolean; giá trị mặc định là Để 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:
|
exported_plugins
|
Danh sách nhãn; giá trị mặc định là java_plugin (ví dụ: chú giải
bộ xử lý) để 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 |
exports
|
Danh sách nhãn; giá trị mặc định là exports
được coi là 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 bằng exports .
|
exports_manifest
|
Số nguyên; giá trị mặc định là android_binary hay không
phụ thuộc vào mục tiêu này. Thuộc tính uses-permissions không bao giờ được xuất.
|
idl_import_root
|
String; giá trị mặc định là Đường dẫn này sẽ được dùng làm gốc nhập khi xử lý các nguồn không hoạt động phụ thuộc vào thư viện này. Khi bạn chỉ định Xem ví dụ. |
idl_parcelables
|
Danh sách nhãn; giá trị mặc định là android_library phụ thuộc trực tiếp vào thư viện này
hoặc qua đóng bắc cầu, nhưng sẽ không được dịch sang Java
hoặc được biên dịch.
Chỉ có Bạn phải đặt các tệp này ở vị trí phù hợp để trình biên dịch AIdl tìm được tệp. Xem mô tả về idl_import_root để biết thông tin về ý nghĩa của điều này. |
idl_preprocessed
|
Danh sách nhãn; giá trị mặc định là android_library phụ thuộc trực tiếp vào thư viện này
hoặc qua đóng bắc cầu, nhưng sẽ không được dịch sang Java
hoặc được biên dịch.
Chỉ những tệp |
idl_srcs
|
Danh sách nhãn; giá trị mặc định là srcs .
Các tệp này sẽ được cung cấp dưới dạng tệp nhập cho bất kỳ
Mục tiêu Bạn phải đặt các tệp này ở vị trí phù hợp để trình biên dịch AIdl tìm được tệp. Xem mô tả về idl_import_root để biết thông tin về ý nghĩa của điều này. |
javacopts
|
Danh sách các chuỗi; giá trị mặc định là Các tuỳ chọn trình biên dịch này được chuyển đến javac sau các tuỳ chọn của trình biên dịch chung. |
manifest
|
Nhãn; giá trị mặc định là AndroidManifest.xml .
Phải được xác định nếu tệp resource_file hoặc nội dung đã được xác định.
|
neverlink
|
Boolean; giá trị mặc định là neverlink sẽ không được dùng trong
Tạo .apk . Hữu ích nếu thư viện được cung cấp bởi
môi trường thời gian chạy trong quá trình thực thi.
|
plugins
|
Danh sách nhãn; giá trị mặc định là java_plugin được chỉ định trong
thuộc tính trình bổ trợ sẽ được chạy bất cứ khi nào
mục tiêu này sẽ được tạo. Tài nguyên được tạo bởi
plugin sẽ được bao gồm trong ngăn kết quả của
mục tiêu.
|
proguard_specs
|
Danh sách nhãn; giá trị mặc định là android_binary nào tuỳ thuộc vào thư viện này.
Các tệp được đưa vào đây chỉ được có các quy tắc không thay đổi giá trị như -dontnote, -dontwarn,
giả định tác dụng không mong muốn 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 hợp nhất không tự động.
|
resource_files
|
Danh sách nhãn; giá trị mặc định là glob của tất cả các tệp trong
Thư mục res .
Các tệp đã tạo (từ genrules) có thể được tham chiếu bằng Bạn cũng có thể Gắn nhãn tại đây. Hạn chế duy nhất là các dữ liệu đầu ra được tạo phải nằm trong cùng một " res " như bất kỳ thư mục nào khác
tệp tài nguyên được bao gồm.
|
android_sdk_repository
Xem nguồn quy tắcandroid_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ợ tạo mục tiêu Android.
Ví dụ
Cách tối thiểu để thiết lập SDK Android cho Bazel là đặt quy tắcandroid_sdk_repository
có tên là "androidsdk" trong tệp WORKSPACE
và đặt $ANDROID_HOME
biến môi trường vào đường dẫn của SDK Android của bạn. 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 theo mặc định.
android_sdk_repository( name = "androidsdk", )
Để đảm bảo các bản dựng có thể tái tạo, path
, api_level
và
Bạn có thể đặt các thuộc tính build_tools_version
thành các giá trị cụ thể. Quá trình tạo sẽ không thành công nếu
SDK Android chưa cài đặt cấp độ API hoặc phiên bản công cụ bản dựng đượ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ạ việc sử dụng đường dẫn tương đối với không gian làm việc đến SDK Android. Đây là hữu ích nếu SDK Android là một phần trong không gian làm việc Bazel của bạn (ví dụ: nếu SDK đó được kiểm tra trong phiên bản kiểm soát).
Thư viện hỗ trợ
Thư viện hỗ trợ có trong Trình quản lý SDK Android dưới dạng "Kho lưu trữ hỗ trợ Android".
Đây là tập hợp các thư viện Android phổ biến được lập phiên bản, chẳng hạn như thư viện Support và AppCompat,
được đóng gói dưới dạng kho lưu trữ Maven cục bộ. android_sdk_repository
tạo Bazel
mục tiêu cho mỗi thư viện trong số này. Các mục tiêu này có thể được sử dụng trong các phần phụ thuộc của
Mục tiêu android_binary
và android_library
.
Tên của các mục tiêu đã tạo được lấy 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 duy nhất cho mục tiêu này. |
api_level
|
Số nguyên; không thể định cấu hình; giá trị mặc định là
Để xem tất cả |
build_tools_version
|
String; không thể định cấu hình; giá trị mặc định là Bazel yêu cầu công cụ xây dựng phiên bản 30.0.0 trở lên. |
path
|
String; không thể định cấu hình; giá trị mặc định là $ANDROID_HOME .
Bạn có thể tải SDK Android xuống từ trang web dành cho nhà phát triển Android. |
repo_mapping
|
Từ điển: Chuỗi -> String; giá trị mặc định là Ví dụ: mục nhập |