android 程序开发的插件化 模块化方法 之一
框架已经放出:
https://code.google.com/p/android-application-plug-ins-frame-work/
由于linux平台的安全机制,再加上dalvik的特殊机制,各种权限壁垒,使得开发一个灵活多变的程序,变得比较困难,不像pc平台下那么容易。
瞅瞅elipse的插件,瞅瞅360的插件,在android下,我们一开始很难写好一个主程序,然后通过插件机制来应对以后的功能拓展,于是程序变得不那么灵活多变了。
比如一款android下的安全软件,新版本增加了一个功能,如短信拦截,往往会因为一个模块的增加,而重新编译一个apk包,这样周而复始,哪怕只增加50kb的功能代码,用户也需要升级一个完整的apk,往往是5~6M的体积。
最近思来想去,想到一个方法,既然tencent qq在android下面可以以apk的形式来换皮肤,这资源文件的拓展都可以这样简便的搞,为何功能性的拓展就不可以?
想出来了两种解决方案。
先来说说第一种。
demo下载在最后
先说分析思路。
android下,默认的情况是,每个apk相互独立的,基本上每个应用都是一个dalvik虚拟机,都有一个uid,再配合上linux本身的权限机制,使得apk互通很难直接进行。但作为一个独立应用的集成,不管多少个apk,都可以并为一个单独的dalvik虚拟机,直观的反映给开发人员就是在shell下列出进程,那几个apk同时加载后,会一个进程存在。
这主要就是工程的清单文件 Mainfest中配置了,只需要一句话,以我的测试demo为例:
.... <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="org.igeek.plugintest.main" <!-- 就是这句关键代码 --> android:sharedUserId="org.igeek.plugintest" android:versionCode="1" android:versionName="1.0"> .....
在上面的代码中,android:sharedUserId是指共用一个uid,也就是,凡是这个属性相同的工程,都会共用同一个uid,这样,权限壁垒就消除了,dalvik也会融合为一个,可以测试一下,写几个工程,没有这个属性和有这个属性的情况下,同时运行,在列出当前进程,就直观的说明了。
程序拓展的插件化,当然需要一个主程序,主程序是实现基本功能,以及UI,还有插件的检索以及插件的调用。
这里贴出我demo中的主activity代码:
1 public class AndoirdpluginActivity extends ActivityGroup implements OnClickListener ,OnScrollCompleteListener{ 2 private LinearLayout llMainLayout; 3 4 //workspace,看看luncher的源码,这个就是桌面那个多屏的实现 5 private WorkSpace wkMain; 6 private Button btnFindPlugins; 7 private CheckBox chbAttachMain; 8 9 private LocalActivityManager m_ActivityManager; 10 11 //这个bean的集合,就相当于插件的描述集合 12 //每个bean也就是一个插件的各种描述 13 private List<PluginBean> plugins; 14 15 @Override 16 public void onCreate(Bundle savedInstanceState) { 17 super.onCreate(savedInstanceState); 18 setContentView(R.layout.main); 19 20 llMainLayout=(LinearLayout) findViewById(R.id.main_llMainLayout); 21 wkMain=(WorkSpace) findViewById(R.id.main_wkMain); 22 btnFindPlugins=(Button) findViewById(R.id.main_btnFindPlugins); 23 chbAttachMain=(CheckBox) findViewById(R.id.main_chbAttachMain); 24 25 m_ActivityManager = getLocalActivityManager(); 26 27 wkMain.setOnScrollCompleteLinstenner(this); 28 btnFindPlugins.setOnClickListener(this); 29 } 30 31 @Override 32 public void onClick(View v) { 33 attachPlugin(findPlugins()); 34 btnFindPlugins.setVisibility(View.GONE); 35 } 36 37 /** 38 * 加载插件列表 39 * @param plugins 40 */ 41 private void attachPlugin(final List<PluginBean> plugins){ 42 Log.e("ydt", " "); 43 Log.e("ydt", "----- 列出插件"); 44 this.plugins=plugins; 45 for(final PluginBean plugin:plugins){ 46 Button btn=new Button(this); 47 btn.setTextColor(Color.RED); 48 btn.setText(plugin.getLabel()); 49 50 llMainLayout.addView(btn); 51 //添加事件 52 btn.setOnClickListener(new OnClickListener() { 53 54 @Override 55 public void onClick(View v) { 56 boolean isAttack=chbAttachMain.isChecked(); 57 58 Intent it=new Intent(); 59 it.setAction(plugin.getPakageName()); 60 61 //是否附加为view 62 if(isAttack){ 63 //这里偷下懒,这是演示插件作为view附加到主程序中的 64 for(PluginBean plugin:plugins){ 65 66 Intent itt=new Intent(); 67 itt.setAction(plugin.getPakageName()); 68 ViewGroup view=(ViewGroup) (m_ActivityManager.startActivity("", itt)).getDecorView(); 69 wkMain.addView(view); 70 } 71 //一次性附加完毕算了,然后把按钮都删了,看着清净,这几个不是重点 72 llMainLayout.removeAllViews(); 73 chbAttachMain.setVisibility(View.GONE); 74 wkMain.setToScreen(0); 75 }else{ 76 //这里,不会把插件的窗体附加到主程序中,纯粹无用的演示 77 startActivity(it); 78 } 79 } 80 }); 81 82 } 83 } 84 85 /** 86 * 查找插件 87 * @return 88 */ 89 private List<PluginBean> findPlugins(){ 90 91 List<PluginBean> plugins=new ArrayList<PluginBean>(); 92 93 94 //遍历包名,来获取插件 95 PackageManager pm=getPackageManager(); 96 97 98 List<PackageInfo> pkgs=pm.getInstalledPackages(PackageManager.GET_UNINSTALLED_PACKAGES); 99 for(PackageInfo pkg :pkgs){ 100 //包名 101 String packageName=pkg.packageName; 102 String sharedUserId= pkg.sharedUserId; 103 104 //sharedUserId是开发时约定好的,这样判断是否为自己人 105 if(!"org.igeek.plugintest".equals(sharedUserId)||"org.igeek.plugintest.main".equals(packageName)) 106 continue; 107 108 //进程名 109 String prcessName=pkg.applicationInfo.processName; 110 111 //label,也就是appName了 112 String label=pm.getApplicationLabel(pkg.applicationInfo).toString(); 113 114 PluginBean plug=new PluginBean(); 115 plug.setLabel(label); 116 plug.setPakageName(packageName); 117 118 plugins.add(plug); 119 } 120 121 122 return plugins; 123 124 } 125 126 127 /** 128 * WorkSpace滚动到那个屏,会触发这个事件 129 * 而worksapce中每一屏又是一个插件 130 * 这个事件是用来列出当前屏幕插件所提供的应用,并且让用户调用 131 */ 132 @Override 133 public void onScrollComplete(final ScrollEvent e) { 134 try { 135 final Context context = createPackageContext(plugins.get(e.curScreen).getPakageName(), Context.CONTEXT_INCLUDE_CODE|Context.CONTEXT_IGNORE_SECURITY); 136 llMainLayout.removeAllViews(); 137 //这几行,通过反射获取了当前插件的描述信息,如同大部分框架的xml一样,这里算是模拟了一下IOC控制反转 138 Class clazz=context.getClassLoader().loadClass(plugins.get(e.curScreen).getPakageName()+".PluginApplication"); 139 Object o=clazz.newInstance(); 140 Map<String,List<String>> r=(Map<String, List<String>>) clazz.getMethod("getDesciption").invoke(o); 141 List<String> classes=r.get("classes"); 142 List<String> methods=r.get("methods"); 143 144 145 //这里,根据获得的插件所提供的功能,来生成几个按钮显示,供我们调用 146 for(final String clas:classes){ 147 for(final String method:methods){ 148 Button btn=new Button(this); 149 150 btn.setText(clas+" -> "+method+" 执行"); 151 152 153 //点击后,就执行插件所提供的方法 154 btn.setOnClickListener(new OnClickListener() { 155 156 @Override 157 public void onClick(View v) { 158 try { 159 Class c=context.getClassLoader().loadClass(plugins.get(e.curScreen).getPakageName()+"."+clas); 160 Object o1=c.newInstance(); 161 162 //这里注意,context实际上就是句柄,这里如果涉及到窗体,plugin的句柄其实是不行的,因为它没有可以 163 //依附的窗体 164 165 //这个context是plugin的,通过测试,dialog这类行不通,Toast是可以的,因为 166 //Toast是依附于屏幕主窗口的 167 //c.getMethod(method,Context.class).invoke(o1,context); 168 169 //这里则传递的是主程序的句柄 170 c.getMethod(method,Context.class).invoke(o1,AndoirdpluginActivity.this); 171 172 } catch (Exception e) { 173 // TODO Auto-generated catch block 174 e.printStackTrace(); 175 } 176 } 177 }); 178 llMainLayout.addView(btn); 179 } 180 } 181 182 183 } catch (Exception e1) { 184 // TODO Auto-generated catch block 185 e1.printStackTrace(); 186 } 187 188 } 189 }
看注释吧,主要有两点
插件的扫描
这种方案是,每个插件以一个单独的apk发布,这样可以在程序中很灵活的知道是否有新的插件,提示用户下载安装,插件的apk清单描述为Action为非Luncher,Category为Default。
主程序侦听packgeManager的安装完成广播,之后扫描同包名(插件当然得这么定义了,只要通过packgeManager能判断是否为自己的插件就行)的apk,之后列出来,让用户选择是否加载。
插件的加载与调用
在获取包后,通过调用系统的api可以得到 sharedUserId 与主程序相同的apk的context,也就是句柄,获得了句柄,通过这个context可以得到classloader,之后就简单了,如何知道这个插件提供什么功能?
这个可以用xml描述,比如这个xml是插件apk的一个资源,就像spring这个框架一样。xml中描述了这个插件有哪些类,提供哪些方法,这些方法需要传入什么参数,返回什么类型。我的demo中为了方便,是用接口,每个插件有一个类提供一个相同的方法,来获取一个map集合,获得这个插件的描述。
ok,到这里就知道加载的插件提供什么功能了。
在上面贴出来的代码中,是循环遍历每个插件,并把每个插件提供的功能以Button的方式显示给用户,点击按钮,就执行了插件的功能,执行时,并不是activity转向(这样就无意义了),而是在主程序自身的context句柄中执行,也就是在自身的窗体中执行。
代码中有一段注释,说明,如果插件有用到context时,记得传递进去的是主程序的context,这样窗体才能附加到这个句柄中,如果传递的是插件的context,它没有一个窗体实例,是无法将一些窗体附加进去的,无任何效果。
这里只提供思路,有时间的话研究一下,看能不能搞个通用的框架出来。还有另一种方法,不通过apk形式,以后会写出来。
这里有一些待验证的问题,比如插件的权限问题,如果插件需要的一些权限在主程序中没有声明,会是个什么情况,能不能实时申请呢?这个需要高人指点。或者在主程序中把能声明的权限预先声明了也不错。还有就是native层代码的问题,如果插件包含了native层代码,会是个什么情况,这也需要验证。
这是demo下载:
http://files.cnblogs.com/hangxin1940/android_plugin_program.rar
原创,转载请注明 http://hangxin1940.cnblogs.com
插件的引入
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包,),结果如下
第三,调用jar中的操作。通过上述步骤之后,在Eclipse的Project Explorer下面就可以看到jar包中的类和成员了,与使用Android.jar内的API一样使用,具体就不给出示例了。
第四,将添加的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插件使用命令行的过程。
1、 使用javac命令编译生成AddFunc.class文件
2、 由于AddFunc类的包目录为com.demo.jar,所以需要将AddFunc.class文件拷贝至sdk\platform-tools\com\demo\jar文件夹下面
3、 使用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插件的问题就介绍到这里,如果大家觉得如上的代码调用反射太过繁琐,那么可以通过设计接口的方法来将反射变得简单,至于这个话题就不在本文进行阐述了。