Résoudre les problèmes liés aux superpositions de ressources d'exécution

Utilisez ce contenu pour résoudre les problèmes de fonctionnement d'une superposition de ressources d'exécution (RRO) dans une implémentation Android Automotive.

Pour en savoir plus sur les RRO dans Android, consultez la section Modifier la valeur des ressources d'une application au moment de l'exécution. Veillez à surveiller en permanence la sortie logcat, qui peut fournir de bonnes informations sur ce qui se passe tout au long du processus.

Étape 1: Lister les RRO

Pour lister les RRO:

  1. Exécutez la commande suivante :

    adb shell cmd overlay list --user current

    Le résultat se présente comme suit:

    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. Vérifiez que votre RRO apparaît dans la liste. Les indicateurs suivants indiquent l'état de l'opération de récupération:

    Indicateur État de l'appel en appel
    [ ] Installé et prêt à être activé
    [X] Installé et activé.
    --- Installé, mais contient des erreurs.

    Si votre RRO ne figure pas sous le nom du package de la cible que vous souhaitez superposer, il n'est pas installé.

Étape 2: Activez et désactivez un RRO

Si une RRO est installée:

  1. Utilisez la commande suivante pour activer (ou désactiver) le RRO:

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

Étape 3: Vérifiez que le RRO est installé

Pour vérifier qu'une RRO est installée sur un appareil ou pour résoudre les problèmes de non-activation d'une RRO:

  1. Exécutez la commande suivante :

    adb shell cmd overlay dump [your RRO package name]

    Un résultat semblable à ce qui suit s'affiche:

    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. Identifiez l'utilisateur (ou les utilisateurs) qui a installé le RRO. Dans l'exemple précédent, la RRO est disponible pour les utilisateurs 0 et 10 (voir les valeurs de mUserId dans le bloc de code supérieur).

  3. Pour activer (ou désactiver) la RRO pour un utilisateur, passez à l'étape 2.

  4. Pour vérifier la valeur de mState:

    • STATE_ENABLED et STATE_ENABLED_IMMUTABLE. Le RRO est activé et appliqué à votre cible.

    • STATE_MISSING_TARGET. Votre cible n'est pas installée.

    • STATE_NO_IDMAP. Il y a un problème avec la configuration des fichiers AndroidManifest.xml, overlays.xml ou overlayable.xml. Utilisez adb logcat pour exécuter les journaux et recherchez le mot clé idmap pour identifier l'erreur. Voir les étapes 4 et 5.

    • STATE_UNKNOWN. Un problème est survenu avec OverlayManagerService.

Étape 4: Vérifiez AndroidManifest.xml

Pour valider AndroidManifest.xml:

  1. Vérifiez targetName et targetPackage.

    android:targetName doit avoir la même valeur que le groupe superposable défini dans l'application cible. Cette condition est requise uniquement lorsque vous ciblez une superposition.

    android:targetPackage est toujours obligatoire et doit contenir le nom du package de l'application cible.

  2. Vérifiez que votre RRO est statique (ou non). Les RRO statiques sont activés par défaut au démarrage. Les RRO dynamiques ne sont pas activés par défaut au démarrage. D'autres façons d'activer les RRO dynamiques sont fournies dans la section Modifier la valeur des ressources d'une application au moment de l'exécution.

  3. Vérifiez la priorité de vos RRO statiques (la priorité des RRO dynamiques est toujours définie sur Integer.MAX_VALUE, et l'ordre dans lequel elles sont appliquées dépend de leur activation).

    Plusieurs RRO peuvent s'appliquer à la même cible. Les RRO de priorité supérieure sont appliquées en dernier. Sur une échelle de 0 à 10, 10 correspond à la note la plus élevée et 0 à la note la plus faible.

Étape 5: Vérifier overlays.xml

  1. Vérifiez overlays.xml pour vous assurer que toutes les ressources que vous prévoyez de superposer sont définies dans ce fichier. Prenons l'exemple suivantoverlays.xml:

    <overlay>
        <item target="string/app_name" value="@string/overlaid_app_name" />
    </overlay>
    
  2. Vous devez vous assurer que:

    • La ressource string portant le nom app_name existe dans l'application cible.
    • La ressource string portant le nom overlaid_app_name existe dans votre RRO.
  3. Si votre cible dispose d'un fichier overlayable.xml, assurez-vous que app_name est inclus dans ce fichier. Assurez-vous d'utiliser le bon targetName dans votre fichier AndroidManifest.xml (étape 4).

    Exemple :

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

Étape 6: Vider la table de mappage d'ID

À ce stade, tous les problèmes liés à votre RRO devraient être résolus. Ensuite, videz le idmap de votre RRO pour découvrir comment une ressource est résolue et pourquoi elle est résolue à une valeur différente de celle attendue.

  1. Pour trouver le chemin d'accès à idmap sur votre appareil:

    adb shell
    su
    ls data/resource-cache
  2. Pour extraire le contenu de ce fichier:

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

    Exemple :

    adb shell idmap2 dump --idmap-path data/resource-cache/system@app@CarUiPortraitLauncherReferenceRRO@CarUiPortraitLauncherReferenceRRO.apk@idmap

    La sortie se présente comme suit : La sortie affiche l'ID de votre RRO mappé sur l'ID de votre cible, ainsi que le nom de la ressource superposée.

    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
    

Utilisez la commande suivante pour rechercher une ressource spécifique et voir comment elle est mappée:

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

La sortie correspond à la valeur finale de la ressource:

#ff7986cb

Vous pouvez également extraire vos fichiers de mise en page à partir de vos APK pour afficher les ID résolus afin qu'ils correspondent à la sortie ci-dessus:

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

Le résultat est semblable à ce qui suit:

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!!")

Les échecs de résolution des mappages sont indiqués par idmap2 via trois points d'interrogation (???).

Dans cet exemple, la valeur de couleur codée en dur est superposée à une ressource publique:

$ idmap2 dump --idmap-path [file]
0x00010402 -> color 0xff00ff00 (???)

Dans cet exemple, le RRO superpose une ressource publique en la pointant vers une ressource de couleur interne (privée) dans la même bibliothèque partagée:

$ idmap2 dump --idmap-path [file]
0x00010402 -> 0x7f010000 (??? -> color/item_background_new)