有時候我們需要在應(yīng)用中接入即時通訊等功能,可是又苦于apk過大、65535方法數(shù)等相關(guān)問題,這時候最好的方式就是用插件化的方式接入,下面是我用一個插件化框架接入環(huán)信的過程,跟大家分享一下。
這里我使用的是Apkplug這個插件化框架,這是一款我目前通過對比找到的最適合的插件化工具,在使用方便、運行穩(wěn)定等方面均有良好表現(xiàn),還提供后臺托管,這一點也是極大的方便了開發(fā)者。
這里是這個框架的官方文檔可以參考
環(huán)信插件開發(fā)
一、插件開發(fā)
首先我們對這個插件的需求是:能在一個有用戶系統(tǒng)的宿主app里提供聊天功能。
進(jìn)一步細(xì)分為如下具體功能:
1 能跟宿主一起登陸
2 能跟宿主用戶系統(tǒng)有統(tǒng)一映射
3 能提供聊天界面
4 能提供好友界面
5 能提供最近會話界面
具體實現(xiàn):
1 首先要按照環(huán)信的文檔,先進(jìn)行初始化和相關(guān)配置
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
EMOptions options = new EMOptions();
EaseUI.getInstance().init(this, options);
//xugai
EMClient.getInstance().setDebugMode(false);
}
}
插件在宿主中啟動時會自動執(zhí)行application中的初始化代碼。配置就不在這里貼了,可以參考環(huán)信文檔或下面的demo代碼。
2 跟宿主一起登陸,是為了能夠跟宿主融合的更加融洽,如果點擊按鈕彈出一個登陸界面,則像是兩個app之間的互相調(diào)用。所以在宿主登陸的時候,同時要登陸插件,并對用戶透明。因此插件需要提供一個登陸接口。我用Dispatcher的方式聲明接口:
繼承一個com.apkplug.easemobplug.Processores類,實現(xiàn)Receive方法,在方法中調(diào)用環(huán)信登陸,宿主使用這個接口時可以把用戶名、密碼傳過來。參數(shù)的傳遞是靠人為約定的,宿主開發(fā)者和插件開發(fā)者按照約定取值。DispatchAgent類是管插件和宿主理通信的類,在登陸完成后,我調(diào)用dispatchAgent.reply回調(diào)宿主,同樣,給宿主發(fā)送結(jié)果的參數(shù)格式也是要人為約定好。
public class EaseLogin extends Processor {
BundleContext context;
DispatchAgent dispatchAgent;
public EaseLogin(BundleContext context) {
super(context);
this.context = context;
dispatchAgent = new DispatchAgent(context);
}
@Override
public void Receive(URI uri, HashMap<String, Object> hashMap) {
String userName = (String) hashMap.get("UserName");
String passWord = (String) hashMap.get("Password");
if(userName == null || passWord == null){
dispatchAgent.reply(getMsgId(),false,new Exception("your username or password is null"));
return;
}
EMClient.getInstance().login(userName, passWord, new EMCallBack() {
@Override
public void onSuccess() {
dispatchAgent.reply(getMsgId(),true,"success");
}
@Override
public void onError(int i, String s) {
dispatchAgent.reply(getMsgId(),false,s);
}
@Override
public void onProgress(int i, String s) {
}
});
}
}
這樣一個登陸接口就做好了。
3 跟宿主應(yīng)用統(tǒng)一用戶系統(tǒng),環(huán)信插件里的用戶和聊天的好友一定是宿主應(yīng)用用戶系統(tǒng)中的用戶及好友,所以哪些人是用戶,那些人跟哪些人是好友,需要宿主告訴環(huán)信插件。
首先需要提供注冊接口,宿主用戶注冊時,同步注冊環(huán)信插件,映射關(guān)系隨便定義:
public class EaseCreateAccount extends BaseProcessor {
public EaseCreateAccount(BundleContext context) {
super(context);
}
@Override
public void Receive(URI uri, HashMap<String, Object> hashMap) {
String userName = (String) hashMap.get("UserName");
String password = (String) hashMap.get("Password");
if(userName == null || password == null){
dispatchAgent.reply(getMsgId(),false,new Exception("username or password is null"));
return;
}
try {
EMClient.getInstance().createAccount(userName,password);
dispatchAgent.reply(getMsgId(),true,"success");
} catch (HyphenateException e) {
dispatchAgent.reply(getMsgId(),false,e);
}
}
}
好友的同步有兩種實現(xiàn)方式:
1 直接由宿主調(diào)用插件接口,設(shè)置插件的好友列表
2 宿主只管好友添加,插件自己去服務(wù)器拿好友列表
貌似方法2要好很多,但是需要服務(wù)端的對接,只有服務(wù)端可以直接添加好友,客戶端添加好友的接口,最多只能等對方登陸時候才添加成功。
demo里這兩種我都實現(xiàn)了,跟上面登陸接口一樣,我實現(xiàn)了一個直接給好友列表界面添加好友的接口,只供參考,我并沒有調(diào)用。我用的第二種方式,當(dāng)宿主的用戶系統(tǒng)添加好友時,同時給環(huán)信添加好友,因此我對外提供了添加好友的接口。
public class EaseAddFriend extends BaseProcessor {
public EaseAddFriend(BundleContext context) {
super(context);
}
@Override
public void Receive(URI uri, HashMap<String, Object> hashMap) {
String username = (String) hashMap.get("UserName");
try {
EMClient.getInstance().contactManager().addContact(username, "you have to accept");
dispatchAgent.reply(getMsgId(),true,"success");
} catch (HyphenateException e) {
dispatchAgent.reply(getMsgId(),false,e);
}
}
}
一系列你希望宿主用到的接口實現(xiàn)好后,就可以對外注冊了,plugin.xml中添加:
<processor
uri="http://apkplug.plug.com/meseplug/login"
className="com.apkplug.easemobplug.Processores.EaseLogin"
/>
<processor
uri="http://apkplug.plug.com/meseplug/init"
className="com.apkplug.easemobplug.Processores.EaseInit"
/>
<processor
uri="http://apkplug.plug.com/meseplug/regist"
className="com.apkplug.easemobplug.Processores.EaseCreateAccount"
/>
<processor
uri="http://apkplug.plug.com/meseplug/contect"
className="com.apkplug.easemobplug.Processores.EaseContectsProcessor"
/>
<processor
uri="http://apkplug.plug.com/meseplug/addfriend"
className="com.apkplug.easemobplug.Processores.EaseAddFriend"
/>
<processor
uri="http://apkplug.plug.com/meseplug/deletefriend"
className="com.apkplug.easemobplug.Processores.EaseDeleteFriend"
/>
4 提供聊天界面、好友界面、會話界面,環(huán)信提供一些直接可用的界面,稍加改動就可以使用,宿主使用時,只需要用Intent啟動即可,需要注意的是,一些manifest文件activity標(biāo)簽中配置的值,并不能同步到宿主,如果需要那些值,只能在宿主配置插件的activity,比如主界面,android:windowSoftInputMode="adjustPan"
這個值不配置的話,輸入法彈出會壓縮界面控件,只在插件里配置是不起作用的。
<activity android:name=".ui.MainActivity"
android:theme="@style/Theme.AppCompat.NoActionBar"
android:windowSoftInputMode="adjustPan"
/>
提供了這些功能后,插件就開發(fā)完成了。
二、宿主開發(fā)
1 安裝插件,為了方便,我這里直接用了本地安裝
PlugManager.getInstance().installAssets("app-debug.apk", "1.0.0", new OnInstallListener() {
@Override
public void onDownloadProgress(String url, String filePath, long bytesWritten, long totalBytes, PlugInfo plugInfo) {
}
@Override
public void onInstallSuccess(final org.osgi.framework.Bundle bundle, PlugInfo plugInfo) {
runOnUiThread(new Runnable() {
@Override
public void run() {
textView.setText(textView.getText()+"\n插件安裝成功");
}
});
startChat();
}
@Override
public void onInstallFailuer(int i, PlugInfo plugInfo, String errorMsg) {
}
@Override
public void onDownloadFailure(String errorMsg) {
}
});
}
2 登陸插件,我已經(jīng)注冊過了用戶,這里不再調(diào)用,調(diào)用方式相同。用DispatchAgent對象調(diào)用call方法,
final DispatchAgent dispatchAgent=new DispatchAgent(PlugManager.getInstance().getBundleContext());
HashMap<String,Object> params2 = new HashMap<String, Object>();
params2.put("UserName","apkplug");
params2.put("Password","lbh131206");
runOnUiThread(new Runnable() {
@Override
public void run() {
textView.setText(textView.getText()+"\n開始登陸環(huán)信");
}
});
dispatchAgent.call("http://apkplug.plug.com/meseplug/login", params2, new WorkerCallback() {
@Override
public void reply(URI uri, Object... objects) throws Exception {
if(!(Boolean) objects[0]){
return;
}
textView.setText(textView.getText()+"\n環(huán)信登陸成功");
chatInitandLogin(dispatchAgent);
}
@Override
public void timeout(URI uri) throws Exception {
}
@Override
public void Exception(URI uri, Throwable throwable) {
System.err.println(uri);
}
});
登陸后就隨時可以進(jìn)行界面跳轉(zhuǎn)了
Intent intent = new Intent();
intent.setClassName(MainActivity.this, className);
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
startActivity(intent)
demo地址:
宿主:
https://github.com/apkplug/SDKDemo/tree/master/EasePlugUser
插件:
https://github.com/apkplug/SDKDemo/tree/master/EasemobPlug