Memecahkan masalah overlay resource runtime

Gunakan konten ini untuk memecahkan masalah mengapa overlay resource runtime (RRO) mungkin tidak berfungsi sebagaimana mestinya dalam implementasi Android Automotive.

Dokumentasi terkait

Untuk mempelajari RRO di Android lebih lanjut, lihat Mengubah nilai resource aplikasi saat runtime. Pastikan untuk terus memantau output logcat, yang dapat memberikan informasi yang baik tentang apa yang terjadi selama proses.

Langkah 1: Cantumkan RRO

Untuk mencantumkan RRO:

1. Jalankan perintah berikut:

   adb shell cmd overlay list --user current

   Output seperti ini akan muncul:

   com.android.systemui
   [ ] com.android.theme.icon_pack.rounded.systemui
   [ ] com.android.theme.icon_pack.filled.systemui
   [ ] com.android.theme.icon_pack.circular.systemui
   
   com.android.permissioncontroller
   --- com.android.permissioncontroller.googlecarui.rro
   

2. Pastikan RRO Anda muncul dalam daftar. Indikator berikut menunjukkan status RRO:

   Indikator	Status RRO
   [ ]	Diinstal dan siap diaktifkan.
   [X]	Diinstal dan diaktifkan.
   ---	Diinstal tetapi berisi error.

   Jika RRO tidak tercantum di bagian nama paket target yang ingin Anda overlay, RRO tidak diinstal.

Langkah 2: Aktifkan dan nonaktifkan RRO

Jika RRO diinstal:

1. Gunakan perintah berikut untuk mengaktifkan (atau menonaktifkan) RRO:

   adb shell cmd overlay [enable/disable] --user current [your RRO package name]

   Catatan: Anda dapat mengganti current dengan pengguna Anda. Misalnya, 0 atau 10 atau biarkan nilainya tidak berubah.
   Catatan: RRO statis diaktifkan secara default saat booting. RRO dinamis tidak diaktifkan secara default saat {i>booting<i}. Ada beberapa pengecualian untuk perilaku default ini. Untuk mengetahui detailnya, lihat Mengubah nilai resource aplikasi saat runtime. .

Langkah 3: Konfirmasi bahwa RRO telah diinstal

Untuk mengonfirmasi bahwa RRO diinstal di perangkat atau memecahkan masalah mengapa RRO tidak diaktifkan:

1. Jalankan perintah berikut:

   adb shell cmd overlay dump [your RRO package name]

   Output seperti berikut akan muncul:

   com.android.car.rotaryplayground.googlecarui.rro:0 {
     mPackageName...........: com.android.car.rotaryplayground.googlecarui.rro
     mUserId................: 0
     mTargetPackageName.....: com.android.car.rotaryplayground
     mTargetOverlayableName.: car-ui-lib
     mBaseCodePath..........: /product/overlay/googlecarui-com-android-car-rotaryplayground/googlecarui-com-android-car-rotaryplayground.apk
     mState.................: STATE_MISSING_TARGET
     mIsEnabled.............: true
     mIsMutable.............: true
     mPriority..............: 10
     mCategory..............: BypassIdMapV1
   }
   com.android.car.rotaryplayground.googlecarui.rro:10 {
     mPackageName...........: com.android.car.rotaryplayground.googlecarui.rro
     mUserId................: 10
     mTargetPackageName.....: com.android.car.rotaryplayground
     mTargetOverlayableName.: car-ui-lib
     mBaseCodePath..........: /product/overlay/googlecarui-com-android-car-rotaryplayground/googlecarui-com-android-car-rotaryplayground.apk
     mState.................: STATE_MISSING_TARGET
     mIsEnabled.............: true
     mIsMutable.............: true
     mPriority..............: 10
     mCategory..............: BypassIdMapV1
   }
   

2. Identifikasi pengguna (atau pengguna) yang menginstal RRO. Pada contoh sebelumnya, RRO tersedia untuk pengguna 0 dan pengguna10 (lihat nilai untuk mUserId di blok kode teratas).

3. Untuk mengaktifkan (atau menonaktifkan) RRO bagi pengguna, lanjutkan ke Langkah 2.

4. Untuk memeriksa nilai mState:

   • STATE_ENABLED dan STATE_ENABLED_IMMUTABLE. RRO diaktifkan dan diterapkan ke target Anda.

   • STATE_MISSING_TARGET. Target Anda belum diinstal.

   • STATE_NO_IDMAP. Terjadi masalah dengan cara penyiapan file AndroidManifest.xml, overlays.xml, atau overlayable.xml. Gunakan adb logcat untuk menjalankan log dan menelusuri kata kunci idmap untuk mengidentifikasi error. Lihat langkah 4 & 5.

   • STATE_UNKNOWN. Terjadi masalah dengan OverlayManagerService.

Langkah 4: Periksa AndroidManifest.xml

Untuk memverifikasi AndroidManifest.xml:

1. Periksa targetName dan targetPackage.

   android:targetName harus memiliki nilai yang sama dengan grup yang dapat ditempatkan overlay yang ditentukan di aplikasi target. Hal ini hanya diperlukan saat menargetkan overlay.

   android:targetPackage selalu diperlukan dan harus berisi nama paket aplikasi target.

2. Periksa apakah RRO Anda statis (atau tidak). RRO statis diaktifkan secara default pada saat booting. RRO dinamis tidak diaktifkan secara default saat booting. Cara tambahan untuk mengaktifkan RRO dinamis disediakan di Mengubah nilai resource aplikasi saat runtime.

3. Periksa prioritas RRO statis (prioritas RRO dinamis selalu ditetapkan ke Integer.MAX_VALUE dan urutan penerapannya didasarkan pada waktu diaktifkan).

   Beberapa RRO dapat berlaku untuk target yang sama. RRO dengan prioritas yang lebih tinggi diterapkan terakhir. Dalam skala 0 hingga 10, 10 adalah nilai tertinggi dan 0 adalah nilai terendah.

Langkah 5: Periksa overlay.xml

Catatan: Pemeriksaan ini hanya berlaku untuk Android 11 dan yang lebih baru.

1. Periksa overlays.xml untuk mengonfirmasi bahwa semua resource yang ingin Anda overlay ditentukan dalam file ini. Misalnya, pertimbangkanoverlays.xml berikut:

   <overlay>
       <item target="string/app_name" value="@string/overlaid_app_name" />
   </overlay>
   

2. Anda harus memastikan bahwa:

   • Resource string dengan nama app_name ada di aplikasi target.
   • Resource string dengan nama overlaid_app_name ada di RRO Anda.

3. Jika target Anda memiliki file overlayable.xml, pastikan app_name dimuat dalam file tersebut. Pastikan Anda menggunakan targetName yang benar dalam file AndroidManifest.xml (Langkah 4).

   Catatan: Jika Anda menempatkan file tata letak, pastikan semua ID dan atribut namespace aplikasi disertakan dalam kedua overlays.xml dan overlayable.xml.

   Contoh:

   <overlay>
   <item target="layout/car_ui_base_layout_toolbar" value="@layout/car_ui_base_layout_toolbar" />
   <item target="id/car_ui_toolbar_background" value="@id/car_ui_toolbar_background" />
   <item target="attr/layout_constraintTop_toBottomOf" value="@attr/layout_constraintTop_toBottomOf" />
   </overlay>
   

Langkah 6: Buat dump idmap

Pada tahap ini, semua masalah terkait RRO Anda akan teratasi. Selanjutnya, dump idmap RRO Anda untuk mempelajari cara resource di-resolve dan mengapa di-resolve ke nilai yang berbeda dari yang Anda harapkan.

1. Untuk menemukan jalur ke idmap di perangkat Anda:

   adb shell
   su
   ls data/resource-cache

2. Untuk membuang konten file tersebut:

   adb root
   adb shell idmap2 dump --idmap-path [path to your RRO idmap file]

   Contoh:

   adb shell idmap2 dump --idmap-path data/resource-cache/system@app@[e-mail]@idmap

   Output-nya akan terlihat mirip dengan berikut ini. Output menampilkan ID dari RRO Anda yang dipetakan ke ID mana dalam target Anda, serta nama resource overlay.

   target apk path : /system/priv-app/CarMediaApp/CarMediaApp.apk
   overlay apk path : /product/overlay/googlecarui-com-android-car-media/googlecarui-com-android-car-media.apk
   0x7f040008 -> 0x7f010000 bool/car_ui_toolbar_logo_fills_nav_icon_space
   0x7f040009 -> 0x7f010001 bool/car_ui_toolbar_nav_icon_reserve_space
   0x7f04000b -> 0x7f010002 bool/car_ui_toolbar_tab_flexible_layout
   0x7f04000c -> 0x7f010003 bool/car_ui_toolbar_tabs_on_second_row
   0x7f09006c -> 0x7f020000 id/car_ui_base_layout_content_container
   0x7f090073 -> 0x7f020001 id/car_ui_recycler_view
   0x7f090074 -> 0x7f020002 id/car_ui_scroll_bar
   0x7f090075 -> 0x7f020003 id/car_ui_scrollbar_page_down
   0x7f090076 -> 0x7f020004 id/car_ui_scrollbar_page_up
   0x7f090077 -> 0x7f020005 id/car_ui_scrollbar_thumb
   0x7f090078 -> 0x7f020006 id/car_ui_scrollbar_track
   0x7f09007a -> 0x7f020007 id/car_ui_toolbar_background
   0x7f09007e -> 0x7f020008 id/car_ui_toolbar_logo
   0x7f090084 -> 0x7f020009 id/car_ui_toolbar_menu_items_container
   0x7f090085 -> 0x7f02000a id/car_ui_toolbar_nav_icon
   0x7f090086 -> 0x7f02000b id/car_ui_toolbar_nav_icon_container
   0x7f090087 -> 0x7f02000c id/car_ui_toolbar_progress_bar
   0x7f090089 -> 0x7f02000d id/car_ui_toolbar_row_separator_guideline
   0x7f09008d -> 0x7f02000e id/car_ui_toolbar_search_view_container
   0x7f09008f -> 0x7f02000f id/car_ui_toolbar_subtitle
   0x7f090092 -> 0x7f020010 id/car_ui_toolbar_tabs
   0x7f090093 -> 0x7f020011 id/car_ui_toolbar_title
   0x7f090094 -> 0x7f020012 id/car_ui_toolbar_title_container
   0x7f090095 -> 0x7f020013 id/car_ui_toolbar_title_logo
   0x7f090096 -> 0x7f020014 id/car_ui_toolbar_title_logo_container
   0x7f0c0024 -> 0x7f030000 layout/car_ui_base_layout_toolbar
   0x7f0c0035 -> 0x7f030001 layout/car_ui_recycler_view
   0x7f0c0038 -> 0x7f030002 layout/car_ui_toolbar
   0x7f0c003f -> 0x7f030003 layout/car_ui_toolbar_two_row
   

Gunakan perintah berikut untuk mencari resource tertentu guna melihat cara pemetaan resource tersebut:

adb shell cmd overlay lookup --verbose --user 10 com.android.car.ui.paintbooth com.android.car.ui.paintbooth:color/widget_background

Output-nya adalah nilai akhir resource:

#ff7986cb

Anda juga dapat membuang file tata letak dari apk untuk melihat ID yang di-resolve agar cocok dengan output di atas:

aapt2 dump xmltree $OUT/system/priv-app/sharedlibraryclient/sharedlibraryclient.apk --file res/layout/activity_main.xml

Output seperti berikut akan ditampilkan:

N: android=http://schemas.android.com/apk/res/android (line=2)
  N: app=http://schemas.android.com/apk/res-auto (line=2)
    N: lib=http://schemas.android.com/apk/com.android.car.ui.sharedlibrary.test (line=2)
      E: androidx.constraintlayout.widget.ConstraintLayout (line=2)
        A: http://schemas.android.com/apk/res/android:layout_width(0x010100f4)=-1
        A: http://schemas.android.com/apk/res/android:layout_height(0x010100f5)=-1
          E: TextView (line=19)
            A: http://schemas.android.com/apk/res/android:layout_width(0x010100f4)=-2
            A: http://schemas.android.com/apk/res/android:layout_height(0x010100f5)=-2
            A: http://schemas.android.com/apk/res/android:text(0x0101014f)=@0x020f0000
            A: http://schemas.android.com/apk/res-auto:layout_constraintBottom_toBottomOf(0x7f0200fb)=0
            A: http://schemas.android.com/apk/res-auto:layout_constraintLeft_toLeftOf(0x7f02010e)=0
            A: http://schemas.android.com/apk/res-auto:layout_constraintRight_toRightOf(0x7f020112)=0
            A: http://schemas.android.com/apk/res-auto:layout_constraintTop_toTopOf(0x7f020118)=0
          E: com.android.car.ui.sharedlibrary.test.MyRecyclerView (line=28)
            A: http://schemas.android.com/apk/res/android:layout_width(0x010100f4)=-2
            A: http://schemas.android.com/apk/res/android:layout_height(0x010100f5)=-2
            A: http://schemas.android.com/apk/com.android.car.ui.sharedlibrary.test:implClass="HelloWorld!" (Raw: "HelloWorld!")
          E: com.android.car.ui.sharedlibraryclient.CustomView (line=34)
            A: http://schemas.android.com/apk/res/android:layout_width(0x010100f4)=-2
            A: http://schemas.android.com/apk/res/android:layout_height(0x010100f5)=-2
            A: http://schemas.android.com/apk/res-auto:implClass2(0x7f0200e8)="HelloWorld!!" (Raw: "HelloWorld!!")