Fehlerbehebung bei Overlays von Laufzeitressourcen

Anhand dieser Informationen kannst du herausfinden, warum ein Runtime Resource Overlay (RRO) in einer Android Automotive-Implementierung möglicherweise nicht wie vorgesehen funktioniert.

Weitere Informationen zu RROs in Android finden Sie unter Wert der Ressourcen einer App während der Laufzeit ändern. Behalten Sie die logcat-Ausgabe konstant im Auge, da sie gute Informationen darüber liefern kann, was während des Prozesses passiert.

Schritt 1: RROs auflisten

So listen Sie die RROs auf:

  1. Führen Sie den folgenden Befehl aus:

    adb shell cmd overlay list --user current
    

    Die Ausgabe sieht so aus:

    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. Prüfen Sie, ob Ihre RRO in der Liste angezeigt wird. Die folgenden Indikatoren geben den RRO-Status an:

    Anzeige RRO-Status
    [ ] Installiert und kann aktiviert werden.
    [X] Installiert und aktiviert.
    --- Installiert, enthält jedoch Fehler.

    Wenn die RRO nicht unter dem Paketnamen des Ziels aufgeführt ist, das Sie überlagern möchten, ist sie nicht installiert.

Schritt 2: RRO aktivieren und deaktivieren

Wenn eine RRO installiert ist:

  1. Verwenden Sie den folgenden Befehl, um die RRO zu aktivieren (oder zu deaktivieren):

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

Schritt 3: Prüfen, ob RRO installiert ist

So prüfen Sie, ob eine RRO auf einem Gerät installiert ist oder warum sie nicht aktiviert wurde:

  1. Führen Sie den folgenden Befehl aus:

    adb shell cmd overlay dump [your RRO package name]
    

    Es wird eine Ausgabe wie die unten angezeigt:

    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. Identifizieren Sie die Nutzer, die die RRO installiert haben. Im obigen Beispiel ist die RRO für Nutzer 0 und Nutzer10 verfügbar (siehe die Werte für mUserId im oberen Codeblock).

  3. Fahren Sie mit Schritt 2 fort, um die RRO für den gewünschten Nutzer zu aktivieren oder zu deaktivieren.

  4. So prüfen Sie den Wert von mState:

    • STATE_ENABLED und STATE_ENABLED_IMMUTABLE. Die RRO wird aktiviert und auf das Ziel angewendet.

    • STATE_MISSING_TARGET. Das Ziel ist nicht installiert.

    • STATE_NO_IDMAP. Bei der Einrichtung der Dateien AndroidManifest.xml, overlays.xml oder overlayable.xml ist ein Fehler aufgetreten. Verwenden Sie adb logcat, um die Logs auszuführen und nach dem Schlüsselwort idmap zu suchen, um den Fehler zu identifizieren. Siehe Schritte 4 und 5

    • STATE_UNKNOWN. Mit OverlayManagerService stimmt etwas nicht.

Schritt 4: AndroidManifest.xml überprüfen

So bestätigen Sie AndroidManifest.xml:

  1. Prüfen Sie targetName und targetPackage.

    android:targetName sollte denselben Wert der überblendbaren Gruppe haben, die in der Zielanwendung definiert ist. Das ist nur beim Targeting auf ein Overlay erforderlich.

    android:targetPackage ist immer erforderlich und sollte den Paketnamen der Zielanwendung enthalten.

  2. Prüfen Sie, ob Ihre RRO statisch ist (oder nicht). Statische RROs sind beim Booten standardmäßig aktiviert. Dynamische RROs sind beim Start nicht standardmäßig aktiviert. Weitere Möglichkeiten zum Aktivieren dynamischer RROs finden Sie unter Wert der Anwendungsressourcen während der Laufzeit ändern.

  3. Prüfen Sie die Priorität Ihrer statischen RRO-Funktion. Die Priorität der dynamischen RRO ist immer auf Integer.MAX_VALUE festgelegt und die Reihenfolge, in der sie angewendet werden, hängt davon ab, wann sie aktiviert wurden.

    Für dasselbe Ziel können mehrere RROs gelten. RROs mit einer höheren Priorität werden zuletzt angewendet. Auf einer Skala von 0 bis 10 ist 10 der höchste und 0 der niedrigste Wert.

Schritt 5: Überlagerungen.xml überprüfen

Diese Prüfung gilt nur für Android 11 und höher.

  1. Klicken Sie auf overlays.xml, um zu prüfen, ob alle Ressourcen, die Sie einblenden möchten, in dieser Datei definiert sind. Betrachten Sie zum Beispiel Folgendesoverlays.xml:

    <overlay>
        <item target="string/app_name" value="@string/overlaid_app_name" />
    </overlay>
    
  2. Folgende Voraussetzungen müssen erfüllt sein:

    • Die Ressource string mit dem Namen app_name ist in der Ziel-App vorhanden.
    • Die Ressource string mit dem Namen overlaid_app_name ist in Ihrer RRO vorhanden.
  3. Wenn Ihr Ziel eine overlayable.xml-Datei hat, muss app_name in dieser Datei enthalten sein. Achte darauf, dass du die richtige targetName in deiner AndroidManifest.xml-Datei verwendest (Schritt 4).

    Beispiel:

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

Schritt 6: Idmap speichern

In dieser Phase sollten alle Probleme mit der RRO behoben sein. Speichern Sie als Nächstes den idmap Ihrer RRO, um zu erfahren, wie eine Ressource aufgelöst wird und warum sie in einen anderen Wert als erwartet aufgelöst wird.

  1. So findest du den Pfad zum idmap auf deinem Gerät:

    adb shell
    su
    ls data/resource-cache
    
  2. So sichern Sie den Inhalt dieser Datei:

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

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

    Die Ausgabe sieht in etwa so aus. Die Ausgabe zeigt an, welche ID aus Ihrer RRO einer ID im Ziel zugeordnet ist, sowie den Namen der eingeblendeten Ressource.

    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
    

Verwenden Sie den folgenden Befehl, um eine bestimmte Ressource zu suchen und herauszufinden, wie sie zugeordnet ist:

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

Die Ausgabe ist der endgültige Wert der Ressource:

#ff7986cb

Sie können auch die Layoutdateien aus Ihren APK-Dateien speichern, um die aufgelösten IDs anzuzeigen, die der obigen Ausgabe entsprechen:

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

Es wird eine Ausgabe wie die folgende zurückgegeben:

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