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

Báo cáo sự cố Xem nguồn

Lưu ý: Có một số giới hạn đã biết khi sử dụng Bazel để tạo ứng dụng Android. Truy cập danh sách khẩn cấp nhóm-Android của GitHub để xem danh sách các sự cố đã biết. Mặc dù đội ngũ Bazel và những người đóng góp vào Phần mềm nguồn mở (OSS) luôn nỗ lực giải quyết các vấn đề đã biết, nhưng người dùng cần lưu ý rằng Android Studio chưa chính thức hỗ trợ các dự án Bazel.

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ợ xây dựng ứng dụng Android bằng cách sử dụ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 và không yêu cầu bạn phải có kinh nghiệm về phát triển ứng dụng Android hoặc Bazel. Bạn không cần phải 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 tìm hiểu cách:

  • Hãy thiết lập môi trường bằng cách cài đặt Bazel và Android Studio rồ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à 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 tệp 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 cù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 xem hướng dẫn, 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.

Lấy dự án mẫu

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

Ứng dụng này có một nút duy nhất in lời chào khi được nhấp vào:

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

Hình 1. Lời chào cho nút của ứng dụng Android.

Sao chép kho lưu trữ với 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 của ứ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 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/

Xây dựng cùng Bazel

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

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

Tệp WORKSPACE có thể trống hoặc chứa thông tin 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 (Dấu nhắc lệnh) type nul > WORKSPACE
Windows (PowerShell) New-Item WORKSPACE -ItemType file

Bazel đang chạy

Bây giờ, bạn có thể kiểm tra xem Bazel có đang chạy chính xác 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, bạn đã sẵn sàng! Nếu tệp WORKSPACE không tồn tại, bạn có thể thấy thông báo lỗi như sau:

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 cần tìm các thông tin đó.

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

android_sdk_repository(name = "androidsdk")

Tính năng này sẽ sử dụng SDK Android tại đường dẫn mà biến môi trường ANDROID_HOME tham chiếu đến, đồng thời tự động phát hiện cấp độ API cao nhất và phiên bản mới nhất của 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 (Dấu nhắc lệnh) 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. Để đặt chúng 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 (Dấu nhắc lệnh) 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õ đường dẫn tuyệt đối của SDK Android, cấp độ API và phiên bản công cụ bản dựng cần sử dụng bằng cách thêm 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à các thuộc tính này 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, 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 lên:

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 rồi cho Bazel biết vị trí tìm mã này bằng cách thêm dòng sau vào tệp WORKSPACE:

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õ đườ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ộ công cụ phát triển 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 đối với Android 6.0 và 25 đối với Android 7.1. Nếu không được thiết lập rõ ràng, thì api_level sẽ mặc định sẽ là cấp độ API cao nhất hiện có cho android_sdk_repository và android_ndk_repository.

Bạn không cần đặt các cấp độ API thành cùng một giá trị đối với SDK và NDK. Trang này chứa 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 đầu ra của bản dựng, chẳng hạn như tài nguyên Android được biên dịch từ aapt hoặc tệp lớp từ javac và các phần phụ thuộc của các phần phụ thuộc đó. Những 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ả đầu ra khác của bản dựng. Các tệp BUILD được viết bằng ngôn ngữ có tên là Starlark.

Tệp BUILD là một phần của một 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 của bạn. 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 con chứa tệp BUILD riêng. package name (tên gói) là đường dẫn đến tệp BUILD tương ứng với WORKSPACE.

Lưu ý rằng về mặt lý thuyết, hệ phân cấp gói của Bazel khác với hệ phân cấp gói Java của thư mục Ứng dụng Android nơi đặt tệp BUILD, 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/ sẽ bao gồm một gói Bazel. Một dự án phức tạp hơn có thể có nhiều gói lồng ghép.

Thêm quy tắc android_library

Tệp BUILD chứa nhiều loại nội dung khai báo về Bazel. Loại quan trọng nhất là quy tắc bản dựng. Quy tắc này sẽ cho Bazel biết cách tạo đầu ra 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 2 quy tắc xây dựng là android_library và android_binary mà bạn có thể dùng để tạo ứ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 để yêu cầu Bazel tạo một mô-đun thư viện Android từ mã nguồn và tệp tài nguyên của ứng dụng. Sau đó, bạn sẽ sử dụng quy tắc android_binary để cho Bazel biết cách tạo 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ụ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. Ngoài ra, 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 cách sử dụng tên này làm phần phụ thuộc trong quy tắc android_binary.

Thêm quy tắc android_binary

Quy tắc android_binary sẽ tạo gói ứng dụng Android (tệp .apk) 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ụ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 tạo đầu ra của quy tắc này, trước tiên Bazel sẽ kiểm tra xem đầu ra của quy tắc thư viện greeter_activity đã được tạo và cập nhật hay chưa. Nếu không, Bazel sẽ tạo rồi sử dụng đầu ra đó để tạo 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 theo sau. Mục tiêu được chỉ định làm tên của quy tắc tạo bản dựng 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 của bạn. Trong 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 đang hoạt động hiện tại của bạn tại 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 mục tiêu và đường dẫn, hãy xem bài viết 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ẽ xuất hiện 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í đầu ra của bản dựng

Bazel đặt đầu ra của cả hoạt động xây dựng trung gian và cuối cùng trong một tập hợp các thư mục đầu ra cho mỗi người dùng, theo từng 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, trong đó WORKSPACE là:

  • bazel-bin lưu trữ các tệp thực thi nhị phân và các đầu ra bản dựng có thể chạy khác
  • bazel-genfiles lưu trữ các tệp nguồn trung gian được tạo theo quy tắc Bazel
  • bazel-out lưu trữ các loại đầu ra khác của bản dựng

Bazel lưu trữ tệp .apk của 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 gói Bazel.

Tại lời 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 (Dấu nhắc lệnh) 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 cho một thiết bị Android hoặc trình mô phỏng đã 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 này 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, tìm và khởi chạy "Ứng dụng hướng dẫn Bazel":

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

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

Xin chúc mừng! Bạn vừa cài đặt ứng dụng Android đầu tiên do Bazel tạo.

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

Phương thức này cũng hỗ trợ cờ --start_app để khởi động ứng dụng ngay khi cài đặt.

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

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

Chúc bạn tạo dựng vui vẻ!