给最后用户提供联合的选拔体验,发表实时通讯(IM)服务之后

简介

自2018年 LeanCloud
公布实时通讯(IM)服务之后,基于用户反馈和工程师对须求的消化和对事情的提炼,上周正规文告了「实时通信2.0
」。设计意见一如既往是「灵活、解耦、可构成、可定制」,具体能够参见《实时通讯支出指南》,了解LeanCloud 实时通讯的基本概念和模型。

LeanMessage 移动支付
SDK 是由 LeanCloud
提供的,专为 iOS、Android 和 WindowsPhone® 等客户端程序提供使用内聊天的
API 和劳务,并且也提供了 JavaScript
API,方便开发者打通网页和客户端应用,给最终用户提供统一的利用体验。使用
LeanMessage
API,您能够十分的快地以最少工作量让您的运动使用支撑实时聊天,得到1种如微信一般的维系体验。

下载和装置

可以到 LeanCloud
官方下载点下载
LeanCloud IM SDK v二 版本。将下载到的 jar 包参与工程即可。

始于在此以前
由于本文的目标,作者要是您曾经不行熟谙使用 JSON、Android 和 Eclipse
进行活动选用编制程序的基本概念。在您持续读书本文在此以前,请访问 leancloud.cn
并创造您的应用程序。只需依据注册页面中的不难指令即可。

万分的文件聊天

作者们先从最简便易行的环节动手,看看怎么用 LeanCloud IM SDK v二落到实处1对一文本聊天。

本文介绍了蕴藏单聊、群聊、历史记录和应用鉴权的主干 API
类。您将学习怎么着不难进行用户间一对壹单聊,以及如何创设群组让多用户进行群聊,还有啥通过签订契约来对聊天通道举办控制,以爱惜利用和用户的隐衷。示例均创设于
LeanMessage SDK for Android
之上(请参阅Android开发指南)。

初始化

和 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>

接下去我们需求做到用户登录。

基本概念和类

登录

若是聊天发起方名称叫 汤姆,为直观起见,我们运用用户名来作为 clientId
登录聊天系统(LeanCloud 云端只须要 clientId
在行使内唯一即可,具体用哪些数据由应用层决定),代码如下:

AVIMClient imClient = AVIMClient.getInstance("Tom");
imClient.open(new IMClientCallback(){
  @Override
  public void done(AVIMClient client, AVException e) {
    if (null != e) {
      // 出错了,可能是网络问题无法连接 LeanCloud 云端,请检查网络之后重试。
      // 此时聊天服务不可用。
      e.printStackTrace();
    } else {
      // 成功登录,可以开始进行聊天了(假设为 MainActivity)。
      Intent intent = new Intent(currentActivity, MainActivity.class);
      currentActivity.startActivity(intent);
    };
  }
});

闲谈参与者 Peer

在 LeanMessage 实时音讯世界中,每二个参与者(壹般而言是「人」)皆以一个Peer。Peer 拥有一个在使用内唯一标识本人的 ID(称为
PeerID,字符串类型,长度不抢先 50
字节,具体数值由运用自个儿明确),系统中的每一条新闻都来源于于1个Peer,发送到多少个或八个 Peer。并且,LeanMessage 的新闻服务允许贰个 Peer
在八个例外装备上登录,也允许三个装置上还要登录多个Peer,毕竟该怎么运用,由使用依据使用境况温馨采用。

此地要留心的是,PeerID 是由使用开发者自身賦值的,LeanMessage
自己并从未任何强制供给,所以:

  • 实时新闻系统是足以和用户账户种类解耦合的,应用开发者不必要把除了
    PeerID 以外的任何消息报告 LeanMessage;
  • LeanMessage 在音讯转发的时候是依照 PeerID
    来唯一定位的,因而1旦运用本身接济同壹账户的多点登录,那么
    LeanMessage 就会把音讯通告到拥有终端;
  • 匿名聊天/非匿名聊天那都是应用层本身决定的,如果选拔自个儿能为匿名用户钦点1个唯一的
    ID,那么那个用户参预到聊天系统里来,是一心没不常常的。

为了防止纷扰,贰个 Peer
须要先关怀(watch)了对方才能给对方发送消息;因为 LeanMessage
提供了更细粒度的权位控制,应用开发者能够在关怀(watch)动作上加码签名来保管安全性。那或多或少后头会进展详尽说明。

建立对话

假诺大家要跟「鲍伯」这一个用户展开聊天,我们先创立三个会话,代码如下:

List<String> clientIds = new ArrayList<String>();
clientIds.add("Tom");
clientIds.add("Bob");

// 我们给对话增加一个自定义属性 type,表示单聊还是群聊
// 常量定义:
// int ConversationType_OneOne = 0; // 两个人之间的单聊
// int ConversationType_Group = 1;  // 多人之间的群聊
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) {
      // 成功了,这时候可以显示对话的 Activity 页面(假定为 ChatActivity)了。
      Intent intent = new Intent(this, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      startActivity(intent);
    }
  }
});

树立的「对话」在控制台怎么查看

如你所见,大家创造八个会话的时候,钦点了成员(汤姆 和
Bob)和贰个外加的性能({type: 0})。那个数量保存到云端后,你在
控制台 -> 存储 -> 数据 里面会看到,_Conversation
表中追加了一条记下,新记录的 m 属性值为["Tom", "Bob"]attr
属性值为{"type":0}。如你所料,m 属性就是对应着成员列表,attr
属性正是用户扩大的额外属性值(以目的的款型储存)。

实时消息 AVMessage

在 LeanMessage 中具备的音信都是 AVMessage 的实例,AVMessage
只协理文件,并且长度不能够超过5KB。新闻分为暂态(transient)和持久音讯二种档次。全数持久新闻都会在
LeanMessage
云端保存,所以用户离线之后也足以拿走关照和接到,而暂态音信并不会离线保存,适合开发者用来开始展览协商决定。

AVMessage 的定义如清单 一 所示:

public class AVMessage implements Parcelable {
  private List<String> toPeerIds; // 消息接收方的 PeerID,支持一个或多个

  String groupId; // 消息所属群组的ID,对于普通一对一聊天消息而言,此值为空
  String message; // 消息体
  long timestamp; // 消息发送时间戳
  boolean isTransient; // 是否是暂态消息
  String fromPeerId; // 消息发送方的 PeerID

  public AVMessage();
  public AVMessage(String message);
  public AVMessage(String message, List<String> toPeerIds, boolean isTransient);
  public AVMessage(String message, boolean isTransient);
}

LeanMessage
为有着历史音信都提供了仓库储存和询问的功能,存款和储蓄时间则依照开发者的品类有所分歧。

出殡音讯

建立好对话之后,要发送新闻是很简短的:

AVIMMessage message = new AVIMMessage();
message.setContent("hello");
conversation.sendMessage(message, new AVIMConversationCallback() {
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      Logger.d("发送成功,msgId=" + message.getMessageId());
    }
  }
});

好了,那样一条消息就发送过去了。但是难题来了,对于「Bob」而言,他怎么才能吸收接纳外人发给他的音讯吧?

聊天会话 Session

每叁个 Peer 通过开启(open)三个对话(Session)而参加实时新闻服务,Peer
能够在三个会话中关心(watch)四个或多少个Peer,当被关切者上下线时,会收到通告。Peer
在打开对话后只好向友好关心的其余 Peers 发送音讯,但足以接过任何 Peer
发来的音讯,也等于说单向关切时,信息能够万事大吉地由关怀者发往被关心者。

Session 有如下三种情景:

  • opened。 Session 被不奇怪打开,此时能够举行正规的通讯;
  • pause。 网络特别(譬如 wifi 断开,三G/二G 切换,iOS
    应用进入后台,等),Session 进入暂停状态,当互连网苏醒时,Session
    会自动重连;
  • resume。 应用转入前台,会话重新树立起来(此情景只在 iOS 设备上有效性)
  • closed。 Session 截至,仅在体现调用了 Session.close
    方法时才会生出。用户注销实时通信服务,不再能够收到到新闻或推送通告;

Session 上得以实行的操作有:

  • open 以一个 Peer ID 打开 Session
  • watch 关切壹组 Peer ID,关怀后能够吸收接纳那些 Peer
    的上下线公告,发送音讯
  • unwatch 撤废对1组 Peer ID 的关注
  • sendMessage 给1组 Peer ID 发送消息
  • queryOnlinePeer 查找当前在线的 Peers
  • getHistoryMessageQuery 查找历史消息
  • setSignatureFactory 设置签名类(为了确定保证卫安全全性,前面会讲述)
  • close 注销服务,关闭 Session

新闻接收

在 鲍伯 这1端,要能接收到消息,须求如下几步:

一,举办初叶化;

二,实现协调的 AVIMMessageHandler,响应新音信到达文告,首假设之类函数:

public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client);

对于 汤姆 发过来的音信,要展现出来,大家只需兑现 onMessage
即可,示例代码如下:

class CustomMessageHandler extends AVIMMessageHandler {
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 新消息到来了。在这里增加你自己的处理代码。
    String msgContent = message.getContent();
    Logger.d(conversation.getConversationid() + " 收到一条新消息:" + msgContent);
  }
}

三,举办登录,代码也与发送端1样。

完整代码如下:

// 自定义消息响应类
class CustomMessageHandler extends AVIMMessageHandler {
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 新消息到来了。在这里增加你自己的处理代码。
    String msgContent = message.getContent();
    Logger.d(conversation.getConversationid() + " 收到一条新消息:" + msgContent);
  }
}

// application 的初始化部分
public void onCreate(){
  ...
  AVOSCloud.initialize(this,"{{appId}}","{{appKey}}");
  AVIMMessageManager.registerDefaultMessageHandler(new CustomMessageHandler());
  ...
}

// 用户登录部分
AVIMClient imClient = AVIMClient.getInstance("Bob");
imClient.open(new IMClientCallback(){
  @Override
  public void done(AVIMClient client, AVException e) {
    if (null != e) {
      // 出错了,可能是网络问题无法连接 LeanCloud 云端,请检查网络之后重试。
      // 此时聊天服务不可用。
      e.printStackTrace();
    } else {
      // 成功登录,可以开始进行聊天了。
    };
  }
});

注意!
AVIMMessageManager.registerDefaultMessageHandler() 一定要在
AVIMClient.open() 从前调用,否则可能导致服务器发回去的1对新闻丢失。

卓殊的文书聊天

略知1二了那三个概念之后,大家就能够初步进入实际聊天环节了。

先是大家必要在 application 的 onCreate 函数中开始展览 LeanCloud
最主题的发轫化:

@Override
public void onCreate() {
  super.onCreate();
  AVOSCloud.initialize(this, "pleaseReplaceWithYourAppId", "pleaseReplaceWithYourAppKey");
}

接下去大家来看一下怎么着进行一定的大旨聊天。首先,大家供给打开3个会话(Session),示例代码如清单
2 所示:

SessionManager session = SessionManager.getInstance(selfId);//获取SessionManager实例,以便于后续的操作。这里的 selfId 可以是用户的实际 id,也可以是其他唯一的字符串,譬如「Tom」。
List<String> watchedIds = new LinkedList<String>();
session.open(watchedIds); //打开Session,同时关注一些 PeerID。此时没有关注对象

注意!

诚如而言,会话的打开是在用户登录之后的 RootActivity
中展开的。对于支撑匿名聊天的运用,也能够在 Application
运营的时候实行。千万不要在四个临时或短暂的 Activity
中开启聊天会话。下边代码中 SessionManager 也是 Session
的子类,所以可以一向调用 Session 的办法。

接下去,大家初步跟「鲍勃」那一个用户展开聊天。为了给他发送消息,大家先要关怀(watch)他,代码如下:

List<String> peerIds = new LinkedList<String>();
peerIds.add("Bob");
session.watchPeers(peerIds);

之后大家给「鲍伯」发送一条新闻:

List<String> peerIds = new LinkedList<String>();
peerIds.add("Bob");
session.sendMessage(new AVMessage("嗨,你好,我是 Tom", peers, false));

好了,那样一条消息就发送过去了。然而难点来了,对于「Bob」而言,他怎么才能吸收接纳外人发给他的新闻啊?

下边对于 Session 的具备操作都以异步的。与一般 Android
异步方法调用不相同,LeanMessage SDK 的异步并不是通过 Callback 或许类似
PRADOsyncTask 的建制落到实处的,而是通过一而再 AVMessageReceiver 这一BoardcastReceiver,完毕以下方式来处理来自服务器端的响应的。AVMessageReceiver
接口定义如清单 三 所示:

/**
 * 当服务器成功与客户端打开session时产生本次回调
 */
public abstract void onSessionOpen(Context context, Session session);

/**
 * 在 session 暂停时调用,一般都是由网络连接丢失导致的隐性调用
 */
public abstract void onSessionPaused(Context context, Session session);

/**
 * Session 恢复时,一般都是网络连接恢复以后的
 * 这个时候你可以处理一些由于网络异常导致的失败消息
 */
public abstract void onSessionResumed(Context context, Session session);

/**
 * 从某个Peer接收到消息时,会收到一次调用
 */
public abstract void onMessage(Context context, Session session,
        AVMessage msg);

/**
 * 服务器反馈消息已经成功发送时,会收到调用
 */
public abstract void onMessageSent(Context context, Session session,
        AVMessage msg);

/**
 * 在消息发送失败时,产生的调用 在这里你可以保存一下发送失败的消息以便未来重发
 */
public abstract void onMessageFailure(Context context, Session session,
        AVMessage msg);

/**
 * 当关注的一些peers上线时,产生的调用
 */
public abstract void onStatusOnline(Context context, Session session,
        List<String> peerIds);

/**
 * 当关注的一些peers下线时,产生的调用
 */
public abstract void onStatusOffline(Context context, Session session,
        List<String> peerIds);

/**
 * 当与服务器发生交互的过程中的任何错误,都在这里被返回
 */
public abstract void onError(Context context, Session session, Throwable e);

从地方接口的概念中,大家得以看看,要选择到外人发过来的音信,只须求响应
onMessage() 方法即可。代码示例如清单 四 所示:

public class CustomeMsgReceiver extends AVMessageReceiver {
    @Override
    public void onMessage(final Context context, Session session, AVMessage avMsg) {
        Logger.d("onMessage "+avMsg.getMessage());
        // 进行上层逻辑处理,譬如 UI 展示,或者消息提醒。
    }
}

// 在 AndroidManifest.xml 文件中声明这一 BoardcastReceiver。
<receiver android:name=".receiver.CustomeMsgReceiver">
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
        <action android:name="com.avoscloud.session.action" />
    </intent-filter>
</receiver>

多少个至关心重视要的回调接口

从上边的例证中得以见到,要吸收到外人给您发送的新闻,供给重载
AVIMMessageHandler 类。从 v二 版起始,LeanCloud IM SDK
大批量运用回调来申报操作结果,然则对于部分失落的新闻布告,则依旧选用接口来贯彻的,包蕴:

  • 日前互连网现身变化
  • 对话中有新的新闻
  • 对话中有新成员进入
  • 对话中有成员离开
  • 被约请参加某对话
  • 被踢出对话

LeanCloud IM SDK 内部使用了两种接口来响应这一个事件。

援救富媒体的闲聊音讯

地点的代码演示了什么样发送文书消息,不过今后的交互格局已经特别三种化,图片、语音、摄像已是非平时见的媒体类型。而从
AVMessage 的定义来看,只援救不当先 5KB 大小的文书,那么 LeanMessage
又怎样能帮衬富媒体的闲话音讯啊?

记得 LeanStorage 中的 AVFile 吗?
AVFile 是 LeanStorage
提供的非结构化数据存款和储蓄消除方案,能够让您的应用程序将二进制文件存款和储蓄到云端服务器中,并且自动提供
CDN
加快服务,能带给用户更敏捷的下载体验。比如大规模的文件类型图像文件、印象文件、音乐文件和其余其余贰进制数据都得以动用。具体表明能够瞻仰Android
开发文书档案

对于图片、语音、录制那类较大的非结构化数据,存款和储蓄到云端文件系统之后,在音信中发送
url 已是产业界惯例,并且 LeanMessage 中 AVMessage
类的概念并未分明音讯体是何等类型,所以大家能够足够利用那一恢弘空间,结合
AVFile 来发送、接收富媒体的闲谈新闻。落成情势如清单 5 所示:

AVFile file = AVFile.withAbsoluteLocalPath("test.jpg", Environment.getExternalStorageDirectory() + "/test.jpg");
file.saveInBackground(new SaveCallback() {
    // override
    public void done(AVException ex) {
        if (null != ex) {
            // error
        } else {
            // construct message body under json format.
            HashMap<String, Object> params = new HashMap<String, Object>();
            params.put("type", "image");
            params.put("context", "嗨,你好,我是 Tom");
            params.put("attachment", file.getUrl());

            List<String> peerIds = new LinkedList<String>();
            peerIds.add("Bob");
            session.sendMessage(new AVMessage(JSON.toJSONString(params), peers, false));
        }
    }
});

新本子的 LeanMessage SDK
会帮助富媒体音信,防止让每一种开发者都再次做类似的工作。

网络事件响应接口

最首要用来处理网络转移事件,接口定义在
AVIMClientEventHandler,主要函数为:

  /**
   * 实现本方法以处理网络断开事件
   */
  public abstract void onConnectionPaused(AVIMClient client);

  /**
   * 实现本方法以处理网络恢复事件
   */
  public abstract void onConnectionResume(AVIMClient client);

在互联网中断的情事下,全数的音信收发和对话操作都会产出难点。

通过 AVIMClient.setClientEventHandler(AVIMClientEventHandler handler)
能够设定全局的 Client伊芙ntHandler。

群组聊天

在推来推去的供给里,还有二个很关键的情景,正是群组聊天。以前方 AVMessage
的概念大家能够猜到,LeanMessage
应该是永葆群聊的,那实在该怎么样贯彻吗?上面我们一步一步来品尝一下。

对话成员变动响应接口

根本用于处理对话中成员变动的风浪,接口定义在
AVIMConversationEventHandler,首要函数为:

  /**
   * 实现本方法以处理聊天对话中的参与者离开事件
   *
   * @param members 离开的参与者
   * @param kickedBy 踢人者,自愿退出的情况下踢人者就是参与者
   */
  public abstract void onMemberLeft(AVIMClient client,
      AVIMConversation conversation, List<String> members, String kickedBy);

  /**
   * 实现本方法以处理聊天对话中的参与者加入事件
   *
   * @param members 加入的参与者
   * @param invitedBy 邀请人,有可能是加入的参与者本身
   */
  public abstract void onMemberJoined(AVIMClient client,
      AVIMConversation conversation, List<String> members, String invitedBy);

  /**
   * 实现本方法来处理当前用户被踢出某个聊天对话事件
   *
   * @param kickedBy 踢出你的人
   */
  public abstract void onKicked(AVIMClient client, AVIMConversation conversation,
      String kickedBy);

  /**
   * 实现本方法来处理当前用户被邀请到某个聊天对话事件
   *
   * @param conversation 被邀请的聊天对话
   * @param operator 邀请你的人
   */
  public abstract void onInvited(AVIMClient client, AVIMConversation conversation,
      String operator);

通过
AVIMMessageManager.setConversationEventHandler(AVIMConversationEventHandler handler)
可以安装全局的 Conversation伊夫ntHandler。

基本概念

与壹般的单聊比较,群聊扩展了如下五个基本概念:

  • 群组 AVGroup

AVGroup
代表四个聊天群组,能够对应到实际的五人聊天、聊天群、聊天室等,每个AVGroup 有一个唯一的 ID(groupID,由 LeanMessage
云端分配),其定义如清单 6 所示:

   public class AVGroup implements Group {
      String roomId;
      String selfId;
      Session session;
   }

七个 Peer
插足群后向群发送的消息能够被全数群成员接受。当有新成员参加可能既有成员退出时,全部群成员都会赢得公告。AVGroup
上得以开始展览的操作有:

public interface Group{
    public void join();
    public void sendMessage(AVMessage msg);
    public void kickMember(List<String> peerIds);
    public void inviteMember(List<String> peerIds);
    public void quit();
    public String getGroupId();
    public String getSelfId();
    public AVHistoryMessageQuery getHistoryMessageQuery();
}
  • 群组音信接受器 AVGroupMessageReceiver

与 AVMessageReceiver 类似,AVGroupMessageReceiver
首要用于处理群组操作的结果。其详细定义如清单 7 所示:

  /**
   *在加入聊天室成功后被调用 如果join时,没有带groupId,您可以在返回的group中间获取groupId
   */
  @Override
  public abstract void onJoined(Context context, Group group);

  /**
   * 当你被别人邀请进入某个聊天室以后
   * 
   * @param group
   * @param byPeerId
   *        这个人邀请了你
   */
  @Override
  public abstract void onInvited(Context context, Group group, String byPeerId);

  /**
   * 当你被别人踢出聊天室以后
   * 
   * @param group
   * @param byPeerId
   *            是他踢了你
   */
  @Override
  public abstract void onKicked(Context context, Group group, String byPeerId);

  /**
   * 处理消息发送成功事件
   */
  @Override
  public abstract void onMessageSent(Context context, Group group,
        AVMessage message);

  /**
   * 用来处理消息发送失败事件
   * 可以缓存起来,事后重发
   */
  @Override
  public abstract void onMessageFailure(Context context, Group group,
        AVMessage message);

  /**
   * 收到消息以后被调用
   * 一般通过这个接口来处理和接受来自Group的消息
   * @param context
   * @param group
   * @param message
   * @param fromPeerId
   *            发消息者
   */
  @Override
  public abstract void onMessage(Context context, Group group,
        AVMessage message);

  /**
   * 处理退出成功事件
   */
  @Override
  public abstract void onQuit(Context context, Group group);

  /**
   * 处理Group操作被拒绝的时间
   * @param context
   * @param group
   * @param op 这里可能存在的操作有 "join","invite","kick"
   * @param targetIds
   *            一般来说是指被操作的对象,在join操作中间就是指groupId本身,
   *            invite和kick中则指被邀请或者被踢除的peerIds
   */
  @Override
  public abstract void onReject(Context context, Group group, String op,
        List<String> targetIds);

  /**
   * 处理新用户加入事件
   */
  @Override
  public abstract void onMemberJoin(Context context, Group group,
        List<String> joinedPeerIds);

  /**
   * 处理用户退出事件
   */
  @Override
  public abstract void onMemberLeft(Context context, Group group,
        List<String> leftPeerIds);

  /**
   * 处理所有Group相关的异常
   */
  @Override
  public abstract void onError(Context context, Group group, Throwable e);

音讯响应接口

首要用以处理新音信到达事件,接口定义在
MessageHandlerAVIMMessageHandler
是二个空的达成类,我们理应经过重载 AVIMMessageHandler
的连带办法来成功新闻处理。首要的方式有:

  // 收到新的消息
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation);

  // 自己发送的消息已经被对方接收
  @Override
  public void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client);

通过 AVIMMessageManager.registerDefaultMessageHandler(handler)
可以安装全局的 MessageHandler。

咱俩落实那3类接口,就足以处理全部的文告音讯了。示例代码如下:

class CustomNetworkHandler extends AVIMClientEventHandler {
  @Override
  public void onConnectionPaused(AVIMClient client) {
    // 请按自己需求改写
    Logger.d("connect paused");
  }

  @Override
  public void onConnectionResume(AVIMClient client) {
    // 请按自己需求改写
    Logger.d("connect resume");
  }
}

class CustomConversationHandler extends AVIMConversationEventHandler {
  public private Context gContext = null;
  private void toast(String str) {
    Toast.makeText(gContext, str, Toast.LENGTH_SHORT).show();
  }
  private void toast(Context context, String str) {
    Toast.makeText(context, str, Toast.LENGTH_SHORT).show();
  }

  @Override
  public void onMemberLeft(AVIMClient client, AVIMConversation conversation, List<String> members, String kickedBy) {
    // 请按自己需求改写
    toast(MsgUtils.nameByUserIds(members) + " left, kicked by " + MsgUtils.nameByUserId(kickedBy));
    //注:MsgUtils 是一个辅助类,nameByUserIds 用来将 userId 转换成用户名
  }

  @Override
  public void onMemberJoined(AVIMClient client, AVIMConversation conversation, List<String> members, String invitedBy) {
    // 请按自己需求改写
    toast(MsgUtils.nameByUserIds(members) + " joined , invited by " + MsgUtils.nameByUserId(invitedBy));
    //注:MsgUtils 是一个辅助类,nameByUserIds 用来将 userId 转换成用户名
  }

  @Override
  public void onKicked(AVIMClient client, AVIMConversation conversation, String kickedBy) {
    // 请按自己需求改写
    toast("you are kicked by " + MsgUtils.nameByUserId(kickedBy));
  }

  @Override
  public void onInvited(AVIMClient client, AVIMConversation conversation, String operator) {
    // 请按自己需求改写
    toast("you are invited by " + MsgUtils.nameByUserId(operator));
  }
};

class CustomMsgHandler extends AVIMMessageHandler {
  @Override
  public void onMessage(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 请按自己需求改写
    String msgContent = message.getContent();
    Logger.d(conversation.getConversationid() + " 收到一条新消息:" + msgContent);
  }

  @Override
  public void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client) {
    // 请按自己需求改写
    Logger.d("发往对话 " + conversation.getConversationid() + " 的消息 "+ message.getMessageId() +" 已被接收");
  }
}

// 设置事件响应接口
AVIMClient.setClientEventHandler(new CustomNetworkHandler());
AVIMMessageManager.setConversationEventHandler(new CustomConversationHandler());
AVIMMessageManager.registerDefaultMessageHandler(new CustomMsgHandler());

进入聊天室

鉴于整个实时通讯功用都是树立在 Session
的基本功上,所以大家要进入一个聊天室也亟需建立在二个早就开辟的 Session
上。 已经打开贰个 Session 未来,能够经过以下操作来投入三个 Group:

    Group group = SessionManager.getInstance(selfId).getGroup();//准备新建一个聊天室
    //Group group = SessionManager.getInstance(selfId).getGroup(groupId); 加入一个已经存在的聊天室
    group.join(); // LeanMessage 云端会判断 groupId 是否存在,如果不存在就新建一个 Group,否则加入已有 Group

投入成功之后 AVGroupMessageReceiver 子类中的 onJoined 方法就会被调用。

支持富媒体的谈天音信

上面包车型大巴代码演示了如何发送简单文本音讯,可是今后的交互情势已经尤其各类化,图像、语音、录制已是很是普遍的新闻类型。v2版的 LeanCloud IM SDK 已经得以很好地支持这一个富媒体音信,具体表达如下:

往聊天室发送新闻

发送新闻至极简单,通过如下代码就能够向特定聊天室发送新闻了:

    Group group = SessionManager.getInstance(selfId).getGroup(groupId);
    group.sendMessage(new AVMessage("hello world"));

发送成功未来,AVGroupMessageReceiver 子类中的 onMessageSent
方法会被调用,反之则 onMessageFailure 方法会被调用。

基类: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);
}

收到聊天室新闻

接到叁个聊天室的音讯,与吸纳单聊的音信未有差距于,供给开发者实现AVGroupMessageReceiver 接口,并在 AndroidManifest.xml
中登记即可,如代码清单 8 所示:

public class CustomeGroupMsgReceiver extends AVGroupMessageReceiver {
    ...
    @Override
    public void onMessage(final Context context, Group group, AVMessage avMsg) {
        Logger.d("onMessage "+avMsg.getMessage());
        // 进行上层逻辑处理,譬如 UI 展示,或者消息提醒。
    }
    ...
}

// 在 AndroidManifest.xml 文件中声明这一 BoardcastReceiver。
<receiver android:name=".receiver.CustomeGroupMsgReceiver">
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
        <action android:name="com.avoscloud.session.action" />
    </intent-filter>
</receiver>

文本音讯(AVIMTextMessage)

AVIMTypedMessage 子类,表示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);
}

可以看出,对于文本新闻,首要的属性有 textattr 几个,通过简单的
getter/setter 就足以访问到。要发送文书消息,示例代码为:

AVIMTextMessage message = new AVIMTextMessage();
message.setText("hello");
conversation.sendMessage(message, new AVIMConversationCallback() {
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      Logger.d("message sent.");
    }
  }
});

询问聊天室成员

在加盟三个聊天室之后,大家首先步就是看看有怎么样人在这几个群组里面。LeanMessage
和 LeanStorage 是组成在联合的,通过采用 LeanStorage
的数码存款和储蓄功用,来保存叁个聊天室的主导新闻(表名:AVOSRealtimeGroups),在
LeanStorage 应用管理平台的多少基本,大家能够看看 AVOSRealtimeGroups
的具备字段。

LeanStorage
的数目主导
LeanStorage
也是 LeanCloud
平台的主干服务之壹,提供了使用内数据和文书数量的贮存功用。对于使用内数据,LeanStorage
帮衬 schema free 的积存,开发者不必要事先定义数据的格局,只要符合 JSON
格式的 Object 都得以随心所欲存款和储蓄到 LeanStorage 云端。同时,LeanStorage
也提供八个 Web
版的多寡管理界面,能够充裕有利于地增、删、改、查任何数据。

本来,在大家领略3个聊天室的 groupId 的时候,也能够在代码中,通过
AVObject 的 fetch 接口来查阅这一个聊天室的组员情状,代码如清单 九 所示:

    AVObject groupObject = AVObject.createWithoutData("AVOSRealtimeGroups",groupId);
    groupObject.fetch();//如果您在UI进程中,请使用异步方法调用
    List groupMembers= groupObject.getList("m");

预防系统线程阻塞!
想起一下,在移动应用程序中,长日子的操作(如互连网、文件或长的盘算)不该在主系统线程上成功。相反,应在二个独立的办事线程中执行它们。阻塞系统线程会对应用程序的用户界面的响应能力发生负面影响,有非常大希望造成强行关闭您的应用程序。

文件音信(AVIMFileMessage)

AVIMTypedMessage
子类,用来发送带附属类小部件的音信,开发者能够用它来发送「离线文件」。对于此类信息,LeanCloud
IM SDK 内部会先把公文上传到 LeanCloud 文件存款和储蓄服务器(自带 CDN
作用),然后把公文元数据(url,文件大小等等)放在消息包内发送到
LeanCloud 实时通讯服务端。其构造函数注脚为:

// 传入本地文件路径,构造消息对象
public AVIMFileessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMFileMessage(File localFile) throws FileNotFoundException, IOException;
// 传入 AVFile 实例,构造消息对象
public AVIMFileMessage(AVFile file);

与公事音信看似,文件音信也支撑附带文本和其余自定义属性,能够通过如下方法添加
/ 获取更加多音信:

  • String getText() / void setText(String text)
  • Map<String, Object> getAttrs() / void setAttrs(Map<String,
    Object> attr);

发送文书信息的演示代码为:

String localZipfilePath;
try {
  AVIMFileMessage message = new AVIMFileMessage(localZipfilePath);
  message.setText("这是你要的文档");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

收到到那般音信随后,开发者可以由此以下方法,获取到文件元数据(size
等)和二个包蕴2进制数据的 AVFile 对象:

  • AVFile getAVFile() 方法会重返三个二进制文件的 AVFile
    实例,之后方可经过 AVFile 来形成多少下载或许别的操作,具体能够参见
    AVFile
    说明
  • String getFileUrl() 方法会重临2进制文件的 url
  • long getSize() 方法会再次回到二进制文件的实际尺寸(单位:byte)
  • Map<String, Object> getFileMetaData()
    能够收获贰进制文件的任何元数据信息。

分子管理

在查询到聊天室成员之后,可以让用户诚邀一些要好的对象进入,作为管理员也能够去除一些「可怕」的成员。代码如清单
拾 所示:

    Group group = SessionManager.getInstance(selfId).getGroup(groupId);
    List<String> toInvite = Arrays.asList("peerId1","peerId2","peerId3");
    group.inviteMember(toInvite);
    List<String> toKickOff = Arrays.asList("badBoy1","badBoy2");
    group.kickMembers(toKickOff);

特约成功今后,文告的流水生产线是如此的:

    操作者(管理员)                           被邀请者                        其他人
1,发出请求 inviteMember
2,AVGroupMessageReceiver.onInvited
3,                                      AVGroupMessageReceiver.onJoined
4,AVGroupMessageReceiver.onMemberJoin                          AVGroupMessageReceiver.onMemberJoin

相应地,踢人的流程如下:

    操作者(管理员)                           被踢者                         其他人
1,发出请求 kickMember
2,AVGroupMessageReceiver.onKicked
3,                                    AVGroupMessageReceiver.onQuit
4,AVGroupMessageReceiver.onMemberLeft                         AVGroupMessageReceiver.onMemberLeft

图像音讯(AVIMImageMessage)

AVIMFileMessage
子类,专门用来发送图像和附带文本的交集音信,其构造函数注明为:

// 传入本地文件路径,构造消息对象
public AVIMImageMessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMImageMessage(File localFile) throws FileNotFoundException, IOException;
// 传入 AVFile 实例,构造消息对象
public AVIMImageMessage(AVFile file);

出殡图像消息的以身作则代码为:

String localImagePath;
try {
  AVIMImageMessage message = new AVIMImageMessage(localImagePath);
  message.setText("你说我好看不?");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

接到到这样音信之后,开发者能够经过如下方法,获取到几何图像元数据(width,height,图像
size)和二个涵盖图像数据的 AVFile 对象:

  • int getWidth() 方法会重临图像的上升幅度(单位:pixel)
  • int getHeight() 方法会重临图像的惊人(单位:pixel)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会重返3个图像文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会重返图像文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会重返图像文件的骨子里尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会再次来到随图像壹起发送的文件音信。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)能够拿走图像的任何元数据音讯。

询问历史音信

LeanMessage 会将非暂态音信自动保存在云端,之后开发者能够经过
AVHistoryMessageQuery 那么些指标来进展询问。AVHistoryMessageQuery
定义如清单 1一 所示:

public class AVHistoryMessageQuery {
    int limit;
    String convid;
    String from;
    long timestamp;

    /**
     * 设置查询返回集合的大小
     * 默认100,最大1000
     */
    public void setLimit(int limit);

    /**
     * 设定聊天的发起人是谁
     */
    public void setFrom(String from);

    /**
     * 设置查询从哪个时间开始的聊天记录
     */
    public void setTimestamp(long timestamp);

    /**
     * 指定聊天记录查询条件中,聊天发送的对象条件
     */
    public void setPeerIds(List<String> peerIds);

    /**
     * 同步方法查询聊天记录
     * 请确保在一个异步方法中调用此方法,否则会出现UI线程中的网络请求而导致的UI卡死
     */
    public List<AVHistoryMessage> find() throws AVException;

    /**
     * 异步方法查询聊天记录
     */
    public void findInBackground(HistoryMessageCallback callback);

    /**
     * 此接口为异步查询聊天记录的回调类
     */
    public static interface HistoryMessageCallback;
}

经过 AVHistoryMessageQuery 查询获得的结果是
AVHistoryMessage,该类的定义如清单 1二 所示:

public class AVHistoryMessage extends AVMessage {
    /**
     * 查看是否属于聊天室聊天记录
     */
    public boolean isRoom();

    /**
     * 查看聊天记录所在的conversation Id,对于 Group 来说等于 GroupID,对于单聊来说,是内部生成的一个值。
     */
    public String getConvid();
}

聊天记录的查询的为主措施跟 AVQuery 类似可是略有不一致。 针对 Session
的聊天记录和聊天室 Group
的聊天记录查询略有区别,不过基本流程是一致(代码清单 1二):

       String selfId = "Tom";
       SessionManager sm = SessionManager.getInstance(selfId);
       List<String> peers = new ArrayList<String>();
       peers.add(selfId);
       peers.add("Bob");
       AVHistroyMessageQuery sessionHistoryQuery = sm.getHistroyMessageQuery();
       sessionHistoryQuery.setLimit(100);  //设置查询结果大小
       sessionHistoryQuery.setPeerIds(peers); // 设置单聊的参与方,多个参与者之间是「与」的关系
       sessionHistoryQuery.setTimestamp(1413184345686);  //查询时间片1413184345686以前的聊天记录
       sessionHistoryQuery.findInBackground(new HistoryMessageCallback() {
             @Override
             public void done(List<AVHistoryMessage> messages, AVException error) {
                  System.out.println(messages.size());
             }
       });//查询session里的聊天记录

       Group group = sm.getGroup("140a534fd092809500e6d651e73400c7");
       AVHistroyMessageQuery groupHistoryQuery = group.getHistoryMessageQuery();//获取AVHistoryMessageQuery对象来查询聊天室的聊天记录
       groupHistoryQuery.findInBackground(new HistoryMessageCallback(){
            @Override
            public void done(List<AVHistoryMessage> messages,AVException error){
              for(AVHistoryMessage msg:messages){
                 System.out.println(msg.getMessage());
              }
            }
       })

地点第贰个查询会获得「汤姆」和「Bob」在特定时间点从前的 100
条聊天记录;第三个查询会得到一定聊天室的拥有聊天记录(假诺总数不超越1000 条的话)。

旋律消息(AVIM奥迪(Audi)oMessage)

AVIMFileMessage
子类,专门用来发送语音和附带文本的混杂新闻,其构造函数注脚为:

// 传入本地文件路径,构造消息对象
public AVIMAudioMessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMAudioMessage(File localFile) throws FileNotFoundException, IOException;   
// 传入 AVFile 实例,构造消息对象
public AVIMAudioMessage(AVFile file);

发送音频音讯的以身作则代码为:

String localAudioPath;
try {
  AVIMAudioMessage message = new AVIMAudioMessage(localAudioPath);
  message.setText("听听我唱的小苹果:)");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

吸收接纳到这么新闻随后,开发者能够经过如下方法,获取到多少音频元数据(时长duration、音频 size)和三个富含音频数据的 AVFile 对象:

  • double getDuration() 方法会再次来到音频的长度(单位:秒)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会再次来到三个音频文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会再次回到音频文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会再次回到音频文件的实际上尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会再次回到随音频一起发送的公文音讯。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)能够拿到音频的其余元数据音信。

放眼查看全体聊天室

翻看全部聊天室的法子和查阅单个聊天室成员的法子类似,都以一贯通过 AVQuery
依然 AVObject 来遍历 AVOSRealtimeGroups 表完毕的,这里不再赘言。

摄像音讯(AVIMVideoMessage)

AVIMFileMessage
子类,专门用来发送录像和附带文本的混杂音讯,其构造函数评释为:

// 传入本地文件路径,构造消息对象
public AVIMVideoMessage(String localPath) throws FileNotFoundException, IOException;
// 传入本地文件,构造消息对象
public AVIMVideoMessage(File localFile) throws FileNotFoundException, IOException;
// 传入 AVFile 文件,构造消息对象
public AVIMVideoMessage(AVFile file);

出殡录像音信的演示代码为:

String localVideoPath;
try {
  AVIMVideoMessage message = new AVIMVideoMessage(localVideoPath);
  message.setText("敢不敢跟我比一比");
  conversation.sendMessage(message, new AVIMConversationCallback() {
    @Override
    public void done(AVException e) {
      if (null != e) {
        // 出错了。。。
        e.printStackTrace();
      } else {
        Logger.d("message sent");
      }
    }
  });
} catch (Exception ex) {
}

收下到如此信息之后,开发者能够可以因而如下方法,获取到几何录像元数据(时长duration、录像 size)和3个含有摄像数据的 AVFile 对象:

  • double getDuration() 方法会重回摄像的长短(单位:秒)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会重临二个录像文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会重回录制文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会再次来到录像文件的实际尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会重回随录像壹起发送的公文信息。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)能够获得录制的别样元数据音信。

聊天记录和新余

前方实现了单聊、群聊、富媒体聊天诸多意义,不过开发者恐怕早就意识了,那都是一向调用
LeanMessage SDK
来促成的,对于我们开发者来说,能控制的东西很少,在安全性上会存在1些顾虑。譬如:万1不怀好意的人破解了自作者的
appId 和 appKey,是否就足以在自个儿的扯淡社区内部胡作非为?

为了满意开发者对权力和认证的供给,LeanMessage
还布置了操作签名的建制。大家得以在 LeanCloud
应用控制台、设置、应用选项中强制启用签名(强烈推荐那样做)。启用后,全体的
Session open 和 watch
行为都亟待注解签名,那样开发者就能够对用户登录以及他得以关注如何人,进而能够给哪个人发新闻实行足够的主宰。

签名采取 Hmac-sha壹 算法,输出字节流的十陆进制字符串 (hex
dump),签名的音信格式如下:

app_id:peer_id:watch_peer_ids:timestamp:nonce

其中:

  • app_id 是你的行使 ID
  • peer_id 是开拓此 Session 的 Peer ID
  • watch_peer_ids 是 open 或 watch 请求中关心的 peer
    ids,升序排序后以: 分隔
  • timestamp 是现阶段的 UTC 时间距离 unix epoch 的秒数
  • nonce 为随机字符串

在群组操作中,LeanMessage
对加群、约请和踢出群那八个动作也允许参预签名,它的签订契约格式是:

app_id:peer_id:group_id:group_peer_ids:timestamp:nonce:action

其中:

  • app_id, peer_id, timestamp 和 nonce 同上
  • group_id 是此次作为涉嫌的群组 ID,对于开创群尚未有 id
    的动静,group_id 是空字符串
  • group_peer_ids 是: 分隔的升序排序的 peer id,即诚邀和踢出的
    peer_id;对插足群的情事,这里是空字符串
  • action 是此次行为的动作,二种表现分别对应常量 join, invite 和 kick

签约的 key 是行使的 master key。开发者能够兑现协调的
SignatureFactory,调用远程的服务器的签字接口获得签名。倘若未有团结的服务器,能够一向在
LeanCloud 的云代码上经过 Web Hosting
动态接口实现和谐的签署接口。在活动选用中从来做签名是生命垂危的,它恐怕引致您的
master key 泄漏。

LeanCloud 的 appKey 分类
在 LeanCloud 平台上申请了动用之后,LeanCloud 会分配给大家五个key:二个 appKey,八个 master Key。在这之中 appKey
能够实行一些普通的操作,并且受到 LeanCloud
平台安全设置的限量,类似于操作系统中的普通 User
账号,所以能够一直用在客户端;master Key
则怀有有着权力,类似于操作系统中的 Root/Administrator
账号,所以请伏贴保管。

好,有了署名机制之后,我们终究该怎么着利用啊?大家只须求贯彻和谐的
SignatureFactory,然后在拉开 session 的时候,把这么些 signatureFactory
传进去即可。示例代码如清单 13 所示:

// Signature 定义如下,由 LeanMessage 提供
public class Signature {
    private String signature;
    private long timestamp;
    private String nonce;
    private List<String> signedPeerIds;

    // getter / setter for properties
    ......
}
// customise signature factory,由开发者实现
public MySignatureFactory implements SignatureFactory {
    @override
    public Signature createSignature(String selfId, List<String> watchIds) {
        // call remote server for correct signature.
    }
   @override
    public Signature createGroupSignature(String groupId, String selfId, List<String> targetPeerIds,
  String action) {
        // call remote server for correct group signature.
    }
}

// open session with signature factory.
SignatureFactory signatureFacatory = new MySignatureFactory();
SessionManager sm = SessionManager.getInstance(selfId);
sm.setSignatureFactory(signatureFactory);
sm.open(selfId);

设定了 SignatureFactory 之后,对于供给鉴权的操作,LeanMessage SDK
与劳务器端通信的时候都会带上应用本身生成的 Signature 音信,那样
LeanMessage 服务器端就会利用 app 的 masterKey
来证实消息的得力,保障聊天渠道的铁岭。

地理地方消息(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);
}

与公事信息看似,地理地方消息只是扩张了3个 AV吉优Point 的 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) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      Logger.d("message sent");
    }
  }
});

收下到这么的新闻随后,开发者能够收获到实际的地理地点数据。

结束语

LeanMessage
是叁个百般稳定可相信的闲聊服务平台,提供的职能也得以知足大家应用开发者的供给。这里本身透过介绍
LeanMessage API 来兑现应用内的单聊、群聊、富媒体新闻等基本功效,可是LeanMessage 还帮助更多高阶功用,譬如 Super
Peer、敏感词过滤、音讯实时监听等等,有趣味的爱侣能够继续深究。

何以接受富媒体消息

新版 LeanCloud IM SDK 内部封装了对富媒体新闻的支撑,全数富媒体音讯都是从
AVIMTypedMessage 派生出来的。发送的时候能够直接调用
conversation.sendMessage()
函数。在接收端,咱们也越发增添了1类回调接口
AVIMTypedMessageHandler,其定义为:

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。

接收端对于富媒体音信的关照处理的演示代码如下:

class MsgHandler extends AVIMTypedMessageHandler<AVIMTypedMessage> {

  @Override
  public void onMessage(AVIMTypedMessage message, AVIMConversation conversation, AVIMClient client) {
    // 请按自己需求改写
    switch(message.getMessageType()) {
    case AVIMReservedMessageType.TextMessageType:
      AVIMTextMessage textMsg = (AVIMTextMessage)message;
      Logger.d("收到文本消息:" + textMsg.getText() + ", msgId:" + textMsg.getMessageId());
      break;
    case AVIMReservedMessageType.FileMessageType:
      AVIMFileMessage fileMsg = (AVIMFileMessage)message;
      Logger.id("收到文件消息。msgId=" + fileMsg.getMessageId() + ", url=" + fileMsg.getFileUrl() + ", size=" + fileMsg.getSize());
      break;
    case AVIMReservedMessageType.ImageMessageType:
      AVIMImageMessage imageMsg = (AVIMImageMessage)message;
      Logger.id("收到图片消息。msgId=" + imageMsg.getMessageId() + ", url=" + imageMsg.getFileUrl() + ", width=" + imageMsg.getWidth() + ", height=" + imageMsg.getHeight());
      break;
    case AVIMReservedMessageType.AudioMessageType:
      AVIMAudioMessage audioMsg = (AVIMAudioMessage)message;
      Logger.id("收到音频消息。msgId=" + audioMsg.getMessageId() + ", url=" + audioMsg.getFileUrl() + ", duration=" + audioMsg.getDuration());
      break;
    case AVIMReservedMessageType.VideoMessageType:
      AVIMVideoMessage videoMsg = (AVIMAudioMessage)message;
      Logger.id("收到视频消息。msgId=" + videoMsg.getMessageId() + ", url=" + videoMsg.getFileUrl() + ", duration=" + videoMsg.getDuration());
      break;
    case AVIMReservedMessageType.LocationMessageType:
      AVIMLocationMessage locMsg = (AVIMLocationMessage)message;
      Logger.id("收到位置消息。msgId=" + locMsg.getMessageId() + ", latitude=" + locMsg.getLocation().getLatitude() + ", longitude=" + locMsg.getLocation().getLongitude());
      break;
    }
  }

  @Override
  public void onMessageReceipt(AVIMTypedMessage message, AVIMConversation conversation, AVIMClient client) {
  }
}
MsgHandler msgHandler = new MsgHandler();
AVIMMessageManager.registerMessageHandler(AVIMTypedMessage.class, msgHandler);

LeanCloud IM SDK 内部音讯分发的逻辑是那样的:对于收到的任壹新音信,SDK
内部都会先解析音讯的门类,依照项目找到开发者为那壹档次注册的处理
handler,然后挨家挨户调用那么些 handler 的 onMessage
函数。假设未有找到专门处理那1连串音信的 handler,就会传送给
defaultHandler 处理。

那样壹来,在开发者为 TypedMessage(及其子类) 钦定了专门的
handler,也钦赐了大局的 defaultHandler
了的时候,假若发送端发送的是通用的 AVIMMessage 音讯,那么接受端就是
AVIMMessageManager.registerDefaultMessageHandler()中内定的 handler
被调用;借使发送的是 AVIMTypedMessage(及其子类)的新闻,那么接受端就是
AVIMMessageManager.registerMessageHandler()中钦赐的 handler 被调用。

怎么着扩充自身的富媒体音信

接轨于
AVIMTypedMessage,开发者也足以扩大自身的富媒体音讯。其供给和步骤是:

  • 贯彻新的消息类型,继承自 AVIMTypedMessage。那里需求注意两点:
    • 在 class 上扩张2个 @AVIMMessageType(type=12三) 的
      Annotation,具体音信类型的值(123)由开发者本身支配(LeanCloud
      内建的消息类型应用负数,全数正数都留给给开发者扩大使用)。
    • 在音讯内部属性上要追加 @AVIMMessageField(name=””) 的
      Annotation,name
      为可选字段在表明字段属性,同时自定义的字段要有相应的
      getter/setter 方法。
  • 调用
    AVIMMessageManager.registerAVIMMessageType(Class<? extends AVIMTypedMessage> messageType)
    函数进行项目注册
  • 调用
    AVIMMessageManager.registerMessageHandler(Class<? extends AVIMMessage> clazz, MessageHandler<?> handler)
    函数实行音信处理 handler 注册。

AVIMTextMessage 的源码如下,可供参考:

@AVIMMessageType(type = -1)
public class AVIMTextMessage extends AVIMTypedMessage {

  @AVIMMessageField(name = "_lctext")
  String text;
  @AVIMMessageField(name = "_lcattrs")
  Map<String, Object> attrs;

  public String getText() {
    return this.text;
  }

  public void setText(String text) {
    this.text = text;
  }

  public Map<String, Object> getAttrs() {
    return this.attrs;
  }

  public void setAttrs(Map<String, Object> attr) {
    this.attrs = attr;
  }
}

群组聊天

与眼下的单聊类似,群组聊天也急需先创设多少个会话(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) {
      // 成功了!
      Intent intent = new Intent(currentActivity, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      currentActivity.startActivity(intent);
    }
  }
});

得逞以后,大家就足以进入聊天界面了。

往群组发送新闻

出殡消息格外不难,与前方单聊的现象1样。

小编们会小心到,AVIMConversation 还有2个出殡和埋葬信息的艺术:

public void sendMessage(final AVIMMessage message, final int messageFlag,
      final AVIMConversationCallback callback)

而那边 flag 的概念有如下3体系型:

  • 暂态音信(AVIMConversation.TRANSIENT_MESSAGE_FLAG)。那种新闻不会被自动保存(未来在历史新闻中不能找到它),也不协助延迟接收,离线用户更不会吸纳推送公告,所以适合用来做控制协议。譬如聊天进度中「某某正在输入中…」那样的气象新闻,就适合通过暂态音信来发送。
  • 一般说来新闻(AVIMConversation.NONTRANSIENT_MESSAGE_FLAG)。那种音信正是大家最常用的音讯类型,在
    LeanCloud
    云端会自动保存起来,帮忙延迟接收和离线推送,现在在历史新闻中得以找到它。
  • 待回执音信(AVIMConversation.RECEIPT_MESSAGE_FLAG)。这也是一种常见信息,只是新闻被对方接收之后
    LeanCloud 服务端会发送二个回执通告给发送方(那正是AVIMMessageHandler 中
    public void onMessageReceipt(AVIMMessage message, AVIMConversation conversation, AVIMClient client)
    函数被调用的机会)。

收纳群组音信

采用贰个群组的新闻,与接收单聊的音讯也是同1的。

成员管理

在询问到聊天室成员之后,能够让用户特邀部分本人的意中人进入,作为管理员也能够去除一些「可怕」的成员。
加盟新成员的 API 如下:

// 假设需要邀请 Alex,Ben,Chad 三人加入对话
List<String> userIds = new ArrayList<String>();
userIds.add("Alex");
userIds.add("Ben");
userIds.add("Chad");
conversation.addMembers(userIds, new AVIMConversationCallback() {
  @Override
  public void done(AVException error) {
    if (null != error) {
      // 加入失败,报错.
      error.printStackTrace();
    } else {
      // 发出邀请,此后新成员就可以看到这个对话中的所有消息了。
      Logger.d("invited.");
    }
  }
});

敬请成功今后,相关方收到文告的时序是那般的:

    操作者(管理员)                    被邀请者                        其他人
1, 发出请求 addMembers
2,                               收到 onInvited 通知
3, 收到 onMemberJoined 通知      收到 onMemberJoined 通知      收到 onMemberJoined 通知

对应地,踢人时的调用 API 是:

List<String> userIds = new ArrayList<String>();
userIds.add("Alex");
conversation.kickMembers(userIds, new AVIMConversationCallback() {
  @Override
  public void done(AVException error) {
    if (null != error) {
      // 失败,报错.
      error.printStackTrace();
    } else {
      // 成功。
      Logger.d("kicked.");
    }
  }
});

踢人时,相关方收到通告的时序如下:

    操作者(管理员)                被踢者                       其他人
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 {
      // 成功,可以将消息加入缓存,同时更新 UI
    }
  }
});

注意:
获得历史音讯的时候,LeanCloud
云端是从某条音信开头,往前寻找开发者钦点的 N
条音信,重临给客户端。为此,获取历史新闻要求传入多少个参数:开始音信的
msgId,初叶音讯的出殡时间戳,供给获得的音信条数。

因此那壹 API 得到的消息正是 AVIMMessage 或然 AVIMTypedMessage
实例数组,开发者能够像从前收到新消息通知一致处理。

启用离线音信推送(仅对 iOS 平台用户有效)

无论是是单聊照旧群聊,当用户 A
发出音信后,假若指标对话中有局地用户近年来不在线,LeanCloud
云端能够提供离线推送的秘籍来提醒用户。那壹效果暗中认可是倒闭的,你能够在
LeanCloud 应用控制奥兰多拉开它。开启方法如下:

  • 登录 LeanCloud 应用控制台,选取正确的运用进入;
  • 选拔最上面的「信息」服务,依次点击左侧菜单「实时消息」->「设置」;
  • 在左侧「iOS
    用户离线时的推送内容」下填好你要推送出去的信息内容,保存;

那样 iOS 平台上的用户就能够吸收 Push Notification
了(当然,前提是应用本人申请到了 RemoteNotification
权限,也将正确的推送证书上传到了 LeanCloud 控制台)。

群组新闻免打扰(仅对 iOS 平台用户有效)

任由是单聊照旧群聊,对于发往普通的 Conversation
的家常新闻,假如接收方当前不在线,LeanCloud 云端协理通过 Push
Notification
的主意开始展览提示。壹般意况下那都是很好的,不过如若有些群组特别活跃,那离线用户就会收取过多的推送,会形成非常的大的打扰。

对此 LeanCloud IM 服务也允许单个用户来关闭/打开某些对话的离线推送功效。

检索群组

无论是单聊,依旧群聊,在 LeanCloud IM SDK
里面都以对话(Conversation)。我们给对话设置了之类二种属性:

  • conversationId,字符串,对话 id,只读,对话创设之后由 LeanCloud
    云端赋予二个大局唯1的 id。
  • creator,字符串,对话成立者 id,只读,标识对话创设者消息
  • members,数组,对话参预者,那里记录了独具的参加者
  • name,字符串,对话的名字,optional,可用来对于群组命名
  • attributes,Map/Dict,自定义属性,optional,供开发者自个儿扩张用。

我们提供了专门的类,来查找一定的群组:通过 imClient.getQuery()
得到2个 AVIMConversationQuery 实例,然后调用
AVIMConversationQuery.wherexxx
多元措施来增添约束规范。例如要寻找当前登录用户插足的保有群聊对话,其代码为

// 搜索 Tom 参与的所有群组对话
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) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      if (null != conversation) {
        Logger.d("找到了符合条件的 " + conversations.size() + " 个对话");
      } else {
        Logger.d("没有找到符合条件的对话");
      }
    }
  }
});

AVIMConversationQuery 中设置规范的法门与 AVQuery 类似。这里
conversationQuery.containsMember()
表示对话的分子中最少含有那些人口,可用来根据壹些成员查找对话;与此类似的还有3个
conversationQuery.withMembers()
则表示有且仅有这几个成员,用来根据全体成员查找目的对话;conversationQuery.whereXXX()
多级措施可用来限制对话名称和自定义属性,那里要强调的一点是,对于自定义属性的约束规范,属性名一定要以
attr 起头,如上例所示,限定额外的 type 条件的时候必要钦定的属性名是
attr.type。具体可以参考其头文件。

开放聊天室

开放聊天室(也叫暂态对话)能够用来很多地方,譬如弹幕、直播等等。在
LeanCloud IM SDK
中,开放聊天室是壹类格外的群组,它也支撑成立、加入/踢出成员等操作,音讯记录会被保存并可供获取;与平日群组差异等的地方具体浮现为:

  • 不补协助调查询成员列表,你能够经过相关 API 查询在线人数;
  • 不帮忙离线音信、离线推送文告等职能;
  • 从未成员进入、离开的公告;
  • 二个用户1遍登录只可以参与一个开放聊天室,参预新的盛开聊天室后会自动离开原先的聊天室;
  • 参加后半钟头内断网重连会活动进入原聊天室,超过这些时间则需求重新参预;

成立开放聊天室

和经常的群组类似,建立3个开放聊天室也是不会细小略的,只是在
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) {
      // 成功了,进入聊天室
      Intent intent = new Intent(currentActivity, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      currentActivity.startActivity(intent);
    }
  }
});

开创成功之后,咱们就足以进来聊天界面了。开放聊天室的别的操作,都与平常群组操作一样。

加入开放聊天室

假使任何极端用户都足以进入开放聊天室。作为开发者,我们得以因此通过特定条件检索到具备开放聊天室,然后允许用户自由进入,其出现说法代码为:

conversation.join(new AVIMConversationCallback(){
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了:(
    } else {
      // 成功,此时可以进入聊天界面了。。。
      Intent intent = new Intent(currentActivity, ChatActivity.class);
      Intent.putExtra(“conversation”, conversation);
      currentActivity.startActivity(intent);
    }
  }
});

询问在线人数

通过 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)中被使用
   */
  public Signature createSignature(String peerId, List<String> watchIds) throws SignatureException;

  /**
   * 实现AVIMConversation相关的签名计算
   */
  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 这种自由灵活的选用体验,以及稳定快速的劳务性能。

相关文章