Build Foundation đã bắt đầu tuyển chọn thành viên sáng lập! Tham gia danh sách gửi thư, đọc thoả thuận tham gia và đăng ký!

Hướng dẫn của Bazel: Tạo ứng dụng Android

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

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

Hướng dẫn này trình bày cách tạo một ứng dụng Android đơn giản bằng Bazel.

Bazel hỗ trợ việc tạo ứng dụng Android bằng các quy tắc của Android.

Hướng dẫn này dành cho người dùng Windows, macOS và Linux, đồng thời không yêu cầu kinh nghiệm về Bazel hoặc phát triển ứng dụng Android. Bạn không cần viết bất kỳ mã Android nào trong hướng dẫn này.

Kiến thức bạn sẽ học được

Trong hướng dẫn này, bạn sẽ tìm hiểu cách:

Thiết lập môi trường bằng cách cài đặt Bazel và Android Studio, đồng thời tải dự án mẫu xuống.
Thiết lập một không gian làm việc Bazel chứa mã nguồn cho ứng dụng và một tệp WORKSPACE xác định cấp cao nhất của thư mục không gian làm việc.
Cập nhật tệp WORKSPACE để chứa các tham chiếu đến các phần phụ thuộc bên ngoài bắt buộc, chẳng hạn như SDK Android.
Tạo tệp BUILD.
Tạo ứng dụng bằng Bazel.
Triển khai và chạy ứng dụng trên trình mô phỏng Android hoặc thiết bị thực.

Trước khi bắt đầu

Cài đặt Bazel

Trước khi bắt đầu hướng dẫn này, hãy cài đặt phần mềm sau:

Bazel. Để cài đặt, hãy làm theo hướng dẫn cài đặt.
Android Studio. Để cài đặt, hãy làm theo các bước để tải Android Studio xuống. Thực thi trình hướng dẫn thiết lập để tải SDK xuống và định cấu hình môi trường.
(Không bắt buộc) Git. Sử dụng git để tải dự án ứng dụng Android xuống.

Tải dự án mẫu

Đối với dự án mẫu, hãy sử dụng một dự án ứng dụng Android cơ bản trong kho lưu trữ các ví dụ của Bazel.

Ứng dụng này có một nút duy nhất in thông báo chào khi được nhấp vào:

Lời chào bằng nút

Hình 1. Thông báo chào của nút ứng dụng Android.

Sao chép kho lưu trữ bằng git (hoặc tải trực tiếp tệp ZIP xuống):

git clone https://github.com/bazelbuild/examples

Dự án mẫu cho hướng dẫn này nằm trong examples/android/tutorial. Trong phần còn lại của hướng dẫn, bạn sẽ thực thi các lệnh trong thư mục này.

Xem lại các tệp nguồn

Hãy xem các tệp nguồn cho ứng dụng.

.
├── README.md
└── src
    └── main
        ├── AndroidManifest.xml
        └── java
            └── com
                └── example
                    └── bazel
                        ├── AndroidManifest.xml
                        ├── Greeter.java
                        ├── MainActivity.java
                        └── res
                            ├── layout
                            │   └── activity_main.xml
                            └── values
                                ├── colors.xml
                                └── strings.xml

Các tệp và thư mục chính là:

Tên	Thông tin vị trí
Tệp kê khai Android	`src/main/AndroidManifest.xml` và `src/main/java/com/example/bazel/AndroidManifest.xml`
Tệp nguồn Android	`src/main/java/com/example/bazel/MainActivity.java` và `Greeter.java`
Thư mục tệp tài nguyên	`src/main/java/com/example/bazel/res/`

Tạo bằng Bazel

Thiết lập không gian làm việc

Một không gian làm việc là một thư mục chứa các tệp nguồn cho một hoặc nhiều dự án phần mềm và có một tệp WORKSPACE ở thư mục gốc.

Tệp WORKSPACE có thể trống hoặc có thể chứa các tham chiếu đến các phần phụ thuộc bên ngoài cần thiết để tạo dự án.

Trước tiên, hãy chạy lệnh sau để tạo một tệp WORKSPACE trống:

Hệ điều hành	Lệnh
Linux, macOS	`touch WORKSPACE`
Windows (Command Prompt)	`type nul > WORKSPACE`
Windows (PowerShell)	`New-Item WORKSPACE -ItemType file`

Chạy Bazel

Giờ đây, bạn có thể kiểm tra xem Bazel có đang chạy đúng cách hay không bằng lệnh:

bazel info workspace

Nếu Bazel in đường dẫn của thư mục hiện tại, thì bạn đã sẵn sàng! Nếu tệp WORKSPACE không tồn tại, bạn có thể thấy một thông báo lỗi như:

ERROR: The 'info' command is only supported from within a workspace.

Tích hợp với SDK Android

Bazel cần chạy các công cụ xây dựng SDK Android để tạo ứng dụng. Điều này có nghĩa là bạn cần thêm một số thông tin vào tệp WORKSPACE để Bazel biết nơi tìm các công cụ đó.

Thêm dòng sau vào tệp WORKSPACE:

android_sdk_repository(name = "androidsdk")

Thao tác này sẽ sử dụng SDK Android tại đường dẫn được biến môi trường ANDROID_HOME tham chiếu và tự động phát hiện cấp độ API cao nhất cũng như phiên bản mới nhất của các công cụ xây dựng được cài đặt trong vị trí đó.

Bạn có thể đặt biến ANDROID_HOME thành vị trí của SDK Android. Tìm đường dẫn đến SDK đã cài đặt bằng Trình quản lý SDK của Android Studio. Giả sử SDK được cài đặt vào các vị trí mặc định, bạn có thể sử dụng các lệnh sau để đặt biến ANDROID_HOME:

Hệ điều hành	Lệnh
Linux	`export ANDROID_HOME=$HOME/Android/Sdk/`
macOS	`export ANDROID_HOME=$HOME/Library/Android/sdk`
Windows (Command Prompt)	`set ANDROID_HOME=%LOCALAPPDATA%\Android\Sdk`
Windows (PowerShell)	`$env:ANDROID_HOME="$env:LOCALAPPDATA\Android\Sdk"`

Các lệnh trên chỉ đặt biến cho phiên shell hiện tại. Để biến các lệnh này thành vĩnh viễn, hãy chạy các lệnh sau:

Hệ điều hành	Lệnh
Linux	`echo "export ANDROID_HOME=$HOME/Android/Sdk/" >> ~/.bashrc`
macOS	`echo "export ANDROID_HOME=$HOME/Library/Android/Sdk/" >> ~/.bashrc`
Windows (Command Prompt)	`setx ANDROID_HOME "%LOCALAPPDATA%\Android\Sdk"`
Windows (PowerShell)	`[System.Environment]::SetEnvironmentVariable('ANDROID_HOME', "$env:LOCALAPPDATA\Android\Sdk", [System.EnvironmentVariableTarget]::User)`

Bạn cũng có thể chỉ định rõ ràng đường dẫn tuyệt đối của SDK Android, cấp độ API và phiên bản của các công cụ xây dựng để sử dụng bằng cách đưa vào các thuộc tính path, api_level và build_tools_version. Nếu bạn không chỉ định api_level và build_tools_version, thì quy tắc android_sdk_repository sẽ sử dụng phiên bản mới nhất tương ứng có trong SDK. Bạn có thể chỉ định bất kỳ tổ hợp nào của các thuộc tính này, miễn là chúng có trong SDK, ví dụ:

android_sdk_repository(
    name = "androidsdk",
    path = "/path/to/Android/sdk",
    api_level = 25,
    build_tools_version = "30.0.3"
)

Trên Windows, hãy lưu ý rằng thuộc tính path phải sử dụng đường dẫn kiểu hỗn hợp, tức là đường dẫn Windows có dấu gạch chéo về phía trước:

android_sdk_repository(
    name = "androidsdk",
    path = "c:/path/to/Android/sdk",
)

Không bắt buộc: Nếu muốn biên dịch mã gốc vào ứng dụng Android, bạn cũng cần tải Android NDK xuống và cho Bazel biết nơi tìm mã này bằng cách thêm dòng sau vào tệp WORKSPACE của bạn:

android_ndk_repository(name = "androidndk")

Tương tự như android_sdk_repository, đường dẫn đến Android NDK được suy ra từ biến môi trường ANDROID_NDK_HOME theo mặc định. Bạn cũng có thể chỉ định rõ ràng đường dẫn bằng thuộc tính path trên android_ndk_repository.

Để biết thêm thông tin, hãy đọc bài viết Sử dụng Bộ phát triển mã gốc Android với Bazel.

api_level là phiên bản của API Android mà SDK và NDK nhắm đến – ví dụ: 23 cho Android 6.0 và 25 cho Android 7.1. Nếu không được đặt rõ ràng, api_level sẽ mặc định là cấp độ API cao nhất có sẵn cho android_sdk_repository và android_ndk_repository.

Bạn không cần đặt cấp độ API thành cùng một giá trị cho SDK và NDK. Trang này chứa một bản đồ từ các bản phát hành Android đến các cấp độ API được NDK hỗ trợ.

Tạo tệp BUILD

Tệp BUILD mô tả mối quan hệ giữa một tập hợp các kết quả bản dựng, chẳng hạn như các tài nguyên Android được biên dịch từ aapt hoặc các tệp lớp từ javac, và các phần phụ thuộc của chúng. Các phần phụ thuộc này có thể là tệp nguồn (Java, C++) trong không gian làm việc hoặc các kết quả xây dựng khác. Tệp BUILD được viết bằng một ngôn ngữ có tên là Starlark.

Tệp BUILD là một phần của khái niệm trong Bazel được gọi là hệ phân cấp gói. Hệ phân cấp gói là một cấu trúc logic phủ lên cấu trúc thư mục trong không gian làm việc. Mỗi gói là một thư mục (và các thư mục con của nó) chứa một tập hợp các tệp nguồn liên quan và một tệp BUILD. Gói này cũng bao gồm mọi thư mục con, ngoại trừ những thư mục chứa tệp BUILD riêng. Tên gói là đường dẫn đến tệp BUILD tương ứng với WORKSPACE.

Xin lưu ý rằng hệ phân cấp gói của Bazel khác về mặt khái niệm so với hệ phân cấp gói Java của thư mục ứng dụng Android nơi tệp BUILD được đặt, mặc dù các thư mục có thể được sắp xếp giống hệt nhau.

Đối với ứng dụng Android đơn giản trong hướng dẫn này, các tệp nguồn trong src/main/ bao gồm một gói Bazel duy nhất. Một dự án phức tạp hơn có thể có nhiều gói lồng nhau.

Thêm quy tắc android_library

Tệp BUILD chứa một số loại khai báo cho Bazel. Loại quan trọng nhất là quy tắc xây dựng, cho Bazel biết cách xây dựng kết quả phần mềm trung gian hoặc cuối cùng từ một tập hợp các tệp nguồn hoặc các phần phụ thuộc khác. Bazel cung cấp hai quy tắc xây dựng, android_library và android_binary, mà bạn có thể sử dụng để xây dựng ứng dụng Android.

Đối với hướng dẫn này, trước tiên, bạn sẽ sử dụng quy tắc android_library để cho Bazel biết cách xây dựng một mô-đun thư viện Android từ mã nguồn ứng dụng và các tệp tài nguyên. Sau đó, bạn sẽ sử dụng quy tắc android_binary để cho Bazel biết cách xây dựng gói ứng dụng Android.

Tạo một tệp BUILD mới trong thư mục src/main/java/com/example/bazel và khai báo một mục tiêu android_library mới:

src/main/java/com/example/bazel/BUILD:

package(
    default_visibility = ["//src:__subpackages__"],
)

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

Quy tắc xây dựng android_library chứa một tập hợp các thuộc tính chỉ định thông tin mà Bazel cần để xây dựng một mô-đun thư viện từ các tệp nguồn. Cũng xin lưu ý rằng tên của quy tắc là greeter_activity. Bạn sẽ tham chiếu quy tắc bằng tên này dưới dạng phần phụ thuộc trong quy tắc android_binary.

Thêm quy tắc android_binary

Quy tắc android_binary xây dựng gói ứng dụng Android (.apk tệp) cho ứng dụng của bạn.

Tạo một tệp BUILD mới trong thư mục src/main/ và khai báo một mục tiêu android_binary mới:

src/main/BUILD:

android_binary(
    name = "app",
    manifest = "AndroidManifest.xml",
    deps = ["//src/main/java/com/example/bazel:greeter_activity"],
)

Ở đây, thuộc tính deps tham chiếu đến kết quả của quy tắc greeter_activity mà bạn đã thêm vào tệp BUILD ở trên. Điều này có nghĩa là khi Bazel xây dựng kết quả của quy tắc này, trước tiên, Bazel sẽ kiểm tra để xem kết quả của quy tắc thư viện greeter_activity đã được xây dựng và có phải là phiên bản mới nhất hay không. Nếu không, Bazel sẽ xây dựng kết quả đó rồi sử dụng kết quả đó để xây dựng tệp gói ứng dụng.

Bây giờ, hãy lưu và đóng tệp.

Tạo ứng dụng

Hãy thử tạo ứng dụng! Chạy lệnh sau để tạo mục tiêu android_binary:

bazel build //src/main:app

Lệnh con build hướng dẫn Bazel tạo mục tiêu tiếp theo. Mục tiêu được chỉ định là tên của một quy tắc xây dựng bên trong tệp BUILD, cùng với đường dẫn gói tương ứng với thư mục không gian làm việc. Đối với ví dụ này, mục tiêu là app và đường dẫn gói là //src/main/.

Xin lưu ý rằng đôi khi bạn có thể bỏ qua đường dẫn gói hoặc tên mục tiêu, tuỳ thuộc vào thư mục làm việc hiện tại của bạn trong dòng lệnh và tên của mục tiêu. Để biết thêm thông tin chi tiết về nhãn và đường dẫn mục tiêu, hãy xem phần Nhãn.

Bazel sẽ bắt đầu tạo ứng dụng mẫu. Trong quá trình xây dựng, kết quả của ứng dụng sẽ có dạng như sau:

INFO: Analysed target //src/main:app (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //src/main:app up-to-date:
  bazel-bin/src/main/app_deploy.jar
  bazel-bin/src/main/app_unsigned.apk
  bazel-bin/src/main/app.apk

Xác định vị trí kết quả xây dựng

Bazel đặt kết quả của cả các thao tác xây dựng trung gian và cuối cùng vào một tập hợp các thư mục đầu ra cho mỗi người dùng, mỗi không gian làm việc. Các thư mục này được liên kết tượng trưng từ các vị trí sau ở cấp cao nhất của thư mục dự án, nơi có WORKSPACE:

bazel-bin lưu trữ các tệp thực thi nhị phân và các kết quả bản dựng có thể chạy khác
bazel-genfiles lưu trữ các tệp nguồn trung gian do các quy tắc Bazel tạo
bazel-out lưu trữ các loại kết quả xây dựng khác

Bazel lưu trữ tệp .apk Android được tạo bằng quy tắc android_binary trong thư mục bazel-bin/src/main, trong đó tên thư mục con src/main được lấy từ tên của gói Bazel.

Tại dấu nhắc lệnh, hãy liệt kê nội dung của thư mục này và tìm tệp app.apk:

Hệ điều hành	Lệnh
Linux, macOS	`ls bazel-bin/src/main`
Windows (Command Prompt)	`dir bazel-bin\src\main`
Windows (PowerShell)	`ls bazel-bin\src\main`

Chạy ứng dụng

Giờ đây, bạn có thể triển khai ứng dụng vào một thiết bị Android hoặc trình mô phỏng được kết nối từ dòng lệnh bằng lệnh bazel mobile-install. Lệnh này sử dụng Cầu gỡ lỗi Android (adb) để giao tiếp với thiết bị. Bạn phải thiết lập thiết bị để sử dụng adb theo hướng dẫn trong Cầu gỡ lỗi Android trước khi triển khai. Bạn cũng có thể chọn cài đặt ứng dụng trên trình mô phỏng Android có trong Android Studio. Hãy đảm bảo trình mô phỏng đang chạy trước khi thực thi lệnh bên dưới.

Nhập thông tin sau:

bazel mobile-install //src/main:app

Tiếp theo, hãy tìm và khởi chạy "Ứng dụng hướng dẫn về Bazel":

Ứng dụng hướng dẫn về Bazel

Hình 2. Ứng dụng hướng dẫn về Bazel.

Xin chúc mừng! Bạn vừa cài đặt ứng dụng Android đầu tiên được xây dựng bằng Bazel.

Xin lưu ý rằng lệnh con mobile-install cũng hỗ trợ cờ --incremental có thể dùng để chỉ triển khai những phần của ứng dụng đã thay đổi kể từ lần triển khai gần đây nhất.

Lệnh này cũng hỗ trợ cờ --start_app để khởi động ứng dụng ngay sau khi cài đặt.

Tài liệu đọc thêm

Để biết thêm thông tin chi tiết, hãy xem các trang sau:

Các vấn đề đang mở trên GitHub
Thông tin khác về mobile-install
Tích hợp các phần phụ thuộc bên ngoài như AppCompat, Guava và JUnit từ kho lưu trữ Maven bằng rules_jvm_external
Chạy các bài kiểm thử Robolectric bằng tính năng tích hợp robolectric-bazel.
Kiểm thử ứng dụng bằng các bài kiểm thử đo lường Android
Tích hợp mã C và C++ vào ứng dụng Android bằng NDK
Xem thêm các dự án mẫu Bazel của:

Chúc bạn xây dựng thành công!

Hướng dẫn của Bazel: Tạo ứng dụng Android Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.