android模組化app開發筆記-1環境搭建
由於專案做的越來越大,業務上就產生了要將app模組化的需求,所謂模組化就是將一個app分成不同功能的小模組(外掛),當安裝程式的時候並不需要將所有模組一次全部安裝,使用者可以在需要的時候視情況從伺服器上更新新增小外掛。
android上模組化一直都有人在摸索也出現了不少框架各有優特點,我學習apkplug這個外掛化框架。這個框架的特點是
1)外掛就是普通apk檔案,開發外掛跟普通app沒有太大區別省去了學習固定api的功夫了。
2)外掛apk不用在本地安裝,網上比較經典的外掛化框架都是通過android:sharedUserId="xxx"的形式將外掛與app進行關聯,而apkplug不用安裝在app程序中執行也算是它的一大特點
3)通過標準OSGI服務實現外掛間通訊,我們開發應用時就可以定義自己的通訊介面了,而不必拘泥於固定的介面。
一 環境搭建
從apkplug官網下載其最新的sdk解壓出來的檔案目錄結構為如圖1
新建一個主應用工程我取名為myapkplughelloworld,將armeabi,Bundle1.4.0.jar兩個檔案放入工程的libs資料夾中如圖2
配置應用許可權到工程的AndroidManifest.xml中
<!-- 外掛平臺需要的許可權! --> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"></uses-permission> <uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/> <uses-permission android:name="android.permission.INTERNET"/>另外將以下程式碼加入到<application></application>節點中 <!-- 外掛平臺需要的配置! --> <activity android:name="org.apkplug.app.apkplugActivity" android:configChanges="orientation|keyboardHidden" />
下一步便是呼叫SDK啟動外掛了。
這裡需要寫一個PropertyInstance介面它是apkplug定義的目的是為了外掛框架啟動時傳人一些啟動引數,我夠出來這個介面的定義如下,具體詳細使用可以看apkplug官方提供的文件基本上是模組化的東西
public interface PropertyInstance { /** * 框架配置資訊獲取介面 * 框架將通過該介面從系統獲取必要資訊 * 可以通過該介面實現框架資訊的本地儲存 * @param key * @return */ public String getProperty(String key); /** * 框架配置資訊設定介面 * 框架通過該介面設定其產生的配置資訊 * 可以通過該介面實現框架資訊的本地儲存 * @param key * @param v */ public void setProperty(String key,String v); /** * 框架啟動時將自動安裝該該函式提供的檔案 * @return 本地外掛絕對路徑 */ public String[] AutoInstall(); /** * 框架啟動時將自動安裝並啟動該該函式提供的檔案 * @return 本地外掛絕對路徑 */ public String[] AutoStart(); }
PropertyInstance寫好以後便可以呼叫FrameworkInstance類啟動框架了如下程式碼
try
{
FrameworkInstance frame=FrameworkFactory.getInstance().start(null,Launcher.this,
MyProperty.getInstance(this.getApplicationContext()));
}catch (Exception ex){
System.err.println("Could not create : " + ex);
//ex.printStackTrace();
StringBuffer buf=new StringBuffer();
buf.append("外掛平臺啟動失敗:\n");
buf.append(ex.getMessage());
this.setTitle(buf.toString());
Toast.makeText(this, "外掛平臺啟動失敗",
Toast.LENGTH_SHORT).show();
}
如果不出意外外掛框架便啟動完畢了,通過啟動完成後的FrameworkInstance類可以獲得框架的第一個內建外掛SystemBundle。這個外掛很重要它是我們進入框架的一個入口,我們可以通過它呼叫或啟動其他框架的類與activity,下面將列出呼叫activity的程式碼
二 編寫外掛
首先新建一個工程myBundle將SDK包中的OSGI.jar引入到工程(注意這裡osgi.jar包不能直接放入libs資料夾中,我們僅引入但不編譯否則框架載入外掛時會報錯,因為包衝突)中如下圖
接下來還需要寫兩個檔案,一個是org.osgi.framework.BundleActivator介面,框架啟動時將呼叫我們寫的這一個類。另外一個是plugin.xml文件它用於配置外掛的啟動引數,比如啟動的BundleActivator路徑,啟動的Activity,需要引出的包等。詳細可以看官網plugin.xml配置說明http://www.apkplug.com/guide/#39 一下是我寫的兩個檔案程式碼
public class SimpleBundle implements BundleActivator
{
private BundleContext mcontext = null;
public void start(BundleContext context) throws Exception
{
System.err.println("你號我是外掛,我已經啟動了 我的BundleId為:"+context.getBundle().getBundleId());
this.mcontext = context;
}
public void stop(BundleContext context)
{
System.err.println("你號我是外掛,我被停止了 我的BundleId為:"+context.getBundle().getBundleId());
}
}
<?xml version="1.0" encoding="UTF-8"?> <plugin-features Bundle-Name="myBundle" Bundle-SymbolicName="com.example.mybundle" Bundle-Version="1.0.0" date="2013.10.223" provider-name="外掛開發商的名稱" provider-url="" Bundle-Activator="com.example.mybundle.SimpleBundle" Bundle-Activity="com.example.mybundle.MainActivity" Export-Package="com.example.mybundle" > </plugin-features>
記得外掛中的Activity都需要繼承框架的BundleActivity。最後編譯外掛將得到的apk檔案複製到主應用的assets資料夾中(如果要實現網路更新可以使用apkplug提供的遠端外掛託管服務)
下一步在主應用我們寫的PropertyInstance介面的public String[] AutoStart()方法中給出框架啟動是需要啟動的外掛文字檔案路徑(也就是我們剛才編譯得到的外掛)
public String[] AutoStart() {
File f0=null;
try {
InputStream in=context.getAssets().open("myBundle.apk");
f0=new File(context.getFilesDir(),"myBundle.apk");
if(!f0.exists())
copy(in, f0);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return new String[]{"file:"+f0.getAbsolutePath()};
}
這樣當外掛啟動時便會同時啟動我們的外掛了。
這還沒有完我們還需要通過SystemBundle來啟動外掛的Actvitiy
啟動外掛的Actvitiy需要呼叫框架提供的一個OSGI服務
這裡給出模版程式碼
/**
* 獲取系統提供的StartActivity服務來啟動一個外掛中的Activity
* 前提時外掛中已在plugin.xml設定了Export-Package中添加了該
* Activity完整包路徑 否則會找不到該Activity
* @param name
* @throws Exception
*/
public void startActivity(String ActivityClass) throws Exception{
System.out.println(ActivityClass);
BundleContext mcontext=frame.getSystemBundleContext();
ServiceReference reference=mcontext.getServiceReference(StartActivity.class.getName());
if(null!=reference){
StartActivity service=(StartActivity) mcontext.getService(reference);
if(service!=null){
Intent i=new Intent();
i.setClassName(this, ActivityClass);
i.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
service.StartActivity(mcontext, i);
}
mcontext.ungetService(reference);
}
}
最後執行主應用便可以看到外掛apk中的介面了有圖有真相
最後給出原始碼