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

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

Используйте блок try-catch для компонентов, которые нельзя комбинировать.

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

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

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

В случае возникновения необработанного исключения или ошибки Compose, Glance отображает стандартный шаблон сообщения об ошибке:

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

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

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

Добавить действия в стандартный пользовательский интерфейс обработки ошибок

Начиная с версии Glance 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)
   }
   

3. Создайте ожидающий интент, который ссылается на ваш 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)
   }
   
   

4. Обрабатывайте Intent в вашем GlanceAppWidgetReceiver :

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