Tạo một tiện ích đơn giản

Tiện ích ứng dụng là các chế độ xem ứng dụng thu nhỏ mà bạn có thể nhúng vào các ứng dụng khác (chẳng hạn như màn hình chính) và nhận các bản cập nhật định kỳ. Các chế độ xem này được gọi là tiện ích trong giao diện người dùng và bạn có thể phát hành một chế độ xem bằng nhà cung cấp tiện ích ứng dụng (hoặc nhà cung cấp tiện ích). Một thành phần ứng dụng chứa các tiện ích khác được gọi là máy chủ tiện ích ứng dụng (hoặc máy chủ tiện ích). Hình 1 cho thấy một tiện ích nhạc mẫu:

Ví dụ về tiện ích âm nhạc
Hình 1. Ví dụ về tiện ích âm nhạc.

Tài liệu này mô tả cách phát hành tiện ích bằng nhà cung cấp tiện ích. Để biết thông tin chi tiết về cách tạo AppWidgetHost của riêng bạn để lưu trữ các tiện ích ứng dụng, hãy xem bài viết Tạo máy chủ tiện ích.

Để biết thông tin về cách thiết kế tiện ích, hãy xem nội dung Tổng quan về tiện ích ứng dụng.

Thành phần tiện ích

Để tạo một tiện ích, bạn cần có những thành phần cơ bản sau đây:

Đối tượng AppWidgetProviderInfo
Mô tả siêu dữ liệu của một tiện ích, chẳng hạn như bố cục, tần suất cập nhật và lớp AppWidgetProvider của tiện ích. AppWidgetProviderInfo được định nghĩa trong XML, như mô tả trong tài liệu này.
Lớp AppWidgetProvider
Xác định các phương thức cơ bản cho phép bạn lập trình giao diện bằng tiện ích. Thông qua đó, bạn sẽ nhận được các thông báo truyền tin khi tiện ích này được cập nhật, bật, tắt hoặc xoá. Bạn khai báo AppWidgetProvider trong tệp kê khai rồi triển khai tệp đó, như mô tả trong tài liệu này.
Xem bố cục
Xác định bố cục ban đầu cho tiện ích. Bố cục được xác định trong XML, như mô tả trong tài liệu này.

Hình 2 cho thấy mức độ phù hợp của các thành phần này với quy trình xử lý tiện ích ứng dụng tổng thể.

Quy trình xử lý tiện ích ứng dụng
Hình 2. Quy trình xử lý tiện ích ứng dụng.

Nếu tiện ích của bạn cần cấu hình người dùng, hãy triển khai hoạt động định cấu hình của tiện ích ứng dụng. Hoạt động này cho phép người dùng sửa đổi các chế độ cài đặt của tiện ích (ví dụ: múi giờ cho tiện ích đồng hồ).

Bạn cũng nên cải thiện các điểm sau: bố cục tiện ích linh hoạt, các tính năng nâng cao khác, tiện ích nâng cao, tiện ích bộ sưu tậptạo máy chủ tiện ích.

Khai báo tệp XML AppWidgetProviderInfo

Đối tượng AppWidgetProviderInfo xác định các tính chất thiết yếu của một tiện ích. Xác định đối tượng AppWidgetProviderInfo trong tệp tài nguyên XML bằng cách sử dụng một phần tử <appwidget-provider> và lưu đối tượng đó vào thư mục res/xml/ của dự án.

Lệnh này được minh hoạ trong ví dụ sau:

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="40dp"
    android:minHeight="40dp"
    android:targetCellWidth="1"
    android:targetCellHeight="1"
    android:maxResizeWidth="250dp"
    android:maxResizeHeight="120dp"
    android:updatePeriodMillis="86400000"
    android:description="@string/example_appwidget_description"
    android:previewLayout="@layout/example_appwidget_preview"
    android:initialLayout="@layout/example_loading_appwidget"
    android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen"
    android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>

Thuộc tính định kích thước tiện ích

Màn hình chính mặc định sẽ đặt các tiện ích trong cửa sổ đó dựa trên một lưới các ô có chiều cao và chiều rộng đã xác định. Hầu hết màn hình chính chỉ cho phép các tiện ích lấy kích thước là bội số nguyên của các ô lưới – ví dụ: 2 ô theo chiều ngang và 3 ô theo chiều dọc.

Các thuộc tính kích thước tiện ích cho phép bạn chỉ định một kích thước mặc định cho tiện ích, đồng thời cung cấp các giới hạn dưới và giới hạn trên của kích thước tiện ích đó. Trong trường hợp này, kích thước mặc định của tiện ích là kích thước mà tiện ích đó sẽ sử dụng khi được thêm vào màn hình chính lần đầu tiên.

Bảng sau đây mô tả các thuộc tính <appwidget-provider> liên quan đến việc định kích thước tiện ích:

Thuộc tính và nội dung mô tả
targetCellWidthtargetCellHeight (Android 12), minWidthminHeight
  • Kể từ Android 12, các thuộc tính targetCellWidthtargetCellHeight sẽ chỉ định kích thước mặc định của tiện ích dựa trên các ô lưới. Các thuộc tính này bị bỏ qua trong Android 11 trở xuống và có thể bị bỏ qua nếu màn hình chính không hỗ trợ bố cục dựa trên lưới.
  • Thuộc tính minWidthminHeight chỉ định kích thước mặc định của tiện ích tính bằng dp. Nếu giá trị chiều rộng hoặc chiều cao tối thiểu của một tiện ích không khớp với kích thước của các ô, thì các giá trị đó sẽ được làm tròn lên đến kích thước ô gần nhất.
Bạn nên chỉ định cả hai bộ thuộc tính – targetCellWidthtargetCellHeight, minWidthminHeight – để ứng dụng của bạn có thể quay lại sử dụng minWidthminHeight nếu thiết bị của người dùng không hỗ trợ targetCellWidthtargetCellHeight. Nếu được hỗ trợ, các thuộc tính targetCellWidthtargetCellHeight sẽ được ưu tiên hơn các thuộc tính minWidthminHeight.
minResizeWidthminResizeHeight Chỉ định kích thước tối thiểu tuyệt đối của tiện ích. Các giá trị này chỉ định kích thước mà tiện ích khó đọc hoặc không sử dụng được. Việc sử dụng các thuộc tính này cho phép người dùng đổi kích thước tiện ích thành kích thước nhỏ hơn kích thước tiện ích mặc định. Thuộc tính minResizeWidth sẽ bị bỏ qua nếu thuộc tính này lớn hơn minWidth hoặc nếu bạn không bật tính năng đổi kích thước theo chiều ngang. Hãy xem resizeMode. Tương tự, thuộc tính minResizeHeight sẽ bị bỏ qua nếu thuộc tính này lớn hơn minHeight hoặc nếu bạn không bật tính năng đổi kích thước theo chiều dọc.
maxResizeWidthmaxResizeHeight Chỉ định kích thước tối đa được đề xuất cho tiện ích. Nếu các giá trị không phải là bội số của kích thước ô lưới, thì các giá trị đó sẽ được làm tròn lên kích thước ô gần nhất. Thuộc tính maxResizeWidth sẽ bị bỏ qua nếu thuộc tính này nhỏ hơn minWidth hoặc nếu bạn không bật tính năng đổi kích thước theo chiều ngang. Hãy xem resizeMode. Tương tự, thuộc tính maxResizeHeight sẽ bị bỏ qua nếu thuộc tính này lớn hơn minHeight hoặc nếu bạn không bật tính năng đổi kích thước theo chiều dọc. Ra mắt trong Android 12.
resizeMode Chỉ định các quy tắc mà theo đó bạn có thể đổi kích thước tiện ích. Bạn có thể dùng thuộc tính này để giúp các tiện ích trên màn hình chính có thể đổi kích thước theo chiều ngang, chiều dọc hoặc trên cả hai trục. Người dùng chạm và giữ một tiện ích để hiện ô điều khiển thay đổi kích thước, sau đó kéo ô điều khiển theo chiều ngang hoặc chiều dọc để thay đổi kích thước trên lưới bố cục. Giá trị cho thuộc tính resizeMode bao gồm horizontal, verticalnone. Để khai báo một tiện ích là có thể đổi kích thước theo chiều ngang và chiều dọc, hãy sử dụng horizontal|vertical.

Ví dụ

Để minh hoạ cách các thuộc tính trong bảng trước ảnh hưởng đến kích thước tiện ích, giả sử các thông số kỹ thuật sau:

  • Ô lưới có chiều rộng 30 dp và chiều cao 50 dp.
  • Hệ thống cung cấp quy cách thuộc tính sau đây:
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="80dp"
    android:minHeight="80dp"
    android:targetCellWidth="2"
    android:targetCellHeight="2"
    android:minResizeWidth="40dp"
    android:minResizeHeight="40dp"
    android:maxResizeWidth="120dp"
    android:maxResizeHeight="120dp"
    android:resizeMode="horizontal|vertical" />

Kể từ Android 12:

Hãy dùng thuộc tính targetCellWidthtargetCellHeight làm kích thước mặc định của tiện ích.

Kích thước của tiện ích là 2x2 theo mặc định. Bạn có thể đổi kích thước tiện ích xuống 2x1 hoặc tối đa 4x3.

Android 11 trở xuống:

Sử dụng thuộc tính minWidthminHeight để tính toán kích thước mặc định của tiện ích.

Chiều rộng mặc định = Math.ceil(80 / 30) = 3

Chiều cao mặc định = Math.ceil(80 / 50) = 2

Kích thước của tiện ích là 3x2 theo mặc định. Bạn có thể đổi kích thước tiện ích thành 2x1 hoặc tối đa toàn màn hình.

Thuộc tính tiện ích bổ sung

Bảng sau đây mô tả các thuộc tính <appwidget-provider> liên quan đến các chất lượng khác ngoài kích thước tiện ích.

Thuộc tính và nội dung mô tả
updatePeriodMillis Xác định tần suất khung tiện ích yêu cầu một bản cập nhật từ AppWidgetProvider bằng cách gọi phương thức gọi lại onUpdate(). Việc cập nhật thực tế không đảm bảo sẽ diễn ra chính xác đúng thời gian với giá trị này. Bạn nên cập nhật ít nhất có thể (tối đa một lần mỗi giờ) để tiết kiệm pin. Để xem danh sách đầy đủ các yếu tố cần cân nhắc nhằm chọn khoảng thời gian cập nhật thích hợp, hãy xem bài viết Tối ưu hoá để cập nhật nội dung tiện ích.
initialLayout Trỏ đến tài nguyên bố cục xác định bố cục tiện ích.
configure Xác định hoạt động chạy khi người dùng thêm tiện ích, cho phép họ định cấu hình các thuộc tính tiện ích. Hãy xem phần Cho phép người dùng định cấu hình tiện ích. Kể từ Android 12, ứng dụng của bạn có thể bỏ qua cấu hình ban đầu. Hãy xem phần Sử dụng cấu hình mặc định của tiện ích để biết thông tin chi tiết.
description Chỉ định nội dung mô tả cho bộ chọn tiện ích để hiển thị cho tiện ích của bạn. Ra mắt trong Android 12.
previewLayout (Android 12) và previewImage (Android 11 trở xuống)
  • Kể từ Android 12, thuộc tính previewLayout chỉ định một bản xem trước có thể mở rộng mà bạn cung cấp dưới dạng một bố cục XML được đặt thành kích thước mặc định của tiện ích. Tốt nhất là XML bố cục được chỉ định làm thuộc tính này giống với XML bố cục với tiện ích thực tế với các giá trị mặc định thực tế.
  • Trong Android 11 trở xuống, thuộc tính previewImage chỉ định bản xem trước giao diện của tiện ích sau khi được định cấu hình. Người dùng sẽ nhìn thấy điều này khi chọn tiện ích ứng dụng. Nếu mã không được cung cấp, người dùng sẽ nhìn thấy biểu tượng trình chạy của ứng dụng. Trường này tương ứng với thuộc tính android:previewImage trong phần tử <receiver> của tệp AndroidManifest.xml.
Lưu ý: Bạn nên chỉ định cả thuộc tính previewImagepreviewLayout để ứng dụng có thể quay lại sử dụng previewImage nếu thiết bị của người dùng không hỗ trợ previewLayout. Để biết thêm thông tin, hãy xem phần Khả năng tương thích ngược với bản xem trước tiện ích có thể mở rộng.
autoAdvanceViewId Chỉ định mã chế độ xem của khung hiển thị phụ tiện ích được máy chủ lưu trữ tiện ích tự động nâng cao.
widgetCategory Khai báo việc tiện ích của bạn có thể hiển thị trên màn hình chính (home_screen), màn hình khoá (keyguard) hay cả hai. Đối với Android 5.0 trở lên, chỉ home_screen hợp lệ.
widgetFeatures Khai báo các tính năng mà tiện ích hỗ trợ. Ví dụ: nếu bạn muốn tiện ích của mình sử dụng cấu hình mặc định khi người dùng thêm tiện ích đó, hãy chỉ định cả cờ configuration_optionalreconfigurable. Thao tác này sẽ bỏ qua việc chạy hoạt động định cấu hình sau khi người dùng thêm tiện ích. Sau đó, người dùng vẫn có thể định cấu hình lại tiện ích.

Sử dụng lớp AppWidgetProvider để xử lý các thông báo truyền tin tiện ích

Lớp AppWidgetProvider xử lý thông báo truyền tin và cập nhật tiện ích để phản hồi các sự kiện trong vòng đời của tiện ích. Những phần sau đây mô tả cách khai báo AppWidgetProvider trong tệp kê khai rồi triển khai tệp đó.

Khai báo tiện ích trong tệp kê khai

Trước tiên, hãy khai báo lớp AppWidgetProvider trong tệp AndroidManifest.xml của ứng dụng như trong ví dụ sau:

<receiver android:name="ExampleAppWidgetProvider"
                 android:exported="false">
    <intent-filter>
        <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
    </intent-filter>
    <meta-data android:name="android.appwidget.provider"
               android:resource="@xml/example_appwidget_info" />
</receiver>

Phần tử <receiver> yêu cầu thuộc tính android:name. Thuộc tính này chỉ định AppWidgetProvider mà tiện ích sử dụng. Bạn không được xuất thành phần này trừ phi có một quy trình riêng cần truyền tin tới AppWidgetProvider (thường không đúng như vậy).

Phần tử <intent-filter> phải chứa một phần tử <action> có thuộc tính android:name. Thuộc tính này chỉ định rằng AppWidgetProvider chấp nhận thông báo truyền tin ACTION_APPWIDGET_UPDATE. Đây là thông báo truyền tin duy nhất mà bạn phải khai báo rõ ràng. AppWidgetManager tự động gửi mọi thông báo về tiện ích khác tới AppWidgetProvider nếu cần.

Phần tử <meta-data> chỉ định tài nguyên AppWidgetProviderInfo và yêu cầu các thuộc tính sau:

  • android:name: chỉ định tên của siêu dữ liệu. Sử dụng android.appwidget.provider để xác định dữ liệu dưới dạng chỉ số mô tả AppWidgetProviderInfo.
  • android:resource: chỉ định vị trí tài nguyên AppWidgetProviderInfo.

Triển khai lớp AppWidgetProvider

Lớp AppWidgetProvider mở rộng BroadcastReceiver làm lớp tiện lợi để xử lý các thông báo truyền tin tiện ích. Lớp đó chỉ nhận các thông báo sự kiện liên quan đến tiện ích, chẳng hạn như khi tiện ích được cập nhật, xoá, bật và tắt. Khi các sự kiện truyền tin này xảy ra, các phương thức AppWidgetProvider sau đây sẽ được gọi:

onUpdate()
Lệnh gọi này được gọi để cập nhật tiện ích tại các khoảng thời gian do thuộc tính updatePeriodMillis trong AppWidgetProviderInfo xác định. Hãy xem bảng mô tả các thuộc tính khác của tiện ích trong trang này để biết thêm thông tin.
Phương thức này cũng được gọi khi người dùng thêm tiện ích, vì vậy, phương thức này sẽ thực hiện các bước thiết lập cần thiết như xác định trình xử lý sự kiện cho các đối tượng View hoặc bắt đầu công việc để tải dữ liệu để hiển thị trong tiện ích. Tuy nhiên, nếu bạn khai báo một hoạt động cấu hình không có cờ configuration_optional, thì phương thức này sẽ không được gọi khi người dùng thêm tiện ích, nhưng sẽ được gọi cho các bản cập nhật tiếp theo. Hoạt động định cấu hình có trách nhiệm thực hiện lần cập nhật đầu tiên khi cấu hình hoàn tất. Xem Cho phép người dùng định cấu hình tiện ích ứng dụng để biết thêm thông tin.
Lệnh gọi lại quan trọng nhất là onUpdate(). Hãy xem bài viết Xử lý sự kiện bằng lớp onUpdate() trên trang này để biết thêm thông tin.
onAppWidgetOptionsChanged()

Lệnh này được gọi khi tiện ích được đặt lần đầu tiên và bất cứ khi nào tiện ích được đổi kích thước. Hãy sử dụng lệnh gọi lại này để hiện hoặc ẩn nội dung dựa trên phạm vi kích thước của tiện ích. Lấy phạm vi kích thước và kể từ Android 12, danh sách các kích thước mà một thực thể tiện ích có thể có thể sử dụng bằng cách gọi getAppWidgetOptions(). Lệnh này sẽ trả về một Bundle bao gồm:

  • OPTION_APPWIDGET_MIN_WIDTH: chứa giới hạn dưới của chiều rộng, tính bằng đơn vị dp, của một thực thể tiện ích.
  • OPTION_APPWIDGET_MIN_HEIGHT: chứa giới hạn dưới của chiều cao, tính bằng đơn vị dp, của một thực thể tiện ích.
  • OPTION_APPWIDGET_MAX_WIDTH: chứa giới hạn trên của chiều rộng, tính bằng đơn vị dp, của một thực thể tiện ích.
  • OPTION_APPWIDGET_MAX_HEIGHT: chứa giới hạn trên của chiều cao, tính bằng đơn vị dp, của một thực thể tiện ích.
  • OPTION_APPWIDGET_SIZES: chứa danh sách các kích thước có thể sử dụng (List<SizeF>), theo đơn vị dp mà một thực thể tiện ích có thể nhận. Ra mắt trong Android 12.
onDeleted(Context, int[])

Lệnh này được gọi mỗi khi một tiện ích bị xoá khỏi máy chủ tiện ích.

onEnabled(Context)

Lệnh này được gọi khi một thực thể của tiện ích được tạo lần đầu tiên. Ví dụ: nếu người dùng thêm hai phiên bản tiện ích của bạn, thì đây chỉ được gọi là lần đầu tiên. Nếu cần mở một cơ sở dữ liệu mới hoặc thực hiện một quá trình thiết lập khác chỉ cần diễn ra một lần cho mọi thực thể của tiện ích, thì đây là nơi phù hợp để thực hiện việc này.

onDisabled(Context)

Lệnh này được gọi khi bản sao cuối cùng của tiện ích bị xoá khỏi máy chủ tiện ích. Đây là nơi bạn dọn dẹp mọi công việc đã làm trong onEnabled(Context), chẳng hạn như xoá cơ sở dữ liệu tạm thời.

onReceive(Context, Intent)

Lệnh này được gọi cho mọi thông báo truyền tin và trước mỗi phương thức gọi lại trước đó. Thông thường, bạn không cần triển khai phương thức này vì phương thức triển khai AppWidgetProvider mặc định sẽ lọc tất cả các thông báo truyền tin tiện ích và gọi các phương thức trước đó khi phù hợp.

Bạn phải khai báo cách triển khai lớp AppWidgetProvider ở dạng broadcast receiver bằng phần tử <receiver> trong AndroidManifest. Hãy xem phần Khai báo tiện ích trong tệp kê khai trên trang này để biết thêm thông tin.

Xử lý các sự kiện bằng lớp onUpdate()

Lệnh gọi lại AppWidgetProvider quan trọng nhất là onUpdate() vì lệnh này được gọi khi mỗi tiện ích được thêm vào máy chủ, trừ phi bạn sử dụng một hoạt động cấu hình không có cờ configuration_optional. Nếu tiện ích của bạn chấp nhận mọi sự kiện tương tác của người dùng, hãy đăng ký trình xử lý sự kiện trong lệnh gọi lại này. Nếu tiện ích của bạn không tạo tệp hoặc cơ sở dữ liệu tạm thời hoặc thực hiện công việc khác cần dọn dẹp, thì onUpdate() có thể là phương thức gọi lại duy nhất mà bạn cần xác định.

Ví dụ: nếu muốn một tiện ích có nút khởi chạy một hoạt động khi được nhấn, bạn có thể sử dụng cách triển khai AppWidgetProvider sau:

Kotlin

class ExampleAppWidgetProvider : AppWidgetProvider() {

    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray
    ) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        appWidgetIds.forEach { appWidgetId ->
            // Create an Intent to launch ExampleActivity.
            val pendingIntent: PendingIntent = PendingIntent.getActivity(
                    /* context = */ context,
                    /* requestCode = */  0,
                    /* intent = */ Intent(context, ExampleActivity::class.java),
                    /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
            )

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            val views: RemoteViews = RemoteViews(
                    context.packageName,
                    R.layout.appwidget_provider_layout
            ).apply {
                setOnClickPendingIntent(R.id.button, pendingIntent)
            }

            // Tell the AppWidgetManager to perform an update on the current
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

Java

public class ExampleAppWidgetProvider extends AppWidgetProvider {

    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        for (int i=0; i < appWidgetIds.length; i++) {
            int appWidgetId = appWidgetIds[i];
            // Create an Intent to launch ExampleActivity
            Intent intent = new Intent(context, ExampleActivity.class);
            PendingIntent pendingIntent = PendingIntent.getActivity(
                /* context = */ context,
                /* requestCode = */ 0,
                /* intent = */ intent,
                /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE
            );

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget_layout);
            views.setOnClickPendingIntent(R.id.button, pendingIntent);

            // Tell the AppWidgetManager to perform an update on the current app
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views);
        }
    }
}

AppWidgetProvider này chỉ xác định phương thức onUpdate() và sử dụng phương thức này để tạo PendingIntent khởi chạy Activity và đính kèm phương thức này vào nút của tiện ích bằng cách sử dụng setOnClickPendingIntent(int, PendingIntent). API này bao gồm một vòng lặp lặp lại qua từng mục nhập trong appWidgetIds. Đây là một mảng mã nhận dạng giúp xác định từng tiện ích do trình cung cấp này tạo ra. Nếu người dùng tạo nhiều phiên bản của tiện ích, thì tất cả các phiên bản đó sẽ cập nhật đồng thời. Tuy nhiên, chỉ có một lịch biểu updatePeriodMillis được quản lý cho tất cả các bản sao của tiện ích này. Ví dụ: nếu lịch cập nhật được xác định là 2 giờ một lần và bản sao thứ hai của tiện ích được thêm 1 giờ sau bản sao đầu tiên, thì cả hai sẽ được cập nhật vào khoảng thời gian do bản đầu tiên xác định và khoảng thời gian cập nhật thứ hai sẽ bị bỏ qua. Cả hai đều cập nhật 2 giờ một lần, chứ không phải mỗi giờ.

Hãy xem lớp mẫu ExampleAppWidgetProvider.java để biết thêm thông tin chi tiết.

Nhận ý định truyền tin của tiện ích

AppWidgetProvider là một lớp tiện lợi. Nếu muốn trực tiếp nhận thông báo của tiện ích, bạn có thể triển khai BroadcastReceiver của riêng mình hoặc ghi đè lệnh gọi lại onReceive(Context,Intent). Ý định bạn cần quan tâm như sau:

Tạo bố cục tiện ích

Bạn phải xác định bố cục ban đầu cho tiện ích của mình trong XML và lưu bố cục đó vào thư mục res/layout/ của dự án. Tham khảo Nguyên tắc thiết kế để biết thông tin chi tiết.

Việc tạo bố cục tiện ích rất đơn giản nếu bạn đã quen thuộc với bố cục. Tuy nhiên, hãy lưu ý rằng bố cục tiện ích dựa trên RemoteViews, không hỗ trợ mọi loại bố cục hoặc tiện ích khung hiển thị. Bạn không thể sử dụng khung hiển thị tuỳ chỉnh hoặc lớp con của khung hiển thị được RemoteViews hỗ trợ.

RemoteViews cũng hỗ trợ ViewStub, đây là một View vô hình, có kích thước bằng 0 mà bạn có thể sử dụng để tăng cường từng phần tài nguyên bố cục trong thời gian chạy.

Hỗ trợ hành vi có trạng thái

Android 12 hỗ trợ thêm hành vi có trạng thái bằng cách sử dụng các thành phần hiện có sau đây:

Tiện ích này vẫn không có trạng thái. Ứng dụng phải lưu trữ trạng thái và đăng ký các sự kiện thay đổi trạng thái.

Ví dụ về tiện ích danh sách mua sắm thể hiện hoạt động có trạng thái
Hình 3. Ví dụ về hành vi có trạng thái.

Ví dụ về mã sau đây cho thấy cách triển khai các thành phần này.

Kotlin

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true)

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2)

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
        R.id.my_checkbox,
        RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent)
)

Java

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true);

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2);

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
    R.id.my_checkbox,
    RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));

Cung cấp 2 bố cục: một bố cục nhắm đến thiết bị chạy Android 12 trở lên trong res/layout-v31 và bố cục còn lại nhắm đến Android 11 trở xuống trong thư mục res/layout mặc định.

Triển khai các góc tròn

Android 12 ra mắt các tham số hệ thống sau đây để đặt góc tròn cho góc tròn của tiện ích:

  • system_app_widget_background_radius: bán kính góc của nền tiện ích (không bao giờ lớn hơn 28 dp).

  • system_app_widget_inner_radius: bán kính góc của thành phần hiển thị bất kỳ bên trong tiện ích. Bán kính này nhỏ hơn chính xác 8 dp so với bán kính nền để căn chỉnh phù hợp khi sử dụng khoảng đệm 8 dp.

Ví dụ sau đây cho thấy một tiện ích sử dụng system_app_widget_background_radius cho góc của tiện ích và system_app_widget_inner_radius cho các khung hiển thị bên trong tiện ích.

Tiện ích cho thấy bán kính của nền tiện ích và khung hiển thị bên trong tiện ích
Hình 4. Góc bo tròn.

1 Góc của tiện ích.

2 Góc của thành phần hiển thị bên trong tiện ích.

Lưu ý quan trọng đối với góc tròn

  • Trình chạy và nhà sản xuất thiết bị của bên thứ ba có thể ghi đè tham số system_app_widget_background_radius thành kích thước nhỏ hơn 28 dp. Tham số system_app_widget_inner_radius luôn nhỏ hơn 8 dp so với giá trị của system_app_widget_background_radius.
  • Nếu tiện ích của bạn không sử dụng @android:id/background hoặc xác định nền sẽ cắt nội dung của ứng dụng dựa trên đường viền (với android:clipToOutline được đặt thành true), thì trình chạy sẽ tự động xác định nền và cắt tiện ích bằng một hình chữ nhật có góc bo tròn lên tới 16 dp. Hãy xem phần Đảm bảo tiện ích của bạn tương thích với Android 12.

Để tương thích tiện ích với các phiên bản Android trước, bạn nên xác định các thuộc tính tuỳ chỉnh và sử dụng một giao diện tuỳ chỉnh để ghi đè các thuộc tính đó cho Android 12, như minh hoạ trong các tệp XML mẫu sau:

/values/attrs.xml

<resources>
  <attr name="backgroundRadius" format="dimension" />
</resources>

/values/styles.xml

<resources>
  <style name="MyWidgetTheme">
    <item name="backgroundRadius">@dimen/my_background_radius_dimen</item>
  </style>
</resources>

/values-31/styles.xml

<resources>
  <style name="MyWidgetTheme" parent="@android:style/Theme.DeviceDefault.DayNight">
    <item name="backgroundRadius">@android:dimen/system_app_widget_background_radius</item>
  </style>
</resources>

/drawable/my_widget_background.xml

<shape xmlns:android="http://schemas.android.com/apk/res/android"
  android:shape="rectangle">
  <corners android:radius="?attr/backgroundRadius" />
  ...
</shape>

/layout/my_widget_layout.xml

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
  ...
  android:background="@drawable/my_widget_background" />