จัดการข้อผิดพลาดด้วยข้อมูลโดยย่อ

ฟีเจอร์ API สำหรับการปรับปรุงการจัดการข้อผิดพลาดในข้อมูลโดยย่อจะรวมอยู่ตั้งแต่ Android 15 เป็นต้นไป หน้านี้มีแนวทางปฏิบัติแนะนำบางส่วนเกี่ยวกับ API เหล่านี้

ใช้บล็อก try-catch กับคอมโพเนนต์ที่คอมโพสิทไม่ได้

Compose ไม่อนุญาตให้ใช้บล็อก try-catch กับคอมโพสิเบิล แต่ให้คุณรวมตรรกะอื่นๆ ของแอปไว้ในบล็อกเหล่านี้ได้ ซึ่งจะช่วยให้คุณใช้การเขียนสำหรับมุมมองข้อผิดพลาดได้ ดังที่แสดงในตัวอย่างต่อไปนี้

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 ข้อมูลโดยย่อจะแสดงเลย์เอาต์ข้อผิดพลาดเริ่มต้นดังนี้

ข้อความแสดงข้อผิดพลาดที่แสดงประเภทของข้อผิดพลาดและคำแนะนำเกี่ยวกับตำแหน่งที่จะค้นหา
รูปที่ 1.เลย์เอาต์ข้อผิดพลาดเริ่มต้นของข้อมูลโดยย่อ 1.0
กล่องที่มีข้อความ "แสดงเนื้อหาไม่ได้"
รูปที่ 2.เลย์เอาต์ข้อผิดพลาดเริ่มต้นของข้อมูลโดยย่อ 1.1.0

ข้อมูลโดยย่อช่วยให้นักพัฒนาแอประบุเลย์เอาต์ XML เป็นค่าสำรองได้หากการคอมโพสิชันไม่สำเร็จ ซึ่งหมายความว่าเกิดข้อผิดพลาดในโค้ดการเขียน UI ข้อผิดพลาดนี้จะปรากฏขึ้นด้วยหากมีข้อผิดพลาดที่ไม่ได้จับในโค้ดของแอป

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

เลย์เอาต์นี้เป็นเลย์เอาต์แบบคงที่ที่ผู้ใช้โต้ตอบไม่ได้ แต่เหมาะสำหรับกรณีฉุกเฉิน

มีส่วนหัวและช่องข้อความเพื่อแสดงข้อความแสดงข้อผิดพลาด
รูปที่ 3.ตัวอย่างเลย์เอาต์ข้อผิดพลาดที่กําหนดเอง

เพิ่มการดำเนินการลงใน UI ข้อผิดพลาดเริ่มต้น

ตั้งแต่ Glance 1.1.0 เป็นต้นไป Glance ให้คุณลบล้างโค้ดการจัดการข้อผิดพลาดเริ่มต้นได้ วิธีนี้ช่วยให้คุณเพิ่มการเรียกกลับการดำเนินการได้ในกรณีที่มีข้อยกเว้นที่ตรวจไม่พบหรือข้อผิดพลาดในการคอมโพสิชัน

หากต้องการใช้ฟีเจอร์นี้ ให้ลบล้างฟังก์ชัน onCompositionError() ดังนี้

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

ในฟังก์ชันนี้ Glance จะเปลี่ยนไปใช้ RemoteViews API เพื่อจัดการข้อผิดพลาด ซึ่งช่วยให้คุณระบุเลย์เอาต์และตัวแฮนเดิลการดำเนินการได้โดยใช้ XML

ตัวอย่างต่อไปนี้แสดงวิธีสร้าง UI ข้อผิดพลาดทีละขั้นตอน ซึ่งจะมีปุ่มสำหรับส่งความคิดเห็น

  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>

  1. ลบล้างฟังก์ชัน 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. สร้าง Intent ที่รอดำเนินการซึ่งอ้างอิง 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. จัดการ Intent ใน GlanceAppWidgetReceiver
override fun onReceive(context: Context, intent: Intent) {
   super.onReceive(context, intent)
   Log.e("ErrorOnClick", "Button was clicked.");
}