给最后用户提供联合的选择体验,下周正规宣布了「实时通讯

简介

自二〇一八年 LeanCloud
发布实时通讯(IM)服务之后,基于用户举报和工程师对须求的消化和对事情的提炼,前一周专业公布了「实时通讯2.0
」。设计意见还是是「灵活、解耦、可结合、可定制」,具体能够参考《实时通信支出指南》,领悟LeanCloud 实时通讯的基本概念和模型。

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

下载和设置

可以到 LeanCloud
官方下载点下载
LeanCloud IM SDK v2 本子。将下载到的 jar 包参加工业程即可。

发端在此以前
是因为本文的目标,笔者假若您曾经尤其领悟使用 JSON、Android 和 Eclipse
举办移动使用编制程序的基本概念。在您持续阅读本文在此之前,请访问 leancloud.cn
并创办您的应用程序。只需遵从注册页面中的不难指令即可。

杰出的文本聊天

我们先从最简便的环节入手,看看怎么用 LeanCloud IM SDK v2
贯彻一对一文本闲谈。

正文介绍了蕴藏单聊、群聊、历史记录和接纳鉴权的中央 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 实时音信世界中,每三个参加者(一般而言是「人」)都以3个Peer。Peer 拥有一个在利用内唯一标识本人的 ID(称为
PeerID,字符串类型,长度不超过 50
字节,具体数值由使用自个儿分明),系统中的每一条音信都来自于一个Peer,发送到五个或多少个 Peer。并且,LeanMessage 的新闻服务允许三个 Peer
在多少个不等装备上登录,也允许一个装置上同时登录多少个Peer,毕竟该怎样运用,由使用依照使用处境温馨挑选。

此间要留心的是,PeerID 是由运用开发者自身賦值的,LeanMessage
本身并不曾任何强制供给,所以:

  • 实时音信系统是能够和用户账户类别解耦合的,应用开发者不须求把除了
    PeerID 以外的其它音讯告知 LeanMessage;
  • LeanMessage 在音讯转载的时候是比照 PeerID
    来唯一定位的,由此假设采取本身协理同一账户的多点登录,那么
    LeanMessage 就会把新闻公告到独具终端;
  • 匿名聊天/非匿名聊天那都以应用层本人决定的,假设采取自个儿能为匿名用户钦赐3个唯一的
    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);
    }
  }
});

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

如你所见,大家创设二个会话的时候,钦命了成员(Tom 和
鲍伯)和贰个附加的属性({type: 0})。这几个多太史存到云端后,你在
控制台 -> 存储 -> 数据 里面会合到,_Conversation
表中加进了一条记下,新记录的 m 属性值为["Tom", "Bob"]attr
属性值为{"type":0}。如你所料,m 属性便是对应着成员列表,attr
属性正是用户扩充的额外属性值(以目标的款式储存)。

实时信息 AVMessage

在 LeanMessage 中享有的音信都以 AVMessage 的实例,AVMessage
只支持文件,并且长度不能超过5KB。消息分为暂态(transient)和恒久新闻三种档次。全数持久音讯都会在
LeanMessage
云端保存,所以用户离线之后也足以收获通告和接到,而暂态音信并不会离线保存,适合开发者用来进展研讨决定。

AVMessage 的概念如清单 1 所示:

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());
    }
  }
});

好了,那样一条新闻就发送过去了。可是难点来了,对于「鲍伯」而言,他怎么才能接收外人发给她的音讯吧?

聊天会话 Session

每三个 Peer 通过开启(open)三个会话(Session)而参加实时新闻服务,Peer
能够在三个对话中关切(watch)七个或多个Peer,当被关心者上下线时,会吸收布告。Peer
在打开对话后不得不向和睦关心的其余 Peers 发送音讯,但还可以任何 Peer
发来的音信,也正是说单向关注时,音讯能够顺遂地由关心者发往被关注者。

Session 有如下二种处境:

  • opened。 Session 被不奇怪打开,此时得以拓展不荒谬的通讯;
  • pause。 网络特别(譬如 wifi 断开,3G/2G 切换,iOS
    应用进入后台,等),Session 进入暂停状态,当互连网苏醒时,Session
    会自动重连;
  • resume。 应用转入前台,会话重新创制起来(此情状只在 iOS 设备上有效)
  • closed。 Session 甘休,仅在体现调用了 Session.close
    方法时才会产生。用户注销实时通讯服务,不再尚可到消息或推送文告;

Session 上可以展开的操作有:

  • open 以一个 Peer ID 打开 Session
  • watch 关怀一组 Peer ID,关心后方可收到那几个 Peer
    的上下线公告,发送音信
  • unwatch 撤销对一组 Peer ID 的青睐
  • sendMessage 给一组 Peer ID 发送新闻
  • queryOnlinePeer 查找当前在线的 Peers
  • getHistoryMessageQuery 查找历史消息
  • setSignatureFactory 设置签名类(为了保险安全性,前边会讲述)
  • close 注销服务,关闭 Session

音讯接收

在 Bob 这一端,要能接收到信息,需求如下几步:

1,举行初叶化;

2,达成本身的 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);
  }
}

3,举办登录,代码也与发送端一样。

完全代码如下:

// 自定义消息响应类
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() 在此以前调用,不然大概造成服务器发回去的片段新闻丢失。

相当的文本聊天

领悟了那多个概念之后,大家就能够开端进入实际聊天环节了。

率先大家需求在 application 的 onCreate 函数中展开 LeanCloud
最中央的初叶化:

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

接下去大家来看一下怎么样举行一定的中坚聊天。首先,我们供给开启三个对话(Session),示例代码如清单
2 所示:

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

注意!

相似而言,会话的敞开是在用户登录之后的 RootActivity
中进行的。对于支持匿名聊天的利用,也得以在 Application
运维的时候实行。千万不要在3个目前或短暂的 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 也许类似
PAJEROsyncTask 的建制落实的,而是通过再而三 AVMessageReceiver 这一
BoardcastReceiver,完毕以下格局来处理来自服务器端的响应的。AVMessageReceiver
接口定义如清单 3 所示:

/**
 * 当服务器成功与客户端打开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() 方法即可。代码示例如清单 4 所示:

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 类。从 v2 版早先,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 有2个唯一的 ID(groupID,由 LeanMessage
云端分配),其定义如清单 6 所示:

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

3个 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。

大家完毕这三类接口,就足以处理全数的布告音信了。示例代码如下:

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
的功底上,所以大家要加盟一个聊天室也亟需树立在2个曾经打开的 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 子类,表示一般的文本新闻,其声称为

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.");
    }
  }
});

询问聊天室成员

在加盟2个聊天室之后,我们首先步便是探望有如何人在这些群组里面。LeanMessage
和 LeanStorage 是构成在协同的,通过动用 LeanStorage
的多寡存款和储蓄功用,来保存1个聊天室的骨干音信(表名:AVOSRealtimeGroups),在
LeanStorage 应用管理平台的数量大旨,大家得以见到 AVOSRealtimeGroups
的保有字段。

LeanStorage
的多少基本
LeanStorage
也是 LeanCloud
平台的着力服务之一,提供了选用内数据和文书数量的仓库储存作用。对于利用内数据,LeanStorage
扶助 schema free 的存款和储蓄,开发者不供给事先定义数据的情势,只要顺应 JSON
格式的 Object 都足以随意存款和储蓄到 LeanStorage 云端。同时,LeanStorage
也提供二个 Web
版的数目管理界面,能够十一分便利地增、删、改、查任何数据。

自然,在我们理解三个聊天室的 groupId 的时候,也得以在代码中,通过
AVObject 的 fetch 接口来查看那些聊天室的组员情况,代码如清单 9 所示:

    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
等)和贰个富含二进制数据的 AVFile 对象:

  • AVFile getAVFile() 方法会再次来到叁个二进制文件的 AVFile
    实例,之后方可因此 AVFile 来形成多少下载也许其余操作,具体能够参见
    AVFile
    说明
  • String getFileUrl() 方法会再次来到二进制文件的 url
  • long getSize() 方法会重回二进制文件的实际尺寸(单位:byte)
  • Map<String, Object> getFileMetaData()
    能够赢得二进制文件的其它元数据消息。

成员管理

在询问到聊天室成员之后,可以让用户特邀部分祥和的意中人进入,作为管理员也足以去除一些「可怕」的成员。代码如清单
10 所示:

    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)方法会重回三个图像文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会重临图像文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会再次回到图像文件的实际上尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会重回随图像一起发送的文件新闻。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)可以博得图像的别样元数据信息。

询问历史音信

LeanMessage 会将非暂态音讯自动保存在云端,之后开发者能够经过
AVHistoryMessageQuery 这一个目的来拓展查询。AVHistoryMessageQuery
定义如清单 11 所示:

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,该类的概念如清单 12 所示:

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

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

聊天记录的查询的核心格局跟 AVQuery 类似可是略有区别。 针对 Session
的聊天记录和聊天室 Group
的聊天记录查询略有不一致,但是基本流程是千篇一律(代码清单 12):

       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
条聊天记录;第一个查询会得到一定聊天室的享有聊天记录(即使总数不超越一千 条的话)。

旋律音信(AVIM奥迪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)和3个富含音频数据的 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
来贯彻的,对于我们开发者来说,能控制的东西很少,在安全性上会存在一些顾虑。譬如:万一不怀好意的人破解了自小编的
appId 和 appKey,是还是不是就可以在本人的拉拉扯扯社区里头横行霸道?

为了满足开发者对权力和注明的供给,LeanMessage
还计划了操作签名的建制。大家得以在 LeanCloud
应用控制台、设置、应用选项中强制启用签名(强烈推荐那样做)。启用后,全数的
Session open 和 watch
行为都要求注明签名,那样开发者就能够对用户登录以及他得以关怀如何人,进而可以给哪个人发新闻进行丰富的决定。

署名采纳 Hmac-sha1 算法,输出字节流的十六进制字符串 (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);
}

与公事新闻看似,地理地点音信只是充实了二个 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
是2个丰硕安静可信赖的闲谈服务平台,提供的功用也足以满意我们采纳开发者的急需。那里自身通过介绍
LeanMessage API 来贯彻应用内的单聊、群聊、富媒体新闻等基本效用,然而LeanMessage 还扶助更加多高阶功用,譬如 Super
Peer、敏感词过滤、消息实时监听等等,有趣味的爱人可以延续探索。

什么选拔富媒体新闻

新版 LeanCloud IM SDK 内部封装了对富媒体音讯的帮助,全数富媒体音信都是从
AVIMTypedMessage 派生出来的。发送的时候能够直接调用
conversation.sendMessage()
函数。在接收端,大家也尤其扩张了一类回调接口
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
函数。就算没有找到专门处理这一项目音讯的 handler,就会传送给
defaultHandler 处理。

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

什么样扩大本人的富媒体新闻

三番五次于
AVIMTypedMessage,开发者也得以扩张自身的富媒体音信。其须求和手续是:

  • 完结新的新闻类型,继承自 AVIMTypedMessage。这里必要专注两点:
    • 在 class 上平添1个 @AVIMMessageType(type=123) 的
      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;
  }
}

群组聊天

与前边的单聊类似,群组聊天也亟需先创制2个对话(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);
    }
  }
});

马到功成之后,我们就能够进来聊天界面了。

往群组发送新闻

发送音讯分外简单,与日前单聊的气象同样。

大家会专注到,AVIMConversation 还有1个发送消息的章程:

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 如下:

// 假设需要邀请 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
    云端赋予二个大局唯一的 id。
  • creator,字符串,对话创立者 id,只读,标识对话创制者新闻
  • members,数组,对话插手者,那里记录了具有的参预者
  • name,字符串,对话的名字,optional,可用来对于群组命名
  • attributes,Map/Dict,自定义属性,optional,供开发者本人扩展用。

大家提供了尤其的类,来查找一定的群组:通过 imClient.getQuery()
得到八个 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()
表示对话的分子中最少含有那些人口,可用来遵照一些成员查找对话;与此类似的还有1个
conversationQuery.withMembers()
则表示有且仅有这一个分子,用来根据全体成员查找目的对话;conversationQuery.whereXXX()
多重措施可用来界定对话名称和自定义属性,这里要强调的少数是,对于自定义属性的牢笼原则,属性名一定要以
attr 起始,如上例所示,限定额外的 type 条件的时候需求钦点的属性名是
attr.type。具体能够参考其头文件。

绽放聊天室

绽放聊天室(也叫暂态对话)能够用来很多地点,譬如弹幕、直播等等。在
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) {
      // 成功了,进入聊天室
      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 那种自由灵活的利用体验,以及稳定急速的劳务质量。

相关文章