Dalvik虚拟机动态加载DEX/JAR

作者：郭孝星
微博：郭孝星的新浪微博
邮箱：allenwells@163.com
博客：http://blog.csdn.net/allenwells
github：https://github.com/AllenWell

在文章Dalvik虚拟机加载类的机制中，我们讨论了Dalvik虚拟机加载类的相关原理，本文就来讨论一下，如何利用Dalvik提供的这些机制进行DEX/JAR的动态加载。

首先要说明的是虽然Dalvik虚拟机可以进行动态加载，却无法像Java虚拟机那样方便动态加载JAR,也不支持从字节流中加载类文件。

原因在于Dalvik虚拟机运行的不是Java打包得JAR中的的class字节码，而是通过DX工具来优化转换的Dalvik字节码。在Android项目打包的APK中，被引入的JAR也都会被打包进了classes.dex。

下面我们就通过一个例子来演示如何动态调用DEX/JAR。

(1)写编写接口类

package com.allenwells.dexdynamiccalldemo;

import android.content.Context;

public interface LibraryInterface
{
    public void showAwesomeToast(Context context, String message);
}

(2)实现接口类

package com.allenwells.dexdynamiccalldemo.lib;

import com.allenwells.dexdynamiccalldemo.LibraryInterface;

import android.content.Context;
import android.widget.Toast;

public class LibraryProvider implements LibraryInterface
{
    public void showAwesomeToast(Context context, String message)
    {
        if (context == null)
        {
            return;
        }
        Toast.makeText(context, String.format("LibraryProvider print : ++ %s ++", message),
                Toast.LENGTH_LONG).show();
    }
}

(3)将接口实现类LibraryProvider打包成JAR文件

打包后如下图所示：

此时JAR里包含的是JVM字节码，只能被Java虚拟机所识别。

(4)将class文件转换为dex文件

dx工具在ANDROID_SDK_HOME\build-tools\android-4.3下，所以把命令行跳到当前目录下，再将JVMCode.jar复制到该目录下，并执行以下命令：

dx --dex --output==DalvikCode.jar JVMCode.jar

命令执行完成后，会在当前目录下生成DalvikCode.jar文件，虽然DalvikCode.jar是以.jar为文件名后缀，但是它里面包含的是dex文件，如下图所示：

将生成的DalvikCode.jar放入工程的assets文件夹中，并删除com.allenwells.dexdynamiccalldemo.lib包，如下图所示：

(5)实现MainActivity，进行外部DEX动态调用。

package com.allenwells.dexdynamiccalldemo;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;

import android.app.Activity;
import android.app.ProgressDialog;
import android.content.Context;
import android.os.AsyncTask;
import android.os.Bundle;
import android.view.View;
import android.widget.ImageButton;
import dalvik.system.DexClassLoader;

public class MainActivity extends Activity
{
    private static final String SECONDARY_DEX_NAME = "DalvikCode.jar";

    /*
     * 设置拷贝缓存大小，本例子采用8*1024，也可以根据secondary_dex.jar的实际大小 来设置缓存
     */
    private static final int BUF_SIZE = 8 * 1024;

    private ImageButton mToastButton = null;
    private ProgressDialog mProgressDialog = null;

    @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mToastButton = (ImageButton) findViewById(R.id.toast_button);

        /* 将secondary_dex.jar从aeest资源中拷贝到存储中，以供DexClassLoader调用 */
        final File dexInternalStoragePath = new File(getDir("dex",
                Context.MODE_PRIVATE), SECONDARY_DEX_NAME);
        if (!dexInternalStoragePath.exists())
        {
            mProgressDialog = ProgressDialog.show(this, getResources()
                    .getString(R.string.diag_title),
                    getResources().getString(R.string.diag_message), true,
                    false);
            /* 在异步任务中进行文件拷贝 */
            (new PrepareDexTask()).execute(dexInternalStoragePath);
        }
        else
        {
            mToastButton.setEnabled(true);
        }

        mToastButton.setOnClickListener(new View.OnClickListener()
        {
            public void onClick(View view)
            {
                /* DexClassLoader将优化后DEX文件写入的内部路径 */
                final File optimizedDexOutputPath = getDir("outdex",
                        Context.MODE_PRIVATE);

                /* 用第三方DEX文件初始化DexClassLoader */
                DexClassLoader dexClassLoader = new DexClassLoader(
                        dexInternalStoragePath.getAbsolutePath(),
                        optimizedDexOutputPath.getAbsolutePath(), null,
                        getClassLoader());
                Class<?> libProviderClazz = null;

                try
                {
                    /* 用类加载器加载LibraryProvider类 */
                    libProviderClazz = dexClassLoader
                            .loadClass("com.allenwells.dexdynamiccalldemo.lib.LibraryProvider");

                    /*
                     * 将返回的对象进行类型转换，使得可以直接在接口里进行方法调用。另一种调用方式是
                     * 使用反射进行调用，但这种方式操作复杂，效率低下。
                     */
                    LibraryInterface lib = (LibraryInterface) libProviderClazz
                            .newInstance();

                    /* 调用方法，输出打印 */
                    lib.showAwesomeToast(view.getContext(), "hello");
                }
                catch (Exception exception)
                {
                    exception.printStackTrace();
                }
            }
        });
    }

    /* 将第三方DEX文件从asset资源文件中拷贝到内存存储中 */
    private boolean prepareDex(File dexInternalStoragePath)
    {
        BufferedInputStream bis = null;
        OutputStream dexWriter = null;

        try
        {
            bis = new BufferedInputStream(getAssets().open(SECONDARY_DEX_NAME));
            dexWriter = new BufferedOutputStream(new FileOutputStream(
                    dexInternalStoragePath));
            byte[] buf = new byte[BUF_SIZE];
            int len;
            while ((len = bis.read(buf, 0, BUF_SIZE)) > 0)
            {
                dexWriter.write(buf, 0, len);
            }
            dexWriter.close();
            bis.close();
            return true;
        }
        catch (IOException e)
        {
            if (dexWriter != null)
            {
                try
                {
                    dexWriter.close();
                }
                catch (IOException ioe)
                {
                    ioe.printStackTrace();
                }
            }
            if (bis != null)
            {
                try
                {
                    bis.close();
                }
                catch (IOException ioe)
                {
                    ioe.printStackTrace();
                }
            }
            return false;
        }
    }

    private class PrepareDexTask extends AsyncTask<File, Void, Boolean>
    {

        @Override
        protected void onCancelled()
        {
            super.onCancelled();
            if (mProgressDialog != null)
                mProgressDialog.cancel();
        }

        @Override
        protected void onPostExecute(Boolean result)
        {
            super.onPostExecute(result);
            if (mProgressDialog != null)
                mProgressDialog.cancel();
        }

        @Override
        protected Boolean doInBackground(File... dexInternalStoragePaths)
        {
            prepareDex(dexInternalStoragePaths[0]);
            return null;
        }
    }
}

点击DDMS，在File Explorer下查看应用的文件信息，可以发现DalvikCode.jar被保存进了内部存储中，如下图所示：

所有工作自此完成，点击测试按钮，运行程序，效果如下图所示：