为方法数超过 64K 的应用启用多 dex 文件

当您的应用及其引用的库超过 65,536 种方法时,您会遇到一个编译错误,指明您的应用已达到 Android 编译架构规定的引用限制:

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

较低版本的编译系统会报告一个不同的错误,但指示的是同一问题:

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

这两种错误情况都会显示一个共同的数字:65536。此数字表示单个 Dalvik Executable (DEX) 字节码文件内的代码可调用的引用总数。本页介绍如何通过启用称为“多 dex 文件”的应用配置(该配置使您的应用能够编译和读取多个 DEX 文件)来越过这一限制。

关于 64K 引用限制

Android 应用 (APK) 文件包含 Dalvik Executable (DEX) 文件形式的可执行字节码文件,这些文件包含用来运行您的应用的已编译代码。Dalvik Executable 规范将可在单个 DEX 文件内引用的方法总数限制为 65,536,其中包括 Android 框架方法、库方法以及您自己的代码中的方法。在计算机科学领域内,术语千(简称 K)表示 1024(或 2^10)。由于 65,536 等于 64 X 1024,因此这一限制称为“64K 引用限制”。

Android 5.0 之前版本的多 dex 文件支持

Android 5.0(API 级别 21)之前的平台版本使用 Dalvik 运行时来执行应用代码。默认情况下,Dalvik 将应用限制为每个 APK 只能使用一个 classes.dex 字节码文件。要绕过这一限制,您可以在您的项目中添加多 dex 文件支持库:

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

要查看这个库的当前版本,请参阅版本页面中有关多 dex 文件的信息。

如果您不使用 AndroidX,请改为添加以下支持库依赖项:

    dependencies {
      implementation 'com.android.support:multidex:1.0.3'
    }
    

此库会成为应用的主要 DEX 文件的一部分,然后管理对其他 DEX 文件及其所包含代码的访问。如需了解详情,请参阅下面有关如何针对多 dex 文件配置您的应用的部分。

Android 5.0 及更高版本的多 dex 文件支持

Android 5.0(API 级别 21)及更高版本使用名为 ART 的运行时,它本身支持从 APK 文件加载多个 DEX 文件。ART 在应用安装时执行预编译,扫描 classesN.dex 文件,并将它们编译成单个 .oat 文件,供 Android 设备执行。因此,如果您的 minSdkVersion 为 21 或更高的值,则默认情况下启用多 dex 文件,并且您不需要多 dex 文件支持库。

如需详细了解 Android 5.0 运行时,请阅读 ART 和 Dalvik

注意:使用 Android Studio 运行应用时,会针对您部署到的目标设备优化编译。这包括在目标设备运行 Android 5.0 及更高版本时启用多 dex 文件。由于此优化仅在使用 Android Studio 部署应用时应用,因此您可能仍需要为多 dex 文件配置发布版本,以规避 64K 限制。

规避 64K 限制

在将您的应用配置为支持使用 64K 或更多方法引用之前,您应该采取措施来减少应用代码调用的引用总数,包括由您的应用代码或包含的库定义的方法。以下策略可帮助您避免达到 DEX 引用限制:

  • 检查应用的直接和传递依赖项 - 确保您在应用中使用任何庞大依赖库所带来的好处多于为应用添加大量代码所带来的弊端。一种常见的反面模式是,仅仅为了使用几个实用方法就在应用中加入非常庞大的库。减少您的应用代码依赖项往往能够帮助您规避 DEX 引用限制。
  • 通过 R8 移除未使用的代码 - 启用代码压缩以针对您的发布版本运行 R8。启用压缩可确保您交付的 APK 不含有未使用的代码。

使用这些技巧使您不必在应用中启用多 dex 文件,同时还会减小 APK 的总体大小。

针对多 dex 文件配置您的应用

如果您的 minSdkVersion 设置为 21 或更高的值,则默认情况下启用多 dex 文件,并且您不需要多 dex 文件支持库。

但是,如果您的 minSdkVersion 设置为 20 或更低的值,则必须使用多 dex 文件支持库并对应用项目进行以下修改:

  1. 修改模块级 build.gradle 文件以启用多 dex 文件,并将多 dex 文件库添加为依赖项,如下所示:

        android {
            defaultConfig {
                ...
                minSdkVersion 15
                targetSdkVersion 28
                multiDexEnabled true
            }
            ...
        }
    
        dependencies {
          implementation 'com.android.support:multidex:1.0.3'
        }
        
  2. 根据是否替换 Application 类,执行以下某项操作:
    • 如果您不替换 Application 类,请编辑清单文件以设置 <application> 标记中的 android:name,如下所示:

          <?xml version="1.0" encoding="utf-8"?>
          <manifest xmlns:android="http://schemas.android.com/apk/res/android"
              package="com.example.myapp">
              <application
                      android:name="android.support.multidex.MultiDexApplication" >
                  ...
              </application>
          </manifest>
          
    • 如果您替换 Application 类,请按如下方式对其进行更改以扩展 MultiDexApplication(如果可能):

      Kotlin

          class MyApplication : MultiDexApplication() {...}
          

      Java

          public class MyApplication extends MultiDexApplication { ... }
          
    • 或者,如果您替换 Application 类,但无法更改基类,则可以改为替换 attachBaseContext() 方法并调用 MultiDex.install(this) 来启用多 dex 文件:

      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);
            }
          }
          

      注意:在 MultiDex.install() 完成之前,不要通过反射或 JNI 执行 MultiDex.install() 或其他任何代码。多 dex 文件跟踪功能不会追踪这些调用,从而导致出现 ClassNotFoundException,或因 DEX 文件之间的类分区错误而导致验证错误。

现在,当您编译应用时,Android 编译工具会根据需要构造主要 DEX 文件 (classes.dex) 和辅助 DEX 文件(classes2.dexclasses3.dex 等)。然后,编译系统会将所有 DEX 文件打包到您的 APK 中。

在运行时,多 dex 文件 API 使用特殊的类加载器来搜索适用于您的方法的所有 DEX 文件(而不是只在主 classes.dex 文件中搜索)。

多 dex 文件支持库的局限性

多 dex 文件支持库具有一些已知的局限性,将其纳入您的应用编译配置时,您应注意这些局限性并进行针对性的测试:

  • 启动期间在设备的数据分区上安装 DEX 文件的过程相当复杂,如果辅助 DEX 文件较大,可能会导致应用无响应 (ANR) 错误。为避免此问题,请启用代码压缩,以尽量减小 DEX 文件的大小,并移除未使用的代码部分。
  • 当运行的版本低于 Android 5.0(API 级别 21)时,使用多 dex 文件不足以避开 linearalloc 限制(问题 78035)。此上限在 Android 4.0(API 级别 14)中有所提高,但这并未完全解决该问题。在低于 Android 4.0 的版本中,您可能会在达到 DEX 索引限制之前达到 linearalloc 限制。因此,如果您的目标 API 级别低于 14,请在这些版本的平台上进行全面测试,因为您的应用可能会在启动时或加载特定类组时出现问题。

    代码压缩可以减少甚至有可能消除这些问题。

声明主要 DEX 文件中必需的类

为多 dex 文件应用编译每个 DEX 文件时,编译工具会执行复杂的决策制定来确定主要 DEX 文件中需要的类,以便您的应用能够成功启动。如果主要 DEX 文件中未提供启动期间需要的任何类,则您的应用会崩溃并出现 java.lang.NoClassDefFoundError 错误。

对于直接从您的应用代码访问的代码,不应发生这种情况,因为编译工具可以识别这些代码路径。但是,当代码路径的可见性较低时(例如,当您使用的库具有复杂的依赖项时),可能会发生这种情况。例如,如果代码使用自检机制或从原生代码调用 Java 方法,那么可能不会将这些类识别为主要 DEX 文件中的必需类。

因此,如果您收到 java.lang.NoClassDefFoundError,则必须使用编译类型中的 multiDexKeepFilemultiDexKeepProguard 属性声明它们,以手动将这些其他类指定为主 DEX 文件中的必需项。如果某个类在 multiDexKeepFilemultiDexKeepProguard 文件中匹配到,则会将该类添加到主要 DEX 文件。

multiDexKeepFile 属性

您在 multiDexKeepFile 中指定的文件应该每行包含一个类,并且类采用 com/example/MyClass.class 格式。例如,您可以创建一个名为 multidex-config.txt 的文件,如下所示:

    com/example/MyClass.class
    com/example/MyOtherClass.class
    

然后,您可以针对版本类型声明该文件,如下所示:

    android {
        buildTypes {
            release {
                multiDexKeepFile file('multidex-config.txt')
                ...
            }
        }
    }
    

请注意,Gradle 会读取相对于 build.gradle 文件的路径,因此如果 multidex-config.txtbuild.gradle 文件在同一目录中,以上示例将有效。

multiDexKeepProguard 属性

multiDexKeepProguard 文件使用与 Proguard 相同的格式,并且支持全部 Proguard 语法。如需详细了解 Proguard 格式和语法,请参阅 Proguard 手册中的 Keep 选项一节。

您在 multiDexKeepProguard 中指定的文件应该在任何有效的 ProGuard 语法中包含 -keep 选项。例如,-keep com.example.MyClass.class。您可以创建一个名为 multidex-config.pro 的文件,如下所示:

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

如果您要指定软件包中的所有类,文件将如下所示:

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

然后,您可以针对版本类型声明该文件,如下所示:

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

在开发编译中优化多 dex 文件

多 dex 文件配置会大幅增加编译处理时间,因为编译系统必须就哪些类必须包含在主要 DEX 文件中以及哪些类可以包含在辅助 DEX 文件中做出复杂的决策。这意味着,使用多 dex 文件的增量编译通常耗时较长,可能会拖慢您的开发进度。

要缩短较长的增量编译时间,您应使用 dex 预处理在编译之间重用多 dex 文件输出。dex 预处理依赖于一种只在 Android 5.0(API 级别 21)及更高版本中提供的 ART 格式。如果您使用的是 Android Studio 2.3 及更高版本,那么在将您的应用部署到搭载 Android 5.0(API 级别 21)或更高版本的设备上时,IDE 会自动使用此功能。

提示Android Plugin for Gradle 3.0.0 及更高版本得到了进一步改进来优化编译速度,如每个类的 dex 处理(这样,只有您修改的类会重新进行 dex 处理)。一般来说,为了获得最佳开发体验,您应始终升级到最新版 Android Studio 和 Android 插件。

不过,如果您是从命令行运行 Gradle 编译,则需要将 minSdkVersion 设为 21 或更高的值以启用 dex 预处理。要保留正式版的设置,一种有用的做法是使用产品性质(一个 dev 性质和一个发布性质,它们使用不同的 minSdkVersion 值)来创建两个应用版本,如下所示。

    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 what you set for
                // 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 'com.android.support:multidex:1.0.3'
    }
    

要了解有助于改进编译速度(从 Android Studio 或命令行中)的更多策略,请阅读优化您的编译速度。如需详细了解如何使用编译变体,请参阅配置编译变体

提示:由于您有满足不同多 dex 文件需求的不同编译变体,因此也可以为不同的变体提供不同的清单文件(这样,只有适用于 API 级别 20 及更低级别的清单文件会更改 <application> 标记名称),或者为每个变体创建不同的 Application 子类(这样,只有适用于 API 级别 20 及更低级别的子类会扩展 MultiDexApplication 类或调用 MultiDex.install(this))。

测试多 dex 文件应用

编写面向多 dex 文件应用的插桩测试时,如果使用 MonitoringInstrumentation(或 AndroidJUnitRunner)插桩测试,则不需要额外的配置。如果使用其他 Instrumentation,则必须将其 onCreate() 方法替换为以下代码:

Kotlin

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

Java

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