Обработка ошибок с помощью Glance

Функции API для улучшения обработки ошибок в Glance включены в Android 15. В этой статье приведены рекомендации по работе с этими API.

Используйте блок try-catch для компонентов, не являющихся composable-функциями

Compose не позволяет использовать блоки try-catch вокруг composable-функций, но позволяет обернуть в них другую логику приложения. Это позволяет использовать Compose для представления ошибок, как показано в следующем примере:

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

Макет ошибки по умолчанию

Если есть неперехваченное исключение или ошибка Compose, Glance отображает макет ошибки по умолчанию:

Рисунок 1. Макет ошибки по умолчанию в Glance 1.0

Рисунок 2. Макет ошибки по умолчанию в Glance 1.1.0

Glance позволяет разработчикам предоставлять макет XML в качестве резервного варианта, если композиция не удалась. Это означает, что в коде Compose произошла ошибка. Это сообщение также появляется, если в коде приложения есть необработанная ошибка.

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

Это статический макет, с которым пользователь не может взаимодействовать, но он подходит для экстренных случаев.

Рисунок 3. Пример макета собственной ошибки

Добавление действий в интерфейс ошибок по умолчанию

Начиная с версии 1.1.0, Glance позволяет переопределять код обработки ошибок по умолчанию. Это позволяет добавлять обратные вызовы действий в случае неперехваченного исключения или ошибки в композиции.

Чтобы использовать эту функцию, переопределите функцию onCompositionError():

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

В этой функции Glance использует API RemoteViews для обработки ошибок. Это позволяет указывать макеты и обработчики действий с помощью XML.

В примерах ниже пошагово показано, как создать интерфейс ошибки с кнопкой для отправки отзыва.

1. Запишите файл 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. Переопределите функцию 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. Создайте отложенный интент, который ссылается на ваш 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. Обработайте намерение в файле GlanceAppWidgetReceiver:

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