Fehlerbehebung bei Overlays von Laufzeitressourcen

In diesem Artikel erfahren Sie, wie Sie Fehler beheben, wenn ein Laufzeit-Ressourcen-Overlay (RRO) in einer Android Automotive-Implementierung nicht wie vorgesehen funktioniert.

Weitere Informationen zu RROs unter Android finden Sie unter Wert der Ressourcen einer App zur Laufzeit ändern. Behalten Sie die logcat-Ausgabe im Auge. Sie kann Ihnen gute Informationen dazu liefern, was während des gesamten 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 in etwa 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 aufgeführt ist. Die folgenden Statusanzeigen geben den Status des RRO an:

    Anzeige RRO-Status
    [ ] Installiert und kann aktiviert werden.
    [X] Installiert und aktiviert
    --- Die Datei wurde installiert, enthält aber Fehler.

    Wenn Ihre 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 die RRO installiert ist

So prüfen Sie, ob eine RRO auf einem Gerät installiert ist, oder beheben Probleme, wenn die RRO nicht aktiviert wurde:

  1. Führen Sie den folgenden Befehl aus:

    adb shell cmd overlay dump [your RRO package name]

    Die Ausgabe sieht in etwa so aus:

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

  3. Wenn Sie die RRO für einen Nutzer aktivieren oder deaktivieren möchten, fahren Sie mit Schritt 2 fort.

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

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

    • STATE_MISSING_TARGET. Ihr Ziel ist nicht installiert.

    • STATE_NO_IDMAP. Die Dateien AndroidManifest.xml, overlays.xml oder overlayable.xml sind nicht richtig eingerichtet. Führen Sie die Protokolle mit adb logcat aus und suchen Sie nach dem Schlüsselwort idmap, um den Fehler zu identifizieren. Siehe Schritte 4 und 5.

    • STATE_UNKNOWN. Es gibt ein Problem mit OverlayManagerService.

Schritt 4: AndroidManifest.xml prüfen

So bestätigen Sie AndroidManifest.xml:

  1. Prüfen Sie targetName und targetPackage.

    android:targetName muss mit dem Wert der Gruppe übereinstimmen, die in der Ziel-App definiert ist. Dies ist nur erforderlich, wenn das Targeting auf ein Overlay erfolgt.

    android:targetPackage ist immer erforderlich und sollte den Paketnamen der Ziel-App enthalten.

  2. Prüfen Sie, ob Ihre RRO statisch ist. Statische RROs sind beim Start standardmäßig aktiviert. Dynamische RROs sind beim Start standardmäßig nicht aktiviert. Weitere Möglichkeiten zum Aktivieren dynamischer RROs finden Sie unter Wert der Ressourcen einer App zur Laufzeit ändern.

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

    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: overlays.xml prüfen

  1. Setzen Sie ein Häkchen bei overlays.xml, um zu bestätigen, dass alle Ressourcen, die Sie überlagern möchten, in dieser Datei definiert sind. Betrachten Sie beispielsweise die folgendeoverlays.xml:

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

  2. Sie müssen Folgendes gewährleisten:

    • In der Ziel-App ist eine string-Ressource mit dem Namen app_name vorhanden.
    • In Ihrer RRO ist bereits eine string-Ressource mit dem Namen overlaid_app_name vorhanden.

  3. Wenn dein Ziel eine overlayable.xml-Datei hat, muss app_name in dieser Datei enthalten sein. Achten Sie darauf, dass Sie in Ihrer AndroidManifest.xml-Datei die richtige targetName verwenden (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: ID-Map dumpen

In dieser Phase sollten alle Probleme mit Ihrer RRO behoben sein. Als Nächstes können Sie den idmap Ihrer RRO dumpen, um herauszufinden, wie eine Ressource aufgelöst wird und warum sie zu einem anderen Wert als erwartet aufgelöst wird.

  1. So finden Sie den Pfad zur idmap auf Ihrem 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:

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

    Die Ausgabe sieht in etwa so aus: In der Ausgabe sehen Sie, welche ID aus Ihrer RRO welcher ID im Ziel zugeordnet ist, sowie den Namen der überlagerten 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

Mit dem folgenden Befehl können Sie eine bestimmte Ressource suchen und sehen, 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 Ihre Layoutdateien aus Ihren APKs dumpen, um die aufgelösten IDs zu sehen, die mit der obigen Ausgabe übereinstimmen:

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

Fehler bei der Auflösung von Zuordnungen werden durch idmap2 bis drei Fragezeichen (???) gekennzeichnet.

In diesem Beispiel hat die RRO einen hartcodierten Farbwert, der auf einer öffentlichen Ressource überlagert ist:

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

In diesem Beispiel überlagert die RRO eine öffentliche Ressource, indem sie auf eine interne (private) Farbressource in derselben freigegebenen Bibliothek verweist:

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