Android app中加载jar插件

http://www.cnblogs.com/franksunny/archive/2011/09/27/2193085.html

插件的引入

1、UI方面有些自定义的通用控件代码，并不局限于一个项目中使用，当需要共享使用时虽然可以采用源码方式合入新项目，但是这种原始方式增加代码布局上的复杂程度的同时，也增大了通用控件的不安全性。

2、有些功能性模块，或是第三方开发，或是分阶段开发的，为了方便程序的功能扩展，我们同样考虑将功能代码封装为插件包的形式。

那么在Android中是否支持插件呢？也就是是否支持类似Windows和Symbian平台的lib和dll等库方式呢？答案是肯定的，在Android中支持的插件库，可以是由C/C++开发的JNI形式，也可以是由java代码开发的jar形式（也可以是android封包完成的apk文件）。由于JNI需要涉及Android NDK，这里不做介绍，本文只针对jar插件。

加载jar插件的方式

虽然在加载jar插件方式之前，我们应该考虑jar插件的创建，但是由于jar加载方式的不同，决定了jar插件创建形式的不同。目前加载jar插件的方式有两类：一类是跟加载SDK api的Android.jar一样的静态加载方式；另一类是运行时动态加载方式。前者是编译过程中就必须要jar文件存在，后者是运行时通过反射机制来动态调用。下面我们分别阐述。

静态加载jar插件

静态jar插件的创建

静态jar插件的创建，可以只是由一个简单的java类文件编译生成，也可以从一个完整的工程中导出生成。

假设有一个没有用到Android API的 test.java文件放置在c盘根目录下面，那么在安装jdk的PC上我们可以通过cmd命令行来生成一个jar文件

//编译test.java,生成test.class

C:\>javac test.java

//压缩test.class生成jar文件

C:\>jar cvf test.jar test.class

标明清单(manifest)

增加：test.class(读入= 267) (写出= 213)(压缩了 20%)

//查看生成的jar文件中具体有哪些内容

C:\>jar tvf test.jar

     0 Fri Sep 23 11:21:34 CST 2011 META-INF/

    75 Fri Sep 23 11:21:34 CST 2011 META-INF/MANIFEST.MF

   267 Thu Sep 22 17:56:42 CST 2011 test.class

通过如上步骤一个最简单jar插件就生成了。下面在看如何从一个完整工程中生成一个jar文件，当然也可以通过cmd命令行的方式来实现，但是对于工程来说，涉及代码文件多，在Eclipse中又提供了简易操作的情况下，我们自然优先选择Eclipse来图形化实现jar文件的生成。本想自己按步骤小结下，但是发现网上很多博客整理的很详细了，我在这里就引用http://hi.baidu.com/lovewjlove/blog/item/95d74560ebacdbd68db10d90.html 博文中的内容吧。

1. 首先在Eclipse中打开项目， 右键点击项目，选择“Export”；

2. 选择Java/JAR file，Next；

3. Select the resources to export中可以选择你想要包含的项目文件夹，一些不必要的文件夹就无需放进去了，免得增大空间；

这里有几个选项：

    * Export generated class files and resources 表示只导出生成的.class文件和其他资源文件

    * Export all output folders for checked projects 表示导出选中项目的所有文件夹

    * Export java source file and resouces 表示导出的jar包中将包含你的源代码*.java，如果你不想泄漏源代码，那么就不要选这项了

    * Export refactorings for checked projects 把一些重构的信息文件也包含进去

在Select the export destination中选择导出的jar的路径，Next

4. 下一页可以选择是否导出那些含有警告warning或者错误errors的*.class文件。一般不用理他，Next

5. 下一个页面里可以对项目做一些配置

    * Generate the manifest file是系统帮我们自动生成MANIFEST.MF文件，如果你的项目没有引用其他class-path，那可以选择这一项；

    * Use existing mainfest from workspace。这是可以选择我们自定义的.MF文件，格式如上所写；

    * Seal content。要封装整个jar或者指定的包packet；

    * Main class。这里可以选择你的程序入口，将来打包出来的jar就是你这个入口类的执行结果；

配置完点击Finish，工程的jar文件就生成了。

博文中只是针对java工程，对于android工程我们自然也是可以通过上述方法完成静态jar文件的生成。

静态jar插件的使用

通过上面静态jar插件的创建步骤，我们生成了一个drawcolor.jar的jar插件，下面我们来演示下如何将这个文件加载到Android app中进行使用。

首先，拷贝jar插件至工程目录。在android工程根目录创建一个lib文件夹，将该drawcolor.jar拷贝至lib文件夹下；

其次，工程中添加jar插件。右击工程，通过属性菜单，打开Java Build Path对话框，选中Libraries，添加JARS，在弹出的对话框中选择lib/drawcolor.jar文件（也可以通过项目右键点击Build Path，Build Path–> Libraries–> Add JARs,选择第三方的jar包，），结果如下

<!--[if !vml]--><!--[endif]-->

第三，调用jar中的操作。通过上述步骤之后，在Eclipse的Project Explorer下面就可以看到jar包中的类和成员了，与使用Android.jar内的API一样使用，具体就不给出示例了。

<!--[if !vml]--><!--[endif]-->

第四，将添加的jar打包到apk中。由于SDK的API在运行环境中（模拟器和手机上）已经有插件存在了，所以我们不用打包到apk中，而我们自己添加的jar，就必须要打包到apk中，否则运行时会报没有找到包的错误。打包到apk需要做如下操作

在工程目录下找到.classpath文件，因为我们这里添加的jar位于lib/drawcolor.jar，所以查看文件中是否有如下一行

       <classpathentry kind="lib" path="lib/drawcolor.jar"/>

假如有就可以了，假如是其他的，就要把他更改过来，比如http://www.yoyong.com/archives/tag/android-%E6%89%93%E5%8C%85%E7%AC%AC%E4%B8%89%E6%96%B9jar博文中提到的一样。

怀疑这个跟Eclipse的版本有关吧，我的编译环境下，这个在工程中添加jar插件步骤时已经在工程的.classpath文件修改为需求的样子了。

以上就实现了静态加载jar插件。

动态加载jar插件

动态jar插件的创建

动态jar插件的创建相对比静态jar多了一个步骤，因为Android虚拟机是基于dex的，所以我们的class不能简单的调用jar命令压缩就可以了，而是需要使用sdk\platform-tools目录下的dx工具来进行类型转换。下面演示单一类文件AddFunc.java的生成jar插件使用命令行的过程。

<!--[if !supportLists]-->1、  <!--[endif]-->使用javac命令编译生成AddFunc.class文件

<!--[if !supportLists]-->2、  <!--[endif]-->由于AddFunc类的包目录为com.demo.jar，所以需要将AddFunc.class文件拷贝至sdk\platform-tools\com\demo\jar文件夹下面

<!--[if !supportLists]-->3、  <!--[endif]-->使用dx命令，生成jar插件文件，上述步骤的命令如下

C:\>javac AddFunc.java

 

C:\>dx --dex --output=AddFunc.jar com/demo/jar/AddFunc.class

 

C:\>jar tvf D:\Android\sdk\platform-tools\AddFunc.jar

    72 Fri Sep 23 14:28:48 CST 2011 META-INF/MANIFEST.MF

   964 Fri Sep 23 14:28:50 CST 2011 classes.dex

通过上述步骤在sdk\platform-tools上面就有一个AddFunc.jar文件了。在这里需要说明的是AddFunc.class必须按照包名放置，否则生成jar会报错。

其实假如本身就在Android工程下面，那么可以现在eclipse下面先编译程序，后在Bin目录下面，自然就按包名，放置了class文件，再将需要的class文件包含文件目录拷贝至sdk\platform-tools目录下就好了。假设我们需要打包两个class，就可以通过如下命令实现

C:\>dx --dex --output=AddFunc.jar com/demo/jar/AddFunc.class com/demo/jar/GameView.class

经过查询，明显比上面这个classes.dex文件大多了，具体如下

C:\>jar tvf D:\Android\sdk\platform-tools\AddFunc.jar

    72 Fri Sep 23 14:38:06 CST 2011 META-INF/MANIFEST.MF

  1752 Fri Sep 23 14:38:06 CST 2011 classes.dex

好了，我们需要的动态jar插件就形成了。

动态jar插件的使用

如上所述，我们生成了需要动态jar插件，如同java中动态加载使用ClassLoader类动态加载一样，在Android我们需要使用DexClassLoader来通过反射机制动态加载。

相对来说假如动态jar插件创建正确，这一步就没什么难题了，就全交给代码来说明吧。

AddFunc的源代码为

package com.demo.jar;

 

import android.util.Log;

 

public class AddFunc

{

    public AddFunc()

    {

           Log.i("AddFunc", "AddFunc class Init");

    }

   

    public int Add(int a, int b)

    {

           int c  = a + b;

           Log.i("AddFunc", "Add result is "+c);

           return c;

    }

}

以上的代码生成动态jar插件后，在模拟器通过cmd如下命令，将jar插件放置到运行坏境中，本文是将其放置在模拟器的sdcard根目录，具体如下

C:\>adb push addFunc.jar sdcard/

6 KB/s (1149 bytes in 0.187s)

这样，就可以在代码中使用反射机制调用jar中的方法了，具体的Android工程中动态调用jar插件的代码如下

package com.demo.jar.runloadjarDemo;

 

import java.io.File;

import java.lang.reflect.Method;

import dalvik.system.DexClassLoader;

import android.app.Activity;

import android.os.Bundle;

 

public class RunLoadJarDemoActivity extends Activity

{

    /** Called when the activity is first created. */

       Class myClass  =null;

      

    @Override

    public void onCreate(Bundle savedInstanceState)

    {

        super.onCreate(savedInstanceState);

        setContentView(R.layout.main);

        try

        {

               File file = new File("/sdcard/AddFunc.jar");

//              File file = new File("/sdcard/drawView.apk");

               if(file.exists())

               { 

                     DexClassLoader cl = new DexClassLoader(file.toString(), getFilesDir().getAbsolutePath(), null, ClassLoader.getSystemClassLoader().getParent());  

                      myClass = cl.loadClass("com.demo.jar.AddFunc");

                      Object obj = myClass.newInstance();

                      Class[] params = new Class[2];

                      params[0] = Integer.TYPE;

                      params[1] = Integer.TYPE;

                      Method action = myClass.getMethod("Add", params);

                      int ret = (Integer)action.invoke(obj, 15, 20);                     

               } 

        }

        catch (Exception ex)

        {     

               ex.printStackTrace();

        }

    }

}

其实从原理上来说，如上生成的动态jar插件，跟apk的生成是同一个道理，所以假设我们不想通过繁琐的dx工具，那么也可以直接由eclipse生成apk，然后通过动态加载的方法来使用apk中的类和方法，本人测试过也是可行的。

好了，至此将Android app中加载jar插件的问题就介绍到这里，如果大家觉得如上的代码调用反射太过繁琐，那么可以通过设计接口的方法来将反射变得简单，至于这个话题就不在本文进行阐述了。