casidiablo / multidex

Library Project including compatibility multi dex loader.

IMPORTANT: this library has been superseded by buildToolsVersion 21.1.0

The steps for multidexing if you are using 21.1.0 or higher is:

android {
    compileSdkVersion 21
    buildToolsVersion "21.1.0"

    defaultConfig {
        ...
        minSdkVersion 14
        targetSdkVersion 21
        ...

        // Enabling multidex support.
        multiDexEnabled true
    }
    ...
}

Note that the dependency on 'com.android.support:multidex:1.0.0' is automatic, there is not need to specify it.

I'll keep this around for reference, but I encourage all people using this to switch to the official multidexing method: Building Apps with Over 65K Methods.

Deprecated, non-official multidex

Library Project including compatibility multi dex loader.

This can be used by an Android project to install classloader with multiple dex of applications running on API 4+.

What's this?

This is just a fork of the original multidex repo. I'll maintain this for a while since I needed this to be in a Maven repo for easy consumption.

What's it for again?

While dexing classes it is sometimes possible to exceed the maximum (65536) methods limit (try using Google Play Services and Scaloid for instance):

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

So the suggestion is to use the --multi-dex option of the dx utility; this will generate several dex files (classes.dex, classes2.dex, etc.) that will be included in the APK. To do so, add the following code to your app's build.gradle file:

afterEvaluate {
    tasks.matching {
        it.name.startsWith('dex')
    }.each { dx ->
        if (dx.additionalParameters == null) {
            dx.additionalParameters = []
        }
        dx.additionalParameters += '--multi-dex' // enable multidex
        
        // optional
        // dx.additionalParameters += "--main-dex-list=$projectDir/<filename>".toString() // enable the main-dex-list
    }
}

By default Dalvik's classloader will look for the classes.dex file only, so it's necessary to patch it so that it can read from multiple dex files. That's what this project provides.

If you are unlucky enough, the multidex classes will not be included in the classes.dex file (the first one read by the classloader), which in turn will render all this useless. There's a workaround for this though. Create a file with this content and a arbitrary name:

android/support/multidex/BuildConfig.class
android/support/multidex/MultiDex$V14.class
android/support/multidex/MultiDex$V19.class
android/support/multidex/MultiDex$V4.class
android/support/multidex/MultiDex.class
android/support/multidex/MultiDexApplication.class
android/support/multidex/MultiDexExtractor$1.class
android/support/multidex/MultiDexExtractor.class
android/support/multidex/ZipUtil$CentralDirectory.class
android/support/multidex/ZipUtil.class

And pass the path of this file to the --main-dex-list option of the dx utility. Just uncomment the example from above accordingly by enabling one more item to the list of strings exposed by the additionalParameters property. The <filename> is the arbitrary choosed above.

Usage

Add this project to your classpath:

repositories {
  jcenter()
}

dependencies {
  compile 'com.google.android:multidex:0.1'
}

Then you have 3 possibilities:

• Declare android.support.multidex.MultiDexApplication as the application in your AndroidManifest.xml
• Have your Application extends android.support.multidex.MultiDexApplication, or...
• Have your Application override attachBaseContext starting with:

import android.support.multidex.MultiDex;

// ...

@Override
protected void attachBaseContext(Context base) {
    super.attachBaseContext(base);
    MultiDex.install(this);
}

build.gradle example

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:0.13.3'
        classpath 'jp.leafytree.gradle:gradle-android-scala-plugin:1.1'
    }
}

apply plugin: 'com.android.application'
apply plugin: 'jp.leafytree.android-scala'

repositories {
    jcenter()
}

android {
    compileSdkVersion 21
    buildToolsVersion '21.0.2'

    defaultConfig {
        applicationId 'some.app'
        minSdkVersion 19
        targetSdkVersion 19
        versionCode 1
        versionName '1.0'
    }
}

dependencies {
    compile 'com.google.android:multidex:0.1'
    compile 'com.android.support:support-v4:19.0.1'
    compile 'com.google.android.gms:play-services:5.0.77'
    compile 'org.scala-lang:scala-library:2.11.2'
    compile 'org.scaloid:scaloid_2.11:3.4-10'
}

Cautions

If you extends the MultiDexApplication or override the method attachBaseContext, you need to remember:

NOTE: The following cautions must be taken only on your android Application class, you don't need to apply this cautions in all classes of your app

• The static fields in your application class will be loaded before the MultiDex#installbe called! So the suggestion is to avoid static fields with types that can be placed out of main classes.dex file.
• The methods of your application class may not have access to other classes that are loaded after your application class. As workarround for this, you can create another class (any class, in the example above, I use Runnable) and execute the method content inside it. Example:

    @Override
    public void onCreate() {
        super.onCreate();
        
        final Context mContext = this;
        new Runnable() {

            @Override
            public void run() {
                // put your logic here!
                // use the mContext instead of this here
            }
        }.run();
    }

Common problems

DexException: Library dex files are not supported in multi-dex mode

If you catch this error:

Error:Execution failed for task ':app:dexDebug'.
> com.android.ide.common.internal.LoggedErrorException: Failed to run command:
  	$ANDROID_SDK/build-tools/android-4.4W/dx --dex --num-threads=4 --multi-dex
  	...
  Error Code:
  	2
  Output:
  	UNEXPECTED TOP-LEVEL EXCEPTION:
  	com.android.dex.DexException: Library dex files are not supported in multi-dex mode
  		at com.android.dx.command.dexer.Main.runMultiDex(Main.java:322)
  		at com.android.dx.command.dexer.Main.run(Main.java:228)
  		at com.android.dx.command.dexer.Main.main(Main.java:199)
  		at com.android.dx.command.Main.main(Main.java:103)

The --multi-dex option to dx is incompatible with pre-dexing library projects. So if your app uses library projects, you need to disable pre-dexing before you can use --multi-dex:

android {
    // ...
    dexOptions {
        preDexLibraries = false
    }
}
```

#### OutOfMemoryError: Java heap space

If you catch this error while running dex:
```
UNEXPECTED TOP-LEVEL ERROR:
java.lang.OutOfMemoryError: Java heap space
```
There is a field on dexOptions to increase the java heap space:
```groovy
android {
    // ...
    dexOptions {
        javaMaxHeapSize "2g"
    }
}
```