Solucionar erros com o Resumo

Os recursos da API para melhorar o tratamento de erros no Glance estão incluídos a partir do Android 15. Esta página oferece práticas recomendadas sobre essas APIs.

Usar um bloco try-catch em torno de componentes não combináveis

O Compose não permite blocos try-catch em torno de combináveis, mas permite encapsular a outra lógica do app nesses blocos. Isso permite usar o Compose para a visualização de erros, conforme mostrado no exemplo a seguir:

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

Layout de erro padrão

Se houver uma exceção não detectada ou um erro do Compose, o Glance vai mostrar um layout de erro padrão:

Figura 1. Layout de erro padrão do Glance 1.0

Figura 2. Layout de erro padrão do Glance 1.1.0

O Glance permite que os desenvolvedores forneçam um layout XML como um substituto se a composição falhar. Isso significa que ocorreu um erro no código do Compose. Essa interface de erro também aparece se houver um erro não detectado no código do app.

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

Esse layout é estático e o usuário não pode interagir com ele, mas é bom em casos de emergência.

Figura 3. Exemplo de layout de erro personalizado

Adicionar ações à interface de erro padrão

A partir do Glance 1.1.0, é possível substituir o código de tratamento de erros padrão. Dessa forma, você pode adicionar callbacks de ação em caso de exceção ou erro não detectado na composição.

Para usar esse recurso, substitua a onCompositionError() função:

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

Nessa função, o Glance volta para a API RemoteViews para tratamento de erros. Isso permite especificar layouts e processadores de ações usando XML.

Os exemplos a seguir mostram, passo a passo, como criar uma interface de erro que inclui um botão para enviar feedback:

1. Grave o arquivo 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. Substitua a função 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. Crie uma intent pendente que faça referência ao 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. Processe a intent no GlanceAppWidgetReceiver:

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