选择也能促膝交谈

简介

自二〇一八年 LeanCloud
发表实时通讯(IM)服务之后,基于用户反映和工程师对供给的消化和对事情的提炼,下周标准发布了「实时通信贰.0
」。设计理念壹如既往是「灵活、解耦、可整合、可定制」,具体能够参考《实时通讯支出指南》,驾驭LeanCloud 实时通讯的基本概念和模型。

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

下载和设置

可以到 LeanCloud
官方下载点下载
LeanCloud IM SDK v二 本子。将下载到的 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 实时音信世界中,每多个参加者(一般而言是「人」)都以贰个Peer。Peer 拥有一个在选取内唯1标识本身的 ID(称为
PeerID,字符串类型,长度不超越 50
字节,具体数值由运用自己鲜明),系统中的每一条消息都出自于二个Peer,发送到3个或多少个 Peer。并且,LeanMessage 的音讯服务允许一个 Peer
在七个不等装备上登录,也同意二个设施上同时登录八个Peer,毕竟该怎么着使用,由运用根据使用境况温馨挑选。

此地要小心的是,PeerID 是由运用开发者自身賦值的,LeanMessage
本人并从未别的强制须求,所以:

  • 实时音讯系统是能够和用户账户体系解耦合的,应用开发者不必要把除了
    PeerID 以外的其余音信告诉 LeanMessage;
  • LeanMessage 在消息转载的时候是遵守 PeerID
    来唯一定位的,因而只要接纳自己协理同一账户的多点登录,那么
    LeanMessage 就会把信息公告到全体终端;
  • 匿名聊天/非匿名聊天那都是应用层自身主宰的,借使使用本身能为匿名用户钦点2个唯一的
    ID,那么那些用户参预到聊天系统里来,是完全未有毛病的。

为了预防滋扰,1个 Peer
必要先关怀(watch)了对方才能给对方发送新闻;因为 LeanMessage
提供了更细粒度的权杖控制,应用开发者能够在关心(watch)动作上增添签名来担保卫安全全性。那或多或少末尾会展开详细表达。

确立对话

要是大家要跟「Bob」这几个用户展开聊天,大家先创设2个会话,代码如下:

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 的概念如清单 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());
    }
  }
});

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

聊天会话 Session

每1个 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 裁撤对壹组 Peer ID 的钟情
  • sendMessage 给壹组 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);
  }
}

三,实行登录,代码也与发送端壹样。

总体代码如下:

// 自定义消息响应类
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");
}

接下去我们来看一下什么样举行1对壹的基本聊天。首先,大家须求敞开3个对话(Session),示例代码如清单
二 所示:

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

注意!

1般而言,会话的开启是在用户登录之后的 RootActivity
中举办的。对于协理匿名聊天的应用,也得以在 Application
运维的时候进行。千万不要在一个临时或短暂的 Activity
中打开聊天会话。下边代码中 SessionManager 也是 Session
的子类,所以能够一向调用 Session 的法门。

接下去,我们初步跟「鲍伯」那些用户展开聊天。为了给她发送消息,大家先要关切(watch)他,代码如下:

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

然后大家给「Bob」发送一条音讯:

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

好了,那样一条音信就发送过去了。不过难题来了,对于「鲍伯」而言,他怎么才能选拔外人发给她的音讯啊?

上面对于 Session 的享有操作都以异步的。与一般 Android
异步方法调用不一样,LeanMessage SDK 的异步并不是透过 Callback 也许类似
宝马X3syncTask 的机制落到实处的,而是经过再三再四 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() 方法即可。代码示例如清单 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 类。从 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。

群组聊天

在拉扯的需求里,还有3个很关键的场景,正是群组聊天。在此之前边 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。

基本概念

ca88官方会员登录,与平常的单聊相比较,群聊扩展了之类多少个基本概念:

  • 群组 AVGroup

AVGroup
代表1个聊天群组,能够对应到实在的多少人聊天、聊天群、聊天室等,种种AVGroup 有贰个唯一的 ID(groupID,由 LeanMessage
云端分配),其定义如清单 陆 所示:

   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
是1个空的贯彻类,大家理应通过重载 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
的基本功上,所以大家要参预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
中注册即可,如代码清单 八 所示:

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
的数据存款和储蓄功用,来保存3个聊天室的中央音信(表名:AVOSRealtimeGroups),在
LeanStorage 应用管理平台的数码主题,大家得以看到 AVOSRealtimeGroups
的兼具字段。

LeanStorage
的数量主导
LeanStorage
也是 LeanCloud
平台的主干服务之壹,提供了选用内数据和文书数量的储存作用。对于使用内数据,LeanStorage
补助 schema free 的贮存,开发者不供给事先定义数据的形式,只要符合 JSON
格式的 Object 都得以随心所欲存款和储蓄到 LeanStorage 云端。同时,LeanStorage
也提供三个 Web
版的多少管理界面,能够万分便于地增、删、改、查任何数据。

自然,在大家清楚多少个聊天室的 groupId 的时候,也得以在代码中,通过
AVObject 的 fetch 接口来查看那几个聊天室的组员情形,代码如清单 玖 所示:

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

防止系统线程阻塞!
忆起一下,在活动应用程序中,长日子的操作(如网络、文件或长的预计)不应该在主系统线程上形成。相反,应在1个单身的工作线程中实施它们。阻塞系统线程会对应用程序的用户界面包车型大巴响应能力发生负面影响,有希望导致强行关闭您的应用程序。

文本新闻(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() 方法会重回1个二进制文件的 AVFile
    实例,之后能够透过 AVFile 来成功数据下载也许别的操作,具体能够参见
    AVFile
    说明
  • String getFileUrl() 方法会重临2进制文件的 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)方法会重返3个图像文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会再次回到图像文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会重返图像文件的实际上尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会再次回到随图像1起发送的公文新闻。
  • 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
的聊天记录查询略有区别,可是基本流程是同等(代码清单 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());
              }
            }
       })

地点第壹个查询会得到「汤姆」和「鲍伯」在特定时间点之前的 100
条聊天记录;第3个查询会得到一定聊天室的保有聊天记录(借使总数不超越一千 条的话)。

节奏消息(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)和一个带有音频数据的 AVFile 对象:

  • double getDuration() 方法会重回音频的长短(单位:秒)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会再次回到七个音频文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会重返音频文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会再次来到音频文件的实在尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会重回随音频1起发送的公文消息。
  • 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)和三个带有录像数据的 AVFile 对象:

  • double getDuration() 方法会重临录制的长短(单位:秒)
  • AVFile getAVFile() (继承自
    AVIMFileMessage)方法会重临二个录制文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会重回摄像文件的
    url
  • long getSize() (继承自
    AVIMFileMessage)方法会再次回到录像文件的骨子里尺寸(单位:byte)
  • String getText() (继承自
    AVIMFileMessage)方法会再次回到随录制1起发送的文件新闻。
  • Map<String, Object> getFileMetaData() (继承自
    AVIMFileMessage)能够拿走录像的别的元数据消息。

聊天记录和定西

前面完结了单聊、群聊、富媒体聊天诸多效应,但是开发者也许曾经意识了,这都以一贯调用
LeanMessage SDK
来完毕的,对于大家开发者来说,能说了算的东西很少,在安全性上会存在部分担心。譬如:万1不怀好意的人破解了自家的
appId 和 appKey,是否就能够在自个儿的扯淡社区内部武断专行?

为了满意开发者对权力和注脚的须要,LeanMessage
还计划了操作签名的建制。大家得以在 LeanCloud
应用控制台、设置、应用选项中强制启用签名(强烈推荐那样做)。启用后,全部的
Session open 和 watch
行为都要求注解签名,那样开发者就足以对用户登录以及她能够关注如什么人,进而能够给哪些人发新闻进行丰硕的主宰。

签名选拔 Hmac-sha一 算法,输出字节流的十6进制字符串 (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,1个 master Key。个中 appKey
能够推行壹些常见的操作,并且受到 LeanCloud
平台安全设置的限定,类似于操作系统中的普通 User
账号,所以能够一直用在客户端;master Key
则拥有具有权力,类似于操作系统中的 Root/Administrator
账号,所以请妥善保管。

好,有了签订契约机制之后,大家到底该怎么运用呢?我们只须求完毕协调的
SignatureFactory,然后在开启 session 的时候,把那么些 signatureFactory
传进去即可。示例代码如清单 1三 所示:

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

与公事新闻看似,地理地方音信只是增多了1个 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
是3个老大平静可信的闲谈服务平台,提供的成效也可以满意大家采取开发者的急需。那里自个儿经过介绍
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 上加码3个 @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;
  }
}

群组聊天

与前边的单聊类似,群组聊天也亟需先成立3个会话(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 还有二个出殡和埋葬音讯的点子:

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)
    函数被调用的机会)。

吸收接纳群组音信

收到三个群组的音讯,与接受单聊的音信也是同样的。

分子管理

在查询到聊天室成员之后,能够让用户诚邀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
实例数组,开发者能够像在此以前接受新新闻通告1致处理。

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

甭管是单聊照旧群聊,当用户 A
发出信息后,假设目的对话中有部分用户如今不在线,LeanCloud
云端能够提供离线推送的点子来提示用户。那1作用暗许是关闭的,你能够在
LeanCloud 应用控制毕尔巴鄂开启它。开启方法如下:

  • 报到 LeanCloud 应用控制台,选用正确的行使进入;
  • 选料最上端的「音信」服务,依次点击左侧菜单「实时消息」->「设置」;
  • 在右手「iOS
    用户离线时的推送内容」下填好您要推送出去的新闻内容,保存;

如此那般 iOS 平台上的用户就能够收到 Push Notification
了(当然,前提是应用本身申请到了 RemoteNotification
权限,也将科学的推送证书上传到了 LeanCloud 控制台)。

群组消息免干扰(仅对 iOS 平台用户有效)

无论是是单聊依旧群聊,对于发往普通的 Conversation
的家常音信,假使接收方当前不在线,LeanCloud 云端协理通过 Push
Notification
的措施开始展览提醒。1般景观下那都以很好的,可是假使某些群组特别活跃,那离线用户就会收下过多的推送,会形成非常大的搅和。

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

搜寻群组

甭管是单聊,照旧群聊,在 LeanCloud IM SDK
里面都以对话(Conversation)。大家给对话设置了之类二种本性:

  • conversationId,字符串,对话 id,只读,对话创立之后由 LeanCloud
    云端赋予3个大局唯1的 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()
表示对话的积极分子中足足含有这个人口,可用来依据部分成员查找对话;与此类似的还有贰个
conversationQuery.withMembers()
则表示有且仅有这么些成员,用来依据全体成员查找指标对话;conversationQuery.whereXXX()
层层措施可用来限制对话名称和自定义属性,那里要强调的有个别是,对于自定义属性的约束规范,属性名一定要以
attr 开首,如上例所示,限定额外的 type 条件的时候要求内定的属性名是
attr.type。具体能够参考其头文件。

绽开聊天室

绽开聊天室(也叫暂态对话)能够用于很多地方,譬如弹幕、直播等等。在
LeanCloud IM SDK
中,开放聊天室是1类非常的群组,它也支撑创制、到场/踢出成员等操作,新闻记录会被保留并可供获取;与平时群组差异的地点实际体现为:

  • 不支持查询成员列表,你能够透过相关 API 查询在线人数;
  • 不帮衬离线信息、离线推送文告等效能;
  • 未有成员参加、离开的通报;
  • 3个用户壹回登录只好进入三个绽放聊天室,加入新的怒放聊天室后会自动离开原先的聊天室;
  • 参加后半时辰内断网重连会自行进入原聊天室,超越那个时间则供给重新插足;

创办开放聊天室

和常见的群组类似,建立2个开放聊天室也是很简单的,只是在
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);
    }
  }
});

创办成功未来,大家就能够进入聊天界面了。开放聊天室的别的操作,都与平时群组操作1样。

参加开放聊天室

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

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 那种自由灵活的应用体验,以及稳定快捷的劳动品质。

You can leave a response, or trackback from your own site.

Leave a Reply

网站地图xml地图