Radzenie sobie z błędami za pomocą Glance

Funkcje interfejsu API, które poprawiają obsługę 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órych nie można łączyć

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

provideContent {
    var isError = false
    var data = listOf<String>()
    try {
        val repository = (context.applicationContext as MyApplication).myRepository
        data = repository.loadData()
    } catch (e: Exception) {
        isError = true
        // TODO: handle error
    }

    if (isError) {
        ErrorView()
    } else {
        Content(data)
    }
}
GlanceSnippets.kt

Domyślny układ błędu

Jeśli wystąpi nieobsłużony wyjątek lub błąd Compose, Glance wyświetli domyślny układ błędu:

Rysunek 1. Domyślny układ błędu w Glance 1.0

Rysunek 2. Domyślny układ błędu w Glance 1.1.0

Glance umożliwia deweloperom udostępnienie układu XML jako opcji zastępczej, jeśli kompozycja się nie powiedzie. Oznacza to, że w kodzie Compose wystąpił błąd. Ten interfejs błędu pojawia się też, gdy w kodzie aplikacji występuje nieobsłużony błąd.

class UpgradeWidget : GlanceAppWidget(errorUiLayout = R.layout.error_layout) {
    // ...
}
GlanceSnippets.kt

Ten układ jest statyczny i użytkownik nie może z nim wchodzić w interakcję, ale jest przydatny w sytuacjach awaryjnych.

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 dodawać wywołania zwrotne działań w przypadku nieobsłużonego wyjątku lub błędu w kompozycji.

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

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

W tej funkcji Glance wraca do interfejsu API RemoteViews w celu obsługi błędów. Dzięki temu możesz określać układy i obsługę działań za pomocą XML.

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

1. Napisz plik 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>
   

2. Zastąp funkcję 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)
   }
   GlanceSnippets.kt

3. Utwórz intencję oczekującą, która odwołuje się do GlanceAppWidgetReceiver:

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

4. Obsłuż intencję w GlanceAppWidgetReceiver:

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