Xây dựng máy chủ tiện ích

Màn hình chính của Android, có trên hầu hết thiết bị chạy Android, cho phép người dùng nhúng tiện ích ứng dụng (hoặc tiện ích) để truy cập nhanh vào nội dung. Nếu đang tạo một ứng dụng thay thế màn hình chính hoặc một ứng dụng tương tự, bạn cũng có thể cho phép người dùng nhúng tiện ích bằng cách triển khai AppWidgetHost. Đây không phải là điều mà hầu hết các ứng dụng cần làm, nhưng nếu đang tạo máy chủ lưu trữ của riêng mình thì bạn cần hiểu rõ các nghĩa vụ theo hợp đồng mà máy chủ lưu trữ ngầm đồng ý.

Trang này tập trung vào các trách nhiệm liên quan đến việc triển khai AppWidgetHost tuỳ chỉnh. Để biết ví dụ cụ thể về cách triển khai AppWidgetHost, hãy xem mã nguồn cho màn hình chính của Android LauncherAppWidgetHost.

Dưới đây là thông tin tổng quan về các lớp và khái niệm chính liên quan đến việc triển khai một AppWidgetHost tuỳ chỉnh:

  • Máy chủ tiện ích ứng dụng: AppWidgetHost cung cấp hoạt động tương tác với dịch vụ AppWidget dành cho các ứng dụng nhúng tiện ích vào giao diện người dùng. AppWidgetHost phải có mã nhận dạng duy nhất trong gói riêng của máy chủ lưu trữ. Mã này vẫn tồn tại trong mọi lần sử dụng máy chủ. Mã nhận dạng thường là một giá trị được cố định giá trị trong mã mà bạn chỉ định trong ứng dụng của mình.

  • Mã tiện ích ứng dụng: mỗi bản sao tiện ích được gán một mã nhận dạng duy nhất tại thời điểm liên kết. Hãy xem bindAppWidgetIdIfAllowed() và để biết thêm thông tin chi tiết, hãy xem phần Liên kết tiện ích bên dưới. Máy chủ lưu trữ lấy mã nhận dạng duy nhất bằng cách sử dụng allocateAppWidgetId(). Mã này sẽ được giữ nguyên trong suốt thời gian hoạt động của tiện ích cho đến khi bị xoá khỏi máy chủ. Mọi trạng thái dành riêng cho máy chủ lưu trữ (chẳng hạn như kích thước và vị trí của tiện ích) phải được gói lưu trữ duy trì và liên kết với mã tiện ích ứng dụng.

  • Khung hiển thị tiện ích ứng dụng: hãy coi AppWidgetHostView là một khung mà tiện ích được bao bọc bất cứ khi nào cần hiển thị. Một tiện ích được liên kết với AppWidgetHostView mỗi khi tiện ích được máy chủ tăng cường.

    • Theo mặc định, hệ thống sẽ tạo một AppWidgetHostView, nhưng máy chủ lưu trữ có thể tạo lớp con AppWidgetHostView riêng bằng cách mở rộng lớp đó.
    • Kể từ Android 12 (API cấp 31), AppWidgetHostView sẽ giới thiệu các phương thức setColorResources() và resetColorResources() để xử lý các màu bị nạp chồng động. Máy chủ lưu trữ chịu trách nhiệm cung cấp màu cho các phương thức này.

  • Gói tuỳ chọn: AppWidgetHost dùng gói tuỳ chọn để truyền đạt thông tin với AppWidgetProvider về cách hiển thị tiện ích (ví dụ: danh sách phạm vi kích thước) và việc tiện ích đó nằm trên màn hình khoá hay màn hình chính. Thông tin này cho phép AppWidgetProvider điều chỉnh nội dung và giao diện của tiện ích dựa trên cách thức và vị trí hiển thị. Bạn có thể sử dụng updateAppWidgetOptions() và updateAppWidgetSize() để sửa đổi gói của một tiện ích. Cả hai phương thức này đều kích hoạt lệnh gọi lại onAppWidgetOptionsChanged() đến AppWidgetProvider.

Liên kết tiện ích

Khi người dùng thêm một tiện ích vào máy chủ lưu trữ, một quy trình có tên là liên kết sẽ xảy ra. Liên kết là việc liên kết một mã tiện ích ứng dụng cụ thể với một máy chủ lưu trữ cụ thể và một AppWidgetProvider cụ thể.

API liên kết cũng giúp máy chủ có thể cung cấp một giao diện người dùng tuỳ chỉnh để liên kết. Để sử dụng quy trình này, ứng dụng của bạn phải khai báo quyền BIND_APPWIDGET trong tệp kê khai của máy chủ:

<uses-permission android:name="android.permission.BIND_APPWIDGET" />

Nhưng đây mới chỉ là bước đầu tiên. Trong thời gian chạy, người dùng phải cấp quyền rõ ràng cho ứng dụng của bạn để ứng dụng có thể thêm tiện ích vào máy chủ. Để kiểm tra xem ứng dụng của bạn có quyền thêm tiện ích hay không, hãy sử dụng phương thức bindAppWidgetIdIfAllowed(). Nếu bindAppWidgetIdIfAllowed() trả về false, ứng dụng của bạn phải hiển thị hộp thoại nhắc người dùng cấp quyền: "cho phép" thêm tiện ích hiện tại hoặc "luôn cho phép" để bao gồm tất cả tiện ích bổ sung trong tương lai.

Đoạn mã sau đây cung cấp ví dụ về cách hiển thị hộp thoại:

Kotlin

val intent = Intent(AppWidgetManager.ACTION_APPWIDGET_BIND).apply {
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER, info.componentName)
    // This is the options bundle described in the preceding section.
    putExtra(AppWidgetManager.EXTRA_APPWIDGET_OPTIONS, options)
}
startActivityForResult(intent, REQUEST_BIND_APPWIDGET)

Java

Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_BIND);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER, info.componentName);
// This is the options bundle described in the preceding section.
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_OPTIONS, options);
startActivityForResult(intent, REQUEST_BIND_APPWIDGET);

Máy chủ lưu trữ phải kiểm tra xem tiện ích mà người dùng thêm có cần cấu hình hay không. Để biết thêm thông tin, hãy xem bài viết Cho phép người dùng định cấu hình các tiện ích của ứng dụng.

Trách nhiệm của người tổ chức

Bạn có thể chỉ định một số chế độ cài đặt cấu hình cho các tiện ích bằng cách sử dụng siêu dữ liệu AppWidgetProviderInfo. Bạn có thể truy xuất các tuỳ chọn cấu hình này (được đề cập chi tiết hơn ở các phần sau) từ đối tượng AppWidgetProviderInfo được liên kết với một trình cung cấp tiện ích.

Bất kể bạn đang nhắm đến phiên bản Android nào, tất cả máy chủ lưu trữ đều có những trách nhiệm sau:

  • Khi thêm tiện ích, hãy phân bổ ID tiện ích như được mô tả trước đó. Khi một tiện ích bị xoá khỏi máy chủ, hãy gọi deleteAppWidgetId() để phân bổ mã tiện ích đó.

  • Khi thêm tiện ích, hãy kiểm tra xem có cần khởi chạy hoạt động định cấu hình hay không. Thông thường, máy chủ lưu trữ cần chạy hoạt động cấu hình của tiện ích nếu hoạt động đó tồn tại và không được đánh dấu là không bắt buộc bằng cách chỉ định cả hai cờ configuration_optional và reconfigurable. Hãy xem phần Cập nhật tiện ích trong hoạt động định cấu hình để biết thông tin chi tiết. Đây là bước cần thiết cho nhiều tiện ích trước khi chúng có thể hiển thị.

  • Các tiện ích sẽ chỉ định chiều rộng và chiều cao mặc định trong siêu dữ liệu AppWidgetProviderInfo. Các giá trị này được xác định trong các ô (kể từ Android 12, nếu targetCellWidth và targetCellHeight được chỉ định) hoặc dps nếu chỉ minWidth và minHeight được chỉ định. Xem phần Thuộc tính kích thước tiện ích.

    Đảm bảo tiện ích được bố trí có dp tối thiểu là này. Ví dụ: nhiều máy chủ căn chỉnh biểu tượng và tiện ích trong một lưới. Trong trường hợp này, theo mặc định, máy chủ lưu trữ sẽ thêm tiện ích bằng cách sử dụng số lượng ô tối thiểu đáp ứng các điều kiện ràng buộc minWidth và minHeight.

Ngoài các yêu cầu được liệt kê trong phần trước, các phiên bản nền tảng cụ thể giới thiệu các tính năng đặt trách nhiệm mới đối với máy chủ lưu trữ.

Xác định phương pháp tiếp cận của bạn dựa trên phiên bản Android được nhắm đến

Android 12

Android 12 (API cấp 31) sẽ gói thêm một List<SizeF> chứa danh sách kích thước có thể dùng tính theo dps mà thực thể tiện ích có thể nhận trong gói tuỳ chọn. Số lượng kích thước được cung cấp tuỳ thuộc vào cách triển khai máy chủ lưu trữ. Máy chủ lưu trữ thường cung cấp 2 kích thước cho điện thoại (dọc và ngang) và 4 kích thước cho thiết bị có thể gập lại.

Có giới hạn là MAX_INIT_VIEW_COUNT (16) về số lượng RemoteViews khác nhau mà AppWidgetProvider có thể cung cấp cho RemoteViews. Do các đối tượng AppWidgetProvider ánh xạ một đối tượng RemoteViews với từng kích thước trong List<SizeF>, bạn không nên cung cấp quá MAX_INIT_VIEW_COUNT kích thước.

Android 12 cũng giới thiệu các thuộc tính maxResizeWidth và maxResizeHeight tính bằng dps. Tiện ích sử dụng ít nhất một trong các thuộc tính này không vượt quá kích thước mà các thuộc tính chỉ định.

Tài nguyên khác

  • Hãy xem tài liệu tham khảo về Glance.