Attiva il multidex per le app con più di 64.000 metodi

Se la tua app ha un minSdk di API 20 o precedenti e l'app e le librerie a cui fa riferimento superano i 65.536 metodi, riscontri il seguente errore di compilazione che indica che la tua app ha raggiunto il limite dell'architettura di compilazione di Android:

trouble writing output:
Too many field references: 131000; max is 65536.
You may try using --multi-dex option.

Le versioni precedenti del sistema di build segnalano un errore diverso, che indica lo stesso problema:

Conversion to Dalvik format failed:
Unable to execute dex: method ID not in [0, 0xffff]: 65536

Queste condizioni di errore mostrano un numero comune: 65536. Questo numero rappresenta il numero totale di riferimenti che possono essere richiamati dal codice all'interno di un singolo file bytecode Dalvik eseguibile (DEX). In questa pagina viene spiegato come superare questa limitazione abilitando una configurazione dell'app nota come multidex, che consente all'app di generare e leggere più file DEX.

Informazioni sul limite di 64 KB per i riferimenti

I file APK (app per Android) contengono file bytecode eseguibili sotto forma di file Dalvik Executable (DEX), che contengono il codice compilato utilizzato per eseguire l'app. La specifica Dalvik Executable limita a 65.536 il numero totale di metodi a cui è possibile fare riferimento all'interno di un singolo file DEX, inclusi i metodi del framework Android, i metodi della libreria e i metodi nel tuo codice.

Supporto di Multidex precedente ad Android 5.0

Le versioni della piattaforma precedenti ad Android 5.0 (livello API 21) utilizzano il runtime Dalvik per l'esecuzione del codice dell'app. Per impostazione predefinita, Dalvik limita le app a un singolo file bytecode classes.dex per APK. Per ovviare a questo limite, aggiungi la libreria multidex al file build.gradle o build.gradle.kts a livello di modulo:

dependencies {
    def multidex_version = "2.0.1"
    implementation "androidx.multidex:multidex:$multidex_version"
}

dependencies {
    val multidex_version = "2.0.1"
    implementation("androidx.multidex:multidex:$multidex_version")
}

Questa libreria diventa parte del file DEX principale della tua app e poi gestisce l'accesso ai file DEX aggiuntivi e al codice che contengono. Per visualizzare le versioni correnti di questa libreria, vedi versioni multidex.

Supporto di Multidex per Android 5.0 e versioni successive

Android 5.0 (livello API 21) e versioni successive utilizzano un runtime chiamato ART che supporta in modo nativo il caricamento di più file DEX dai file APK. ART esegue la precompilazione al momento dell'installazione dell'app, cercando i file classesN.dex e compilandoli in un unico file OAT per la loro esecuzione da parte del dispositivo Android. Pertanto, se il tuo minSdkVersion è 21 o superiore, il multidex è abilitato per impostazione predefinita e non è necessaria la libreria multidex.

Per maggiori informazioni sul runtime di Android 5.0, leggi Android Runtime (ART) e Dalvik.

Nota: quando esegui l'app utilizzando Android Studio, la compilazione viene ottimizzata per i dispositivi di destinazione su cui esegui il deployment. Ciò include l'attivazione di multidex quando i dispositivi di destinazione eseguono Android 5.0 e versioni successive. Poiché questa ottimizzazione viene applicata solo durante il deployment dell'app utilizzando Android Studio, potrebbe essere comunque necessario configurare la build di release per il multidex per evitare il limite di 64 KB.

Evita il limite di 64.000

Prima di configurare l'app in modo da consentire l'uso di almeno 64.000 riferimenti ai metodi, segui le istruzioni per ridurre il numero totale di riferimenti richiamati dal codice dell'app, inclusi i metodi definiti dal codice dell'app o le librerie incluse.

Le seguenti strategie possono aiutarti a evitare di raggiungere il limite di riferimenti DEX:

Controlla le dipendenze dirette e trasitive della tua app

Valuta se il valore di una dipendenza da una libreria di grandi dimensioni inclusa nella tua app supera la quantità di codice aggiunto all'app. Un pattern comune, ma problematico, è includere una libreria molto grande perché alcuni metodi di utilità sono utili. Spesso, ridurre le dipendenze del codice dell'app può aiutarti a evitare il limite di riferimenti DEX.

Rimuovere il codice inutilizzato con R8

Abilita la riduzione del codice per eseguire R8 per le build di release. Attiva la riduzione per assicurarti di non caricare codice inutilizzato con i tuoi APK. Se la riduzione del codice è configurata correttamente, può anche rimuovere le risorse e il codice inutilizzati dalle dipendenze.

L'utilizzo di queste tecniche può aiutarti a ridurre le dimensioni complessive dell'APK e evitare la necessità di multidex nella tua app.

Configurare l'app per il multidex

Se minSdkVersion è impostato su 20 o meno, devi utilizzare la libreria multidex e apportare le seguenti modifiche al progetto dell'app:

1. Modifica il file build.gradle a livello di modulo per abilitare multidex e aggiungi la libreria multidex come dipendenza, come mostrato qui:

   Groovy

   android {
       defaultConfig {
           ...
           minSdkVersion 15 
           targetSdkVersion 33
           multiDexEnabled true
       }
       ...
   }
   
   dependencies {
       implementation "androidx.multidex:multidex:2.0.1"
   }

   Kotlin

   android {
       defaultConfig {
           ...
           minSdk = 15 
           targetSdk = 33
           multiDexEnabled = true
       }
       ...
   }
   
   dependencies {
       implementation("androidx.multidex:multidex:2.0.1")
   }

2. A seconda che sostituisci o meno la classe Application, esegui una delle seguenti operazioni:

   • Se non sostituisci la classe Application, modifica il file manifest per impostare android:name nel tag <application> come segue:

     <?xml version="1.0" encoding="utf-8"?>
     <manifest xmlns:android="http://schemas.android.com/apk/res/android"
         package="com.example.myapp">
         <application
                 android:name="androidx.multidex.MultiDexApplication" >
             ...
         </application>
     </manifest>

   • Se esegui l'override della classe Application, modificala per estendere MultiDexApplication, come segue:

     Kotlin

     class MyApplication : MultiDexApplication() {...}

     Java

     public class MyApplication extends MultiDexApplication { ... }

   • Se esegui l'override della classe Application ma non è possibile modificare la classe di base, sostituisci il metodo attachBaseContext() e chiama MultiDex.install(this) per abilitare multidex:

     Kotlin

     class MyApplication : SomeOtherApplication() {
     
         override fun attachBaseContext(base: Context) {
             super.attachBaseContext(base)
             MultiDex.install(this)
         }
     }

     Java

     public class MyApplication extends SomeOtherApplication {
       @Override
       protected void attachBaseContext(Context base) {
          super.attachBaseContext(base);
          MultiDex.install(this);
       }
     }

     Attenzione: non eseguire MultiDex.install() o qualsiasi altro codice tramite la riflessione o JNI prima del completamento di MultiDex.install(). Il tracciamento multidex non seguirà queste chiamate, causando ClassNotFoundException o verifica errori a causa di una partizione di classe errata tra i file DEX.

Ora, quando crei la tua app, gli strumenti di compilazione Android generano un file DEX primario (classes.dex) e file DEX di supporto (classes2.dex, classes3.dex e così via) in base alle esigenze. Il sistema di compilazione pacchettizza quindi tutti i file DEX nell'APK.

In fase di runtime, invece di cercare solo nel file classes.dex principale, le API multidex utilizzano uno speciale caricatore di classi per cercare in tutti i file DEX disponibili per i tuoi metodi.

Limitazioni della libreria multidex

La libreria multidex presenta alcune limitazioni note. Quando incorpori la libreria nella configurazione di compilazione dell'app, tieni presente quanto segue:

• L'installazione di file DEX durante l'avvio sulla partizione dati di un dispositivo è complessa e può causare errori ANR (Application Not Responding) se i file DEX secondari sono di grandi dimensioni. Per evitare questo problema, attiva la riduzione del codice per ridurre al minimo le dimensioni dei file DEX e rimuovere le parti di codice inutilizzate.
• Se l'app viene eseguita su versioni precedenti ad Android 5.0 (livello API 21), l'utilizzo di multidex non è sufficiente per aggirare il limite di linearalloc (issue 37008143). Questo limite è stato aumentato in Android 4.0 (livello API 14), ma il problema non è stato risolto completamente.

  Nelle versioni precedenti ad Android 4.0, potresti raggiungere il limite di linearalloc prima di raggiungere il limite dell'indice DEX. Pertanto, se scegli come target livelli API inferiori a 14, esegui test approfonditi su queste versioni della piattaforma, perché la tua app potrebbe avere problemi all'avvio o quando vengono caricati determinati gruppi di classi.

  La riduzione del codice può ridurre o probabilmente eliminare questi problemi.

Dichiara le classi richieste nel file DEX principale

Quando vengono creati i file DEX per un'app multidex, gli strumenti di compilazione eseguono un processo decisionale complesso per determinare quali classi sono necessarie nel file DEX principale in modo che l'app possa essere avviata correttamente. Se una classe richiesta durante l'avvio non viene fornita nel file DEX principale, l'app ha un arresto anomalo con l'errore java.lang.NoClassDefFoundError.

Gli strumenti di compilazione riconoscono i percorsi del codice a cui si accede direttamente dal codice dell'app. Tuttavia, questo problema può verificarsi quando i percorsi del codice sono meno visibili, ad esempio quando una libreria che utilizzi ha dipendenze complesse. Ad esempio, se il codice utilizza l'introspezione o l'invocazione di metodi Java dal codice nativo, queste classi potrebbero non essere riconosciute come obbligatorie nel file DEX principale.

Se ricevi java.lang.NoClassDefFoundError, devi specificare manualmente le classi aggiuntive richieste nel file DEX principale dichiarandole con la proprietà multiDexKeepProguard nel tipo di build. Se una classe ha una corrispondenza nel file multiDexKeepProguard, viene aggiunta al file DEX principale.

Proprietà multiDexKeepProguard

Il file multiDexKeepProguard utilizza lo stesso formato di ProGuard e supporta l'intera grammatica di ProGuard. Per ulteriori informazioni su come personalizzare gli elementi da conservare nell'app, consulta Personalizzare il codice da conservare.

Il file specificato in multiDexKeepProguard deve contenere -keep opzioni in qualsiasi sintassi ProGuard valida. Ad esempio, -keep com.example.MyClass.class. Puoi creare un file chiamato multidex-config.pro che ha il seguente aspetto:

-keep class com.example.MyClass
-keep class com.example.MyClassToo

Se vuoi specificare tutte le classi di un pacchetto, il file avrà il seguente aspetto:

-keep class com.example.** { *; } // All classes in the com.example package

Quindi puoi dichiarare quel file per un tipo di build, come segue:

android {
    buildTypes {
        release {
            multiDexKeepProguard file('multidex-config.pro')
            ...
        }
    }
}

android {
    buildTypes {
        getByName("release") {
            multiDexKeepProguard = file("multidex-config.pro")
            ...
        }
    }
}

Ottimizza il multidex nelle build di sviluppo

Una configurazione multidex richiede un tempo di elaborazione della build molto più elevato perché il sistema di build deve prendere decisioni complesse su quali classi devono essere incluse nel file DEX principale e quali classi possono essere incluse nei file DEX secondari. Ciò significa che le build incrementali che utilizzano multidex in genere impiegano più tempo e possono potenzialmente rallentare il processo di sviluppo.

Per ridurre i tempi di compilazione incrementali più lunghi, utilizza il pre-dexing per riutilizzare l'output multidex tra le compilazioni. Il pre-dexing si basa su un formato ART disponibile solo su Android 5.0 (livello API 21) e versioni successive. Se utilizzi Android Studio, l'IDE utilizza automaticamente il pre-dexing durante il deployment dell'app su un dispositivo con Android 5.0 (livello API 21) o versioni successive. Tuttavia, se esegui build di Gradle dalla riga di comando, devi impostare minSdkVersion su 21 o versioni successive per attivare il pre-dexing.

android {
    defaultConfig {
        ...
        multiDexEnabled true
        // The default minimum API level you want to support.
        minSdkVersion 15
    }
    productFlavors {
        // Includes settings you want to keep only while developing your app.
        dev {
            // Enables pre-dexing for command-line builds. When using
            // Android Studio 2.3 or higher, the IDE enables pre-dexing
            // when deploying your app to a device running Android 5.0
            // (API level 21) or higher, regardless of minSdkVersion.
            minSdkVersion 21
        }
        prod {
            // If you've configured the defaultConfig block for the production version of
            // your app, you can leave this block empty and Gradle uses configurations in
            // the defaultConfig block instead. You still need to include this flavor.
            // Otherwise, all variants use the "dev" flavor configurations.
        }
    }
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'),
                                                 'proguard-rules.pro'
        }
    }
}
dependencies {
    implementation "androidx.multidex:multidex:2.0.1"
}

android {
    defaultConfig {
        ...
        multiDexEnabled = true
        // The default minimum API level you want to support.
        minSdk = 15
    }
    productFlavors {
        // Includes settings you want to keep only while developing your app.
        create("dev") {
            // Enables pre-dexing for command-line builds. When using
            // Android Studio 2.3 or higher, the IDE enables pre-dexing
            // when deploying your app to a device running Android 5.0
            // (API level 21) or higher, regardless of minSdkVersion.
            minSdk = 21
        }
        create("prod") {
            // If you've configured the defaultConfig block for the production version of
            // your app, you can leave this block empty and Gradle uses configurations in
            // the defaultConfig block instead. You still need to include this flavor.
            // Otherwise, all variants use the "dev" flavor configurations.
        }
    }
    buildTypes {
        getByName("release") {
            isMinifyEnabled = true
            proguardFiles(getDefaultProguardFile("proguard-android.txt"),
                                                 "proguard-rules.pro")
        }
    }
}

dependencies {
    implementation("androidx.multidex:multidex:2.0.1")
}

Per scoprire altre strategie per migliorare le velocità di compilazione da Android Studio o dalla riga di comando, consulta Ottimizzare la velocità di compilazione. Per saperne di più sull'utilizzo delle varianti di build, consulta Configurare le varianti di build.

Suggerimento:se hai varianti di build diverse per esigenze multidex diverse, puoi fornire un file manifest diverso per ogni variante in modo che solo il file per il livello API 20 e versioni precedenti modifichi il nome del tag <application>. Puoi anche creare una sottoclasse Application diversa per ogni variante in modo che solo la sottoclasse per il livello API 20 e versioni precedenti espanda la classe MultiDexApplication o chiami MultiDex.install(this).

Testare le app multidex

Quando scrivi test di misurazione per app multidex, non è necessaria alcuna configurazione aggiuntiva se utilizzi una misurazione MonitoringInstrumentation o AndroidJUnitRunner. Se utilizzi un altro Instrumentation, devi sostituire il relativo metodo onCreate() con il seguente codice:

fun onCreate(arguments: Bundle) {
  MultiDex.install(targetContext)
  super.onCreate(arguments)
  ...
}

public void onCreate(Bundle arguments) {
  MultiDex.install(getTargetContext());
  super.onCreate(arguments);
  ...
}