Radzenie sobie z błędami za pomocą Glance

Funkcje interfejsu API służące do ulepszania obsługi błędów w Glance są dostępne od Androida 15. Na tej stronie znajdziesz sprawdzone metody dotyczące tych interfejsów API.

Używanie bloku try-catch wokół komponentów, które nie są komponentami składanymi

Compose nie zezwala na bloki try-catch wokół komponentów, ale umożliwia umieszczanie w tych blokach innych elementów logiki aplikacji. Dzięki temu możesz używać Compose do wyświetlania błędów, jak w tym przykładzie:

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)
       }
   }

Domyślny układ błędu

Jeśli wystąpi nieprzechwycony wyjątek lub błąd w komponencie Compose, Glance wyświetli domyślny układ błędu:

Rysunek 1.Domyślny układ błędów w usługi Informacje 1.0

Rysunek 2.Domyślny układ błędów w usługi Informacje 1.1.0

W przypadku niepowodzenia tworzenia kompozycji Glance pozwala deweloperom podać układ XML jako alternatywę. Oznacza to, że w kodzie Compose wystąpił błąd. To UI błędu pojawia się również, gdy w kodzie aplikacji występuje niewykryty błąd.

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

Jest to układ statyczny, z którym użytkownik nie może wchodzić w interakcje, ale który sprawdza się w przypadku nagłych sytuacji.

Rysunek 3. Przykład niestandardowego układu błędu

Dodawanie działań do domyślnego interfejsu błędu

Od wersji Glance 1.1.0 możesz zastąpić domyślny kod obsługi błędów. Dzięki temu możesz dodać wywołania zwrotne akcji w przypadku nieprzechwyczonej wyjątku lub błędu podczas kompilacji.

Aby korzystać z tej funkcji, zastąpij funkcję onCompositionError():

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

W tej funkcji Glance korzysta z interfejsu API RemoteViews do obsługi błędów. Umożliwia to określanie układów i modułów obsługi działań za pomocą kodu XML.

Poniższe przykłady pokazują krok po kroku, jak utworzyć interfejs błędu, który zawiera przycisk do wysyłania opinii:

1. Tworzenie pliku 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. Zastępowanie funkcji 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. Utwórz oczekujący zamiar, który odwołuje się do Twojego GlanceAppWidgetReceiver

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. Zarządzaj zamiarem w GlanceAppWidgetReceiver

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