Menangani error dengan Glance

Fitur API untuk meningkatkan penanganan error di Glance disertakan mulai Android 15. Halaman ini menyediakan beberapa praktik terbaik terkait API tersebut.

Menggunakan blok try-catch di sekitar komponen non-composable

Compose tidak mengizinkan blok try-catch di sekitar composable, tetapi memungkinkan Anda menggabungkan logika lain aplikasi dalam blok ini. Hal ini memungkinkan Anda menggunakan Compose untuk tampilan error, seperti yang ditunjukkan pada contoh berikut:

provideContent {
       var isError = false;
       var data = null
       try {
           val repository = (context.applicationContext as MyApplication).myRepository
           data = repository.loadData()
       } catch (e: Exception) {
           isError = true;
           //handleError
       }

       if (isError) {
           ErrorView()
       } else {
           Content(data)
       }
   }

Tata letak error default

Jika ada pengecualian yang tidak tertangkap atau error Compose, Glance akan menampilkan tata letak error default:

Glance memungkinkan developer memberikan tata letak XML sebagai penggantian jika komposisi gagal. Hal ini berarti terjadi error dalam kode Compose. UI error ini juga muncul jika Anda memiliki error yang tidak tertangkap dalam kode aplikasi.

class UpgradeWidget : GlanceAppWidget(errorUiLayout = R.layout.error_layout)

Tata letak ini adalah tata letak statis yang tidak dapat berinteraksi dengan pengguna Anda, tetapi berfungsi dalam kasus darurat.

Menambahkan tindakan ke UI error default

Mulai dari Glance 1.1.0, Glance memungkinkan Anda mengganti kode penanganan error default. Dengan cara ini, Anda dapat menambahkan callback tindakan jika terjadi pengecualian yang tidak tertangkap atau error dalam komposisi.

Untuk menggunakan fitur ini, ganti fungsi onCompositionError():

GlanceAppWidget.onCompositionError(
    context: Context,
    glanceId: GlanceId,
    AppWidgetId: Int,
    throwable: Throwable
)

Dalam fungsi ini, Glance akan melakukan penggantian ke RemoteViews API untuk penanganan error. Elemen ini memungkinkan Anda menetapkan tata letak dan pengendali tindakan menggunakan XML.

Contoh berikut menunjukkan langkah demi langkah cara membuat UI error yang menyertakan tombol untuk mengirim masukan:

1. Menulis file error_layout.xml

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
   style="@style/Widget.MyApplication.AppWidget.Error"
   android:id="@android:id/background"
   android:layout_width="match_parent"
   android:textSize="24sp"
   android:layout_height="match_parent"
   android:orientation="vertical">


   <TextView
       android:id="@+id/error_title_view"
       android:layout_width="match_parent"
       android:textColor="@color/white"
       android:textFontWeight="800"
       android:layout_height="wrap_content"
       android:text="Example Widget Error" />

   <LinearLayout
       android:layout_width="match_parent"
       android:orientation="horizontal"
       android:paddingTop="4dp"
       android:layout_height="match_parent">

       <ImageButton
           android:layout_width="64dp"
           android:layout_height="64dp"
           android:layout_gravity="center"
           android:tint="@color/white"
           android:id="@+id/error_icon"
           android:src="@drawable/heart_broken_fill0_wght400_grad0_opsz24"
       />
       <TextView
           android:id="@+id/error_text_view"
           android:layout_width="wrap_content"
           android:textColor="@color/white"
           android:layout_height="wrap_content"
           android:layout_gravity="center"
           android:padding="8dp"
           android:textSize="16sp"
           android:layout_weight="1"
           android:text="Useful Error Message!" />
   </LinearLayout>

</LinearLayout>

1. Mengganti fungsi onCompositionError

override fun onCompositionError(
   context: Context,
   glanceId: GlanceId,
   AppWidgetId: Int,
   throwable: Throwable
) {
   val rv = RemoteViews(context.packageName, R.layout.error_layout)
   rv.setTextViewText(
       R.id.error_text_view,
       "Error was thrown. \nThis is a custom view \nError Message: `${throwable.message}`"
   )
   rv.setOnClickPendingIntent(R.id.error_icon, getErrorIntent(context, throwable))
   AppWidgetManager.getInstance(context).updateAppWidget(AppWidgetId, rv)
}

1. Buat intent tertunda yang mereferensikan GlanceAppWidgetReceiver Anda

private fun getErrorIntent(context: Context, throwable: Throwable): PendingIntent {
    val intent = Intent(context, UpgradeToHelloWorldPro::class.java)
    intent.setAction("widgetError")
    return PendingIntent.getBroadcast(context, 0, intent, PendingIntent.FLAG_IMMUTABLE)
}

1. Menangani intent di GlanceAppWidgetReceiver

override fun onReceive(context: Context, intent: Intent) {
   super.onReceive(context, intent)
   Log.e("ErrorOnClick", "Button was clicked.");
}