編輯:關於Android編程
簡介
自去年 LeanCloud 發布實時通信(IM)服務之後,基於用戶反饋和工程師對需求的消化和對業務的提煉,上周正式發布了「實時通信 2.0 」。設計理念依然是「靈活、解耦、可組合、可定制」,具體可以參考《實時通信開發指南》,了解 LeanCloud 實時通信的基本概念和模型。
下載和安裝
可以到 LeanCloud 官方下載點下載 LeanCloud IM SDK v2 版本。將下載到的 jar 包加入工程即可。
一對一的文本聊天
我們先從最簡單的環節入手,看看怎麼用 LeanCloud IM SDK v2 實現一對一文本聊天。
初始化
和 LeanCloud 其他服務一樣,實時聊天服務的初始化也是在 Application 的 onCreate 方法中進行的:
復制代碼 代碼如下:
public class MyApplication extends Application{
public void onCreate(){
...
AVOSCloud.initialize(this,"{{appId}}","{{appKey}}");
...
}
}
並且在AndroidManifest.xml中間聲明:
復制代碼 代碼如下:
<manifest>
...
<application
android:name=".MyApplication"
....>
...
<service android:name="com.avos.avoscloud.PushService" />
<receiver android:name="com.avos.avoscloud.AVBroadcastReceiver">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
<action android:name="android.intent.action.USER_PRESENT" />
</intent-filter>
</receiver>
...
</application>
</manifest>
接下來我們需要完成用戶登錄。
登錄
假定聊天發起方名叫 Tom,為直觀起見,我們使用用戶名來作為 clientId 登錄聊天系統(LeanCloud 雲端只要求 clientId 在應用內唯一即可,具體用什麼數據由應用層決定),代碼如下:
復制代碼 代碼如下:
AVIMClient imClient = AVIMClient.getInstance("Tom");
imClient.open(new IMClientCallback(){
@Override
public void done(AVIMClient client, AVException e) {
if (e) {
// 出錯了,可能是網絡問題無法連接 LeanCloud 雲端,請檢查網絡之後重試。
// 此時聊天服務不可用。
} else {
// 成功登錄,可以開始進行聊天了。
};
}
});
建立對話
假定我們要跟「Bob」這個用戶進行聊天,我們先創建一個對話,代碼如下:
復制代碼 代碼如下:
// 下面的代碼包含了實際應用中的所有邏輯:查詢->創建「對話」。
// 先查詢一下是否已經存在與「Bob」的私聊對話,可以先忽略這部分代碼
List<String> clientIds = new ArrayList<String>();
clientIds.add("Tom");
clientIds.add("Bob");
AVIMConversationQuery conversationQuery = imClient.getQuery();
conversationQuery.withMembers(clientIds);
// 之前有常量定義:
// int ConversationType_OneOne = 0; // 兩個人之間的單聊
// int ConversationType_Group = 1; // 多人之間的群聊
conversationQuery.whereEqualTo("attr.type", ConversationType_OneOne);
conversationQuery.findInBackground(new AVIMConversationQueryCallback(){
@Override
public void done(List<AVIMConversation> conversations, AVException e) {
if (null != e) {
// 出錯了。。。
} else if (null != conversations && conversations.size() > 0){
// 已經有一個和 Bob 的對話存在,繼續在這一對話中聊天
...
} else {
// 不曾和 Bob 聊過,新建一個對話。!!**這裡是重點**!!
Map<String, Object> attr = new HashMap<String, Object>();
attr.put("type", ConversationType_OneOne);
imClient.createConversation(clientIds, attr, new AVIMConversationCreatedCallback() {
@Override
public void done(AVIMConversation conversation, AVException e) {
if (null != conversation) {
// 成功了!
}
}
});
}
}
});
如何查詢「對話」
如你所見,我們創建一個對話的時候,指定了成員(Tom 和 Bob)和一個額外的屬性({type: 0})。這些數據保存到雲端後,你在 控制台 -> 存儲 -> 數據 裡面會看到,_Conversation 表中增加了一條記錄,新記錄的 m 屬性值為["Tom", "Bob"],attr 屬性值為{"type":0}。如你所料,m 屬性就是對應著成員列表,attr 屬性就是用戶增加的額外屬性值(以對象的形式存儲)。
與 AVObject 的檢索方法一樣,要檢索這樣的對話,我們需要通過 imClient.getQuery() 得到一個 AVIMConversationQuery 實例,然後調用 conversationQuery.withMembers() 來限定成員列表,調用 conversationQuery.whereEqualTo() 來限定額外的 attr 屬性。按照 AVQuery 的慣例,限定額外的 type 條件的時候需要指定的屬性名是 attr.type。
發送消息
建立好對話之後,要發送消息是很簡單的:
復制代碼 代碼如下:
AVIMMessage message = new AVIMMessage();
message.setContent("hello");
conversation.sendMessage(message, new AVIMConversationCallback() {
@Override
public void done(AVException e) {
if (null != e) {
// 出錯了。。。
} else {
}
}
});
好了,這樣一條消息就發送過去了。但是問題來了,對於「Bob」而言,他怎麼才能收到別人發給他的消息呢?
消息接收
在 Bob 這一端,要能接收到消息,需要如下幾步:
1,進行初始化和登錄,代碼與發送端並無二致;
2,實現自己的 AVIMMessageHandler,響應新消息到達通知,主要是如下函數:
復制代碼 代碼如下:
public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client);
對於 Tom 發過來的消息,要顯示出來,我們只需實現 onMessage 即可,示例代碼如下:
復制代碼 代碼如下:
class CustomMessageHandler extends AVIMMessageHandler {
@Override
public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
// 新消息到來了。在這裡增加你自己的處理代碼。
...
}
}
AVIMMessageManager.registerDefaultMessageHandler(new CustomMessageHandler());
幾個主要的回調接口
從上面的例子中可以看到,要接收到別人給你發送的消息,需要實現自己的 AVIMMessageHandler 類。從 v2 版開始,LeanCloud IM SDK 大量采用回調來反饋操作結果,但是對於一些被動的消息通知,則還是采用接口來實現的,包括:
當前網絡出現變化
對話中有新的消息
對話中有新成員加入
對話中有成員離開
被邀請加入某對話
被踢出對話
LeanCloud IM SDK 內部使用了三種接口來響應這些事件。
網絡事件響應接口(AVIMClientEventHandler)
主要用來處理網絡變化事件,主要函數為:
復制代碼 代碼如下:
/**
* 實現本方法以處理網絡斷開事件
*
* @param client
* @since 3.0
*/
public abstract void onConnectionPaused(AVIMClient client);
/**
* 實現本方法以處理網絡恢復事件
*
* @since 3.0
* @param client
*/
public abstract void onConnectionResume(AVIMClient client);
在網絡中斷的情況下,所有的消息收發和對話操作都會出現問題。
通過 AVIMClient.setClientEventHandler(AVIMClientEventHandler handler) 可以設定全局的 ClientEventHandler。
對話成員變化響應接口(AVIMConversationEventHandler)
主要用來處理對話中成員變化的事件,主要函數為:
復制代碼 代碼如下:
/**
* 實現本方法以處理聊天對話中的參與者離開事件
*
* @param client
* @param conversation
* @param members 離開的參與者
* @param kickedBy 離開事件的發動者,有可能是離開的參與者本身
* @since 3.0
*/
public abstract void onMemberLeft(AVIMClient client,
AVIMConversation conversation, List<String> members, String kickedBy);
/**
* 實現本方法以處理聊天對話中的參與者加入事件
*
* @param client
* @param conversation
* @param members 加入的參與者
* @param invitedBy 加入事件的邀請人,有可能是加入的參與者本身
* @since 3.0
*/
public abstract void onMemberJoined(AVIMClient client,
AVIMConversation conversation, List<String> members, String invitedBy);
/**
* 實現本方法來處理當前用戶被踢出某個聊天對話事件
*
* @param client
* @param conversation
* @param kickedBy 踢出你的人
* @since 3.0
*/
public abstract void onKicked(AVIMClient client, AVIMConversation conversation,
String kickedBy);
/**
* 實現本方法來處理當前用戶被邀請到某個聊天對話事件
*
* @param client
* @param conversation 被邀請的聊天對話
* @param operator 邀請你的人
* @since 3.0
*/
public abstract void onInvited(AVIMClient client, AVIMConversation conversation,
String operator);
通過 AVIMMessageManager.setConversationEventHandler(AVIMConversationEventHandler handler) 可以設置全局的 ConversationEventHandler。
消息響應接口(MessageHandler)
主要用來處理新消息到達事件,主要的函數為:
復制代碼 代碼如下:
// 收到新的消息
@Override
public abstract void onMessage(AVIMMessage message, AVIMConversation conversation);
// 自己發送的消息已經被對方接收
@Override
public abstract void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client);
通過 AVIMMessageManager.registerDefaultMessageHandler(MessageHandler handler) 可以設置全局的 MessageHandler。
我們實現這三類接口,就可以處理所有的通知消息了(注意:LeanCloud IM SDK 內部實現了一個空的 AVIMMessageHandler,你可以從這裡派生出進行實際處理的 handler)。
支持富媒體的聊天消息
上面的代碼演示了如何發送簡單文本信息,但是現在的交互方式已經越來越多樣化,圖片、語音、視頻已是非常普遍的消息類型。v2 版的 LeanCloud IM SDK 已經可以很好地支持這些富媒體消息,具體說明如下:
基類:AVIMTypedMessage
所有富媒體消息的基類,其聲明為
復制代碼 代碼如下:
//SDK定義的消息類型,LeanCloud SDK 自身使用的類型是負數,所有正數留給開發者自定義擴展類型使用,0 作為「沒有類型」被保留起來。
enum AVIMReservedMessageType {
UnsupportedMessageType(0),
TextMessageType(-1),
ImageMessageType(-2),
AudioMessageType(-3),
VideoMessageType(-4),
LocationMessageType(-5),
FileMessageType(-6);
};
public abstract class AVIMTypedMessage extends AVIMMessage {
public AVIMTypedMessage();
public int getMessageType();
@Override
public final String getContent();
@Override
public final void setContent(String content);
}
文本消息(AVIMTextMessage)
AVIMTypedMessage 子類,表示一般的文本消息,其聲明為
復制代碼 代碼如下:
@AVIMMessageType(type = -1)
public class AVIMTextMessage extends AVIMTypedMessage {
public String getText();
public void setText(String text);
public Map<String, Object> getAttrs();
public void setAttrs(Map<String, Object> attr);
}
要發送文本消息,示例代碼為:
復制代碼 代碼如下:
AVIMTextMessage message = new AVIMTextMessage();
message.setText("hello");
conversation.sendMessage(message, new AVIMConversationCallback() {
@Override
public void done(AVException e) {
if (null != e) {
// 出錯了。。。
} else {
}
}
});
圖像消息(AVIMImageMessage)
AVIMTypedMessage 子類,支持發送圖片和附帶文本的混合消息,其聲明為:
復制代碼 代碼如下:
public class AVIMImageMessage extends AVIMFileMessage {
public AVIMImageMessage();
public AVIMImageMessage(String localPath) throws FileNotFoundException, IOException;
public AVIMImageMessage(File localFile) throws FileNotFoundException, IOException;
public AVIMImageMessage(AVFile file);
/**
* 獲取文件的metaData
*
* @return
*/
@Override
public Map<String, Object> getFileMetaData();
/**
* 獲取圖片的高
*
* @return
*/
public int getHeight();
/**
* 獲取圖片的寬度
*
* @return
*/
public int getWidth();
}
發送圖片消息的示例代碼為:
String localImagePath;
try {
AVIMImageMessage message = new AVIMImageMessage(localImagePath);
conversation.sendMessage(message, new AVIMConversationCallback() {
@Override
public void done(AVException e) {
if (null != e) {
// 出錯了。。。
} else {
}
}
});
} catch (Exception ex) {
}
接收到這樣消息之後,開發者可以獲取到若干圖片元數據(width,height,圖片 size,圖片 format)和一個包含圖片數據的 AVFile 對象。
音頻消息(AVIMAudioMessage)
AVIMTypedMessage 子類,支持發送語音和附帶文本的混合消息,其聲明為:
復制代碼 代碼如下:
public class AVIMAudioMessage extends AVIMFileMessage {
public AVIMAudioMessage();
public AVIMAudioMessage(String localPath) throws FileNotFoundException, IOException;
public AVIMAudioMessage(File localFile) throws FileNotFoundException, IOException;
public AVIMAudioMessage(AVFile file);
/**
* 獲取文件的metaData
*
* @return
*/
@Override
public Map<String, Object> getFileMetaData();
/**
* 獲取音頻的時長
*
* @return
*/
public double getDuration();
}
發送音頻消息的示例代碼為:
復制代碼 代碼如下:
String localAudioPath;
try {
AVIMAudioMessage message = new AVIMAudioMessage(localAudioPath);
conversation.sendMessage(message, new AVIMConversationCallback() {
@Override
public void done(AVException e) {
if (null != e) {
// 出錯了。。。
} else {
}
}
});
} catch (Exception ex) {
}
接收到這樣消息之後,開發者可以獲取到若干音頻元數據(時長 duration、音頻 size,音頻 format)和一個包含音頻數據的 AVFile 對象。
視頻消息(AVIMVideoMessage)
AVIMTypedMessage 子類,支持發送視頻和附帶文本的混合消息,其聲明為:
復制代碼 代碼如下:
public class AVIMVideoMessage extends AVIMFileMessage {
public AVIMVideoMessage();
public AVIMVideoMessage(String localPath) throws FileNotFoundException, IOException;
public AVIMVideoMessage(File localFile) throws FileNotFoundException, IOException;
public AVIMVideoMessage(AVFile file);
/**
* 獲取文件的metaData
*
* @return
*/
@Override
public Map<String, Object> getFileMetaData();
/**
* 獲取時長
*
* @return
*/
public double getDuration();
}
發送視頻消息的示例代碼為:
復制代碼 代碼如下:
String localVideoPath;
try {
AVIMVideoMessage message = new AVIMVideoMessage(localVideoPath);
conversation.sendMessage(message, new AVIMConversationCallback() {
@Override
public void done(AVException e) {
if (null != e) {
// 出錯了。。。
} else {
}
}
});
} catch (Exception ex) {
}
接收到這樣消息之後,開發者可以獲取到若干視頻元數據(時長 duration、視頻 size,視頻 format)和一個包含視頻數據的 AVFile 對象。
地理位置消息(AVIMLocationMessage)
AVIMTypedMessage 子類,支持發送地理位置信息和附帶文本的混合消息,其聲明為:
復制代碼 代碼如下:
public class AVIMLocationMessage extends AVIMTypedMessage {
public String getText();
public void setText(String text);
public Map<String, Object> getAttrs();
public void setAttrs(Map<String, Object> attr);
public AVGeoPoint getLocation();
public void setLocation(AVGeoPoint location);
}
要發送位置消息的示例代碼為:
復制代碼 代碼如下:
AVIMLocationMessage message = new AVIMLocationMessage();
message.setText("快點過來!");
message.setLocation(new AVGeoPoint(15.9, 56.4));
conversation.sendMessage(message, new AVIMConversationCallback() {
@Override
public void done(AVException e) {
if (null != e) {
// 出錯了。。。
} else {
}
}
});
接收到這樣的消息之後,開發者可以獲取到具體的地理位置數據。
如何接收富媒體消息
新版 LeanCloud IM SDK 內部封裝了對富媒體消息的支持,所有富媒體消息都是從 AVIMTypedMessage 派生出來的。發送的時候可以直接調用 conversation.sendMessage 函數。在接收端,我們也專門增加了一類回調接口:
復制代碼 代碼如下:
public class AVIMTypedMessageHandler<T extends AVIMTypedMessage> extends MessageHandler<T> {
@Override
public void onMessage(T message, AVIMConversation conversation, AVIMClient client);
@Override
public void onMessageReceipt(T message, AVIMConversation conversation, AVIMClient client);
}
開發者可以編寫自己的消息處理 handler,然後調用 AVIMMessageManager.registerMessageHandler(Class<? extends AVIMMessage> clazz, MessageHandler<?> handler) 函數來注冊目標 handler。
LeanCloud IM SDK 內部消息分發的邏輯是這樣的:對於收到的任一新消息,SDK 內部都會先解析消息的類型,根據類型找到開發者為這一類型注冊的處理 handler,然後逐一調用這些 handler 的 onMessage 函數。如果沒有找到專門處理這一類型消息的 handler,就會轉交給 defaultHandler 處理。
這樣一來,在開發者為 TypedMessage(及其子類) 指定了專門的 handler,也指定了全局的 defaultHandler 了的時候,如果發送端發送的是通用的 AVIMMessage 消息,那麼接受端就是 AVIMMessageManager.registerDefaultMessageHandler()中指定的 handler 被調用;如果發送的是 AVIMTypedMessage(及其子類)的消息,那麼接受端就是 AVIMMessageManager.registerMessageHandler()中指定的 handler 被調用。
接收端對於富媒體消息的通知處理代碼片段如下:
復制代碼 代碼如下:
class MsgHandler extends AVIMTypedMessageHandler {
@Override
public void onMessage(AVIMTypedMessage message, AVIMConversation conversation, AVIMClient client) {
getInstance().onMessage(conversation, message);
}
@Override
public void onMessageReceipt(AVIMTypedMessage message, AVIMConversation conversation, AVIMClient client) {
getInstance().onMessageDelivered(message);
}
}
MsgHandler msgHandler = new MsgHandler();
AVIMMessageManager.registerMessageHandler(AVIMTypedMessage.class, msgHandler);
如何擴展自己的富媒體消息
繼承於 AVIMTypedMessage,開發者也可以擴展自己的富媒體消息,這一部分屬於高階內容,大家有興趣可以參看這篇文檔,這裡不再贅述。
群組聊天
與前面的單聊類似,群組聊天也需要先建立一個對話(AVIMConversation),然後發送、接收新的消息。
創建群組
和單聊類似,建立一個多人聊天的群組也是很簡單的。例如:
復制代碼 代碼如下:
Map<String, Object> attr = new HashMap<String, Object>();
attr.put("type", ConversationType_Group);
imClient.createConversation(clientIds, attr, new AVIMConversationCreatedCallback() {
@Override
public void done(AVIMConversation conversation, AVException e) {
if (null != conversation) {
// 成功了!
}
}
});
成功之後,我們就可以進入聊天界面了。
往群組發送消息
發送消息非常簡單,與前面單聊的場景一樣。
我們會注意到,AVIMConversation 還有一個發送消息的方法:
復制代碼 代碼如下:
public void sendMessage(final AVIMMessage message, final int messageFlag,
final AVIMConversationCallback callback)
而這裡 flag 的定義有如下三種類型:
暫態消息(AVIMConversation.TRANSIENT_MESSAGE_FLAG)。這種消息不會被自動保存(以後在歷史消息中無法找到它),也不支持延遲接收,離線用戶更不會收到推送通知,所以適合用來做控制協議。譬如聊天過程中「某某正在輸入中...」這樣的狀態信息,就適合通過暫態消息來發送。
普通消息(AVIMConversation.NONTRANSIENT_MESSAGE_FLAG)。這種消息就是我們最常用的消息類型,在 LeanCloud 雲端會自動保存起來,支持延遲接收和離線推送,以後在歷史消息中可以找到它。
待回執消息(AVIMConversation.RECEIPT_MESSAGE_FLAG)。這也是一種普通消息,只是消息被對方收到之後 LeanCloud 服務端會發送一個回執通知給發送方(這就是 AVIMMessageHandler 中 public void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client) 函數被調用的時機)。
接收群組消息
接收一個群組的消息,與接收單聊的消息也是一樣的。
成員管理
在查詢到聊天室成員之後,可以讓用戶邀請一些自己的朋友加入,作為管理員也可以剔除一些「可怕」的成員。
加入新成員的 API 如下:
復制代碼 代碼如下:
List<String> userIds = new ArrayList<String>();
userIds.add("A");
userIds.add("B");
userIds.add("C");
conversation.addMembers(userIds, new AVIMConversationCallback() {
@Override
public void done(AVException error) {
if (null != error) {
// 加入失敗,報錯.
} else {
// 發出邀請,此後新成員就可以看到這個對話中的所有消息了。
}
}
});
邀請成功以後,通知的流程是這樣的:
操作者(管理員) 被邀請者 其他人
1, 發出請求 addMembers
2, 收到 onInvited 通知
3, 收到 onMemberJoined 通知 收到 onMemberJoined 通知 收到 onMemberJoined 通知
相應地,踢人時的調用 API 是:
復制代碼 代碼如下:
List<String> userIds = new ArrayList<String>();
userIds.add("A");
conversation.kickMembers(userIds, new AVIMConversationCallback() {
@Override
public void done(AVException error) {
if (null != error) {
// 失敗,報錯.
} else {
// 成功。
}
}
});
踢人的通知流程如下:
操作者(管理員) 被踢者 其他人
1, 發出請求 kickMembers
2, 收到 onKicked 通知
3, 收到 onMemberLeft 通知 收到 onMemberLeft 通知
注意!
如果邀請、踢人操作發生的時候,被邀請者/被踢者當前不在線,那麼通知消息並不會被離線緩存,所以他們再上線的時候將不會收到通知。
獲取歷史消息
LeanMessage 會將非暫態消息自動保存在雲端,之後開發者可以通過 AVIMConversation 來獲取該對話的所有歷史消息。獲取歷史消息的 API 如下:
復制代碼 代碼如下:
String oldestMsgId;
long oldestMsgTimestamp;
conversation.queryMessages(oldestMsgId,oldestMsgTimestamp, limit, new AVIMHistoryMessageCallback(){
@Override
public void done(List<AVIMMessage> messages, AVException e) {
if (null != e) {
// 出錯了:(
} else {
// 成功
}
}
});
注意:
獲取歷史消息的時候,LeanCloud 雲端是從某條消息開始,往前查找開發者指定的 N 條消息,返回給客戶端。為此,獲取歷史消息需要傳入三個參數:起始消息的 msgId,起始消息的發送時間戳,需要獲取的消息條數。
通過這一 API 拿到的消息就是 AVIMMessage 或者 AVIMTypedMessage 實例數組,開發者可以像之前收到新消息通知一樣處理。
啟用離線消息推送(僅對 iOS 平台用戶有效)
不管是單聊還是群聊,當用戶 A 發出消息後,如果目標對話中有部分用戶當前不在線,LeanCloud 雲端可以提供離線推送的方式來提醒用戶。這一功能默認是關閉的,你可以在 LeanCloud 應用控制台中開啟它。開啟方法如下:
登錄 LeanCloud 應用控制台,選擇正確的應用進入;
選擇最頂端的「消息」服務,依次點擊左側菜單「實時消息」->「設置」;
在右側「iOS 用戶離線時的推送內容」下填好你要推送出去的消息內容,保存;
這樣 iOS 平台上的用戶就可以收到 Push Notification 了(當然,前提是應用本身申請到了 RemoteNotification 權限,也將正確的推送證書上傳到了 LeanCloud 控制台)。
群組消息免打擾(僅對 iOS 平台用戶有效)
不管是單聊還是群聊,對於發往普通的 Conversation 的普通消息,如果接收方當前不在線,LeanCloud 雲端支持通過 Push Notification 的方式進行提醒。一般情況下這都是很好的,但是如果某個群組特別活躍,那離線用戶就會收到過多的推送,會形成不小的干擾。
對此 LeanCloud IM 服務也允許單個用戶來關閉/打開某個對話的離線推送功能。調用 API 如下:
復制代碼 代碼如下:
if (open) {
[_conversation muteWithCallback:^(BOOL succeeded, NSError *error) {
...
}];
} else {
[_conversation unmuteWithCallback:^(BOOL succeeded, NSError *error) {
...
}];
}
搜索群組
不管是單聊,還是群聊,在 LeanCloud IM SDK 裡面都是對話(Conversation)。我們給對話設置了如下幾種屬性:
conversationId,字符串,對話 id,只讀,對話創建之後由 LeanCloud 雲端賦予一個全局唯一的 id。
creator,字符串,對話創建者 id,只讀,標識對話創建者信息
members,數組,對話參與者,這裡記錄了所有的參與者
name,字符串,對話的名字,optional,可用來對於群組命名
attributes,Map/Dict,自定義屬性,optional,供開發者自己擴展用。
我們提供了專門的類,來搜索特定的群組。例如要搜索當前登錄用戶參與的所有群聊對話,其代碼為
復制代碼 代碼如下:
List<String> clients = new ArrayList<String>();
clients.add("Tom");
AVIMConversationQuery conversationQuery = imClient.getQuery();
conversationQuery.containsMember(clients);
// 之前有常量定義:
// const int ConversationType_OneOne = 0;
// const int ConversationType_Group = 1;
conversationQuery.whereEqualTo("attr.type", ConversationType_Group);
conversationQuery.findInBackground(new AVIMConversationQueryCallback(){
@Override
public void done(List<AVIMConversation> conversations, AVException e) {
if (null != e) {
// 出錯了。。。
} else {
// done!
}
}
});
AVIMConversationQuery 中設置條件的方法與 AVQuery 類似,具體可以參看其頭文件。這裡要強調的一點是,對於自定義屬性的約束條件,屬性名一定要以 attr 開頭。
開放聊天室
開放聊天室(也叫暫態對話)可以用於很多地方,譬如彈幕、直播等等。在 LeanCloud IM SDK 中,開放聊天室是一類特殊的群組,它也支持創建、加入/踢出成員等操作,消息記錄會被保存並可供獲取;與普通群組不一樣的地方具體體現為:
不支持查詢成員列表,你可以通過相關 API 查詢在線人數;
不支持離線消息、離線推送通知等功能;
沒有成員加入、離開的通知;
一個用戶一次登錄只能加入一個開放聊天室,加入新的開放聊天室後會自動離開原來的聊天室;
加入後半小時內斷網重連會自動加入原聊天室,超過這個時間則需要重新加入;
創建開放聊天室
和普通的群組類似,建立一個開放聊天室也是很簡單的,只是在 AVIMClient.createConversation(conversationMembers, name, attributes, isTransient, callback) 中我們需要傳入 isTransient=true 選項。例如:
復制代碼 代碼如下:
Map<String, Object> attr = new HashMap<String, Object>();
attr.put("type", ConversationType_Group);
imClient.createConversation(clientIds, name, attr, true, new AVIMConversationCreatedCallback() {
@Override
public void done(AVIMConversation conversation, AVException e) {
if (null != conversation) {
// 成功了!
}
}
});
加入成功之後,我們就可以進入聊天界面了。開放聊天室的其他操作,都與普通群組操作一樣。
查詢在線人數
通過 AVIMConversation.getMemberCount() 方法可以實時查詢開放聊天室的在線人數。示例代碼如下:
復制代碼 代碼如下:
conversation.getMemberCount(new AVIMConversationMemberCountCallback(){
@Override
public void done(Integer memberCount, AVException e) {
if (null != e) {
// 出錯了:(
} else {
// 成功,此時 memberCount 的數值就是實時在線人數
}
}
});
簽名和安全
為了滿足開發者對權限和認證的要求,LeanCloud 還設計了操作簽名的機制。我們可以在 LeanCloud 應用控制台中的「設置」->「應用選項」->「聊天推送」下面勾選「聊天服務簽名認證」來啟用簽名(強烈推薦這樣做)。啟用後,所有的用戶登錄、對話創建/加入、邀請成員、踢出成員等操作都需要驗證簽名,這樣開發者就可以對消息進行充分的控制。
客戶端這邊究竟該如何使用呢?我們只需要實現 SignatureFactory 接口,然後在用戶登錄之前,把這個接口的實例賦值給 AVIMClient 即可(AVIMClient.setSignatureFactory(factory))。
設定了 signatureFactory 之後,對於需要鑒權的操作,LeanCloud IM SDK 與服務器端通訊的時候都會帶上應用自己生成的 Signature 信息,LeanCloud 雲端會使用 app 的 masterKey 來驗證信息的有效性,保證聊天渠道的安全。
對於 SignatureFactory 接口,我們只需要實現這兩個函數即可:
復制代碼 代碼如下:
/**
* 實現一個基礎簽名方法 其中的簽名算法會在SessionManager和AVIMClient(V2)中被使用
*
* @param peerId
* @param watchIds
* @return
* @throws SignatureException 如果簽名計算中間發生任何問題請拋出本異常
*/
public Signature createSignature(String peerId, List<String> watchIds) throws SignatureException;
/**
* 實現AVIMConversation相關的簽名計算
*
* @param conversationId
* @param clientId
* @param targetIds 操作所對應的數據
* @param action 操作
* @return
* @throws SignatureException 如果簽名計算中間發生任何問題請拋出本異常
*/
public Signature createConversationSignature(String conversationId, String clientId,
List<String> targetIds, String action) throws SignatureException;
createSignature 函數會在用戶登錄的時候被調用,createConversationSignature 會在對話創建/加入、邀請成員、踢出成員等操作時被調用。
你需要做的就是按照前文所述的簽名算法實現簽名,其中 Signature 聲明如下:
復制代碼 代碼如下:
public class Signature {
public List<String> getSignedPeerIds();
public void setSignedPeerIds(List<String> signedPeerIds);
public String getSignature();
public void setSignature(String signature);
public long getTimestamp();
public void setTimestamp(long timestamp);
public String getNonce();
public void setNonce(String nonce);
}
其中四個屬性分別是:
signature 簽名
timestamp 時間戳,單位秒
nonce 隨機字符串 nonce
signedPeerIds 放行的 clientId 列表,v2 中已經廢棄不用
下面的代碼展示了基於 LeanCloud 雲代碼進行簽名時,客戶端的實現片段:
復制代碼 代碼如下:
public class KeepAliveSignatureFactory implements SignatureFactory {
@Override
public Signature createSignature(String peerId, List<String> watchIds) {
Map<String,Object> params = new HashMap<String,Object>();
params.put("self_id",peerId);
params.put("watch_ids",watchIds);
try{
Object result = AVCloud.callFunction("sign",params);
if(result instanceof Map){
Map<String,Object> serverSignature = (Map<String,Object>) result;
Signature signature = new Signature();
signature.setSignature((String)serverSignature.get("signature"));
signature.setTimestamp((Long)serverSignature.get("timestamp"));
signature.setNonce((String)serverSignature.get("nonce"));
return signature;
}
}catch(AVException e){
throw (SignatureFactory.SignatureException) e;
}
return null;
}
@Override
public Signature createConversationSignature(String convId, String peerId, List<String> targetPeerIds,String action){
Map<String,Object> params = new HashMap<String,Object>();
params.put("self_id",peerId);
params.put("group_id",convId);
params.put("group_peer_ids",targetPeerIds);
params.put("action",action);
try{
Object result = AVCloud.callFunction("group_sign",params);
if(result instanceof Map){
Map<String,Object> serverSignature = (Map<String,Object>) result;
Signature signature = new Signature();
signature.setSignature((String)serverSignature.get("signature"));
signature.setTimestamp((Long)serverSignature.get("timestamp"));
signature.setNonce((String)serverSignature.get("nonce"));
return signature;
}
}catch(AVException e){
throw (SignatureFactory.SignatureException) e;
}
return null;
}
}
LeanCloud IM SDK 專注做好底層的通訊服務,有更多可以定制化的地方,譬如說:
賬戶系統和 IM 系統是分離的;
消息變成離線推送的時候,推送內容開發者是可以定制的;
通過 web hook,開發者可以對消息進行更多處理;
聊天過程中通過消息鑒權機制,開發者可以有更多控制;
因為缺少 UI 組件,實事求是地講在新用戶接入成本可能稍高,但是在業務規模擴大、產品需求變多之後,相信大家會越來越喜歡 LeanCloud 這種自由靈活的使用體驗,以及穩定迅捷的服務質量。
以上所述就是本文的全部內容了,希望大家能夠喜歡。
請您花一點時間將文章分享給您的朋友或者留下評論。我們將會由衷感謝您的支持!
你以為頭像更換很容易?或許對於用戶來講,在微信上更換一個頭像只是點擊頭像,選擇拍照或相冊,裁剪返回而已。但是對於程序員來說,要實現其實也挺吃力的(小火柴花了一個下午整理~
我們在選購安卓手機的時候,參數中最容易犯暈的就是ROM和RAM了,許多朋友都不了解是什麼意思,廠家也借助這一點來大做文章,下面我就給大家來簡單的介紹一下其中
好久沒有寫博客了,最近都在忙。有時候即使是有時間也會很懶,就會想玩一玩,放松放松!一直都沒有什麼時間更新我這個菜鳥的博客了。不過今天不一樣,我要給大家講講怎麼實現許多ap
1. 功能介紹1.1 Android Universal Image LoaderAndroid Universal Image Loader 是一個強大的、可高度定制的