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

Se la tua app ha un minSdk dell'API 20 o precedente e la tua app e le librerie a cui fa riferimento superano i 65.536 metodi, si verifica il seguente errore di build che indica che la tua app ha raggiunto il limite dell'architettura di build 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 compilazione 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 di bytecode Dalvik Executable (DEX). Questa pagina spiega come superare questa limitazione attivando una configurazione dell'app nota come multidex, che consente alla tua app di creare e leggere più file DEX.

Informazioni sul limite di riferimento di 64.000

I file APK (Android app) 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 il numero totale di metodi a cui è possibile fare riferimento all'interno di un singolo file DEX a 65.536, inclusi i metodi del framework Android, i metodi della libreria e i metodi nel tuo codice.

Supporto di multidex prima di 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 di bytecode classes.dex per APK. Per ovviare a questa limitazione, 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 attuali di questa libreria, consulta 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 nativamente il caricamento di più file DEX da file APK. ART esegue la precompilazione al momento dell'installazione dell'app, eseguendo la scansione dei file classesN.dex e compilando un singolo file OAT per l'esecuzione da parte del dispositivo Android. Pertanto, se il tuo minSdkVersion è 21 o superiore, multidex è attivato per impostazione predefinita e non hai bisogno della libreria multidex.

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

Nota:quando esegui l'app utilizzando Android Studio, la build 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 quando esegui il deployment dell'app utilizzando Android Studio, potresti comunque dover configurare la build di rilascio per multidex per evitare il limite di 64 K.

Evitare il limite di 64.000 caratteri

Prima di configurare l'app per consentire l'utilizzo di 64.000 o più riferimenti ai metodi, adotta misure per ridurre il numero totale di riferimenti chiamati dal codice dell'app, inclusi i metodi definiti dal codice dell'app o dalle librerie incluse.

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

Controllare le dipendenze dirette e transitive dell'app

Valuta se il valore di eventuali dipendenze di librerie di grandi dimensioni che includi nella tua app supera la quantità di codice aggiunta all'app. Un pattern comune ma problematico è l'inclusione di una libreria molto grande perché alcuni metodi di utilità sono utili. Ridurre le dipendenze del codice dell'app spesso può aiutarti a evitare il limite di riferimenti DEX.

Rimuovere il codice inutilizzato con R8

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

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

Configurare l'app per multidex

Se il valore di 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 aggiungere 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 tu esegua l'override della classe Application, esegui una delle seguenti operazioni:

   • Se non esegui l'override della classe Application, modifica il file manifest per impostare android:name nel tag <application> nel seguente modo:

     <?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 in modo che estenda 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 base, esegui l'override del metodo attachBaseContext() e chiama MultiDex.install(this) per attivare 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 reflection o JNI prima del completamento di MultiDex.install(). Il tracciamento multidex non seguirà queste chiamate, causando errori ClassNotFoundException o di verifica a causa di una partizione di classe errata tra i file DEX.

Ora, quando crei la tua app, gli strumenti di compilazione Android creano un file DEX principale (classes.dex) e file DEX di supporto (classes2.dex, classes3.dex e così via) in base alle necessità. Il sistema di compilazione comprime quindi tutti i file DEX nel tuo APK.

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

Limitazioni della libreria multidex

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

• L'installazione dei file DEX durante l'avvio nella partizione dati di un dispositivo è complessa e può causare errori L'applicazione non risponde (ANR) 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.
• Quando viene eseguito su versioni precedenti ad Android 5.0 (livello API 21), l'utilizzo di multidex non è sufficiente per aggirare il limite linearalloc (problema 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 presentare problemi all'avvio o al caricamento di particolari gruppi di classi.

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

Dichiarare le classi richieste nel file DEX principale

Quando creano ogni 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 avviarsi correttamente. Se una classe richiesta durante l'avvio non viene fornita nel file DEX principale, l'app si arresta in modo anomalo con l'errore java.lang.NoClassDefFoundError.

Gli strumenti di compilazione riconoscono i percorsi del codice per il 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 richieste 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 un corso viene trovato nel file multiDexKeepProguard, viene aggiunto al file DEX principale.

Proprietà multiDexKeepProguard

Il file multiDexKeepProguard utilizza lo stesso formato di ProGuard e supporta l'intera grammatica 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 opzioni -keep in qualsiasi sintassi ProGuard valida. Ad esempio, -keep com.example.MyClass.class. Puoi creare un file denominato multidex-config.pro che ha questo aspetto:

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

Se vuoi specificare tutte le classi in un pacchetto, il file ha il seguente aspetto:

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

Poi puoi dichiarare il file per un tipo di build, nel seguente modo:

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

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

Ottimizzare multidex nelle build di sviluppo

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

Per ridurre i tempi di compilazione incrementale più lunghi, utilizza il pre-dexing per riutilizzare l'output multidex tra le build. 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 quando esegui il deployment dell'app su un dispositivo con Android 5.0 (livello API 21) o versioni successive. Tuttavia, se esegui build 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 la velocità di build da Android Studio o dalla riga di comando, leggi Ottimizzare la velocità di build. Per ulteriori informazioni sull'utilizzo delle varianti di build, consulta Configurare le varianti di build.

Suggerimento:se hai diverse varianti di build 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 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 precedenti estenda la classe MultiDexApplication o chiami MultiDex.install(this).

Testare le app multidex

Quando scrivi test di strumentazione per app multidex, non è necessaria alcuna configurazione aggiuntiva se utilizzi un'instrumentazione MonitoringInstrumentation o AndroidJUnitRunner. Se utilizzi un altro Instrumentation, devi eseguire l'override del 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);
  ...
}