让你的 Android 应用也能聊天

日期:2019-11-26编辑作者:动漫动画

简介

自去年 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>

接下来我们需要完成用户登录。

基本概念和类

登录

假定聊天发起方名叫 Tom,为直观起见,我们使用用户名来作为 clientId 登录聊天系统(LeanCloud 云端只要求 clientId 在应用内唯一即可,具体用什么数据由应用层决定),代码如下:

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

聊天参与者 Peer

在 LeanMessage 实时消息世界中,每一个参与者(一般而言是「人」)都是一个 Peer。Peer 拥有一个在应用内唯一标识自己的 ID(称为 PeerID,字符串类型,长度不超过 50 字节,具体数值由应用自身确定),系统中的每一条消息都来自于一个 Peer,发送到一个或多个 Peer。并且,LeanMessage 的消息服务允许一个 Peer 在多个不同设备上登录,也允许一个设备上同时登录多个 Peer,究竟该如何使用,由应用根据使用场景自己选择。

这里要注意的是,PeerID 是由应用开发者自己賦值的,LeanMessage 本身并没有任何强制要求,所以:

  • 实时消息系统是可以和用户账户系统解耦合的,应用开发者不需要把除了 PeerID 以外的任何信息告诉 LeanMessage;
  • LeanMessage 在消息转发的时候是按照 PeerID 来唯一定位的,因此如果应用自身支持同一账户的多点登录,那么 LeanMessage 就会把消息通知到所有终端;
  • 匿名聊天/非匿名聊天这都是应用层自己决定的,如果应用自身能为匿名用户指定一个唯一的 ID,那么这个用户参与到聊天系统里来,是完全没有问题的。

为了防止骚扰,一个 Peer 需要先关注(watch)了对方才能给对方发送消息;因为 LeanMessage 提供了更细粒度的权限控制,应用开发者可以在关注(watch)动作上增加签名来保证安全性。这一点后面会进行详细说明。

必赢优惠大厅官网,建立对话

假定我们要跟「Bob」这个用户进行聊天,我们先创建一个对话,代码如下:

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

每一个 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);

对于 Tom 发过来的消息,要显示出来,我们只需实现 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 启动的时候进行。千万不要在一个临时或短命的 Activity 中开启聊天会话。上面代码中 SessionManager 也是 Session 的子类,所以可以直接调用 Session 的方法。

接下来,我们开始跟「Bob」这个用户进行聊天。为了给他发送消息,我们先要关注(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));

好了,这样一条消息就发送过去了。但是问题来了,对于「Bob」而言,他怎么才能收到别人发给他的消息呢?

上面对于 Session 的所有操作都是异步的。与一般 Android 异步方法调用不同,LeanMessage SDK 的异步并不是通过 Callback 或者类似 RsyncTask 的机制实现的,而是通过继承 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 大量采用回调来反馈操作结果,但是对于一些被动的消息通知,则还是采用接口来实现的,包括:

  • 当前网络出现变化
  • 对话中有新的消息
  • 必赢437登录,对话中有新成员加入
  • 对话中有成员离开
  • 被邀请加入某对话
  • 被踢出对话

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) 可以设定全局的 ClientEventHandler。

群组聊天

在聊天的需求里,还有一个很重要的场景,就是群组聊天。从前面 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) 可以设置全局的 ConversationEventHandler。

基本概念

与普通的单聊相比,群聊增加了如下两个基本概念:

  • 群组 AVGroup

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

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

一个 Peer 加入群后向群发送的消息可以被所有群成员收到。当有新成员加入或者既有成员退出时,所有群成员都会得到通知。AVGroup 上可以进行的操作有:

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

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

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

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

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

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

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

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

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

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

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

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

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

消息响应接口

主要用来处理新消息到达事件,接口定义在 MessageHandlerAVIMMessageHandler 是一个空的实现类,我们应该通过重载 AVIMMessageHandler 的相关方法来完成消息处理。主要的方法有:

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

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

通过 AVIMMessageManager.registerDefaultMessageHandler(handler) 可以设置全局的 MessageHandler。

我们实现这三类接口,就可以处理所有的通知消息了。示例代码如下:

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

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

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

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

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

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

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

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

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

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

加入聊天室

由于整个实时通信功能都是建立在 Session 的基础上,所以我们要加入一个聊天室也需要建立在一个已经打开的 Session 上。 已经打开一个 Session 以后,可以通过以下操作来加入一个 Group:

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

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

支持富媒体的聊天消息

上面的代码演示了如何发送简单文本信息,但是现在的交互方式已经越来越多样化,图像、语音、视频已是非常普遍的消息类型。v2 版的 LeanCloud IM SDK 已经可以很好地支持这些富媒体消息,具体说明如下:

往聊天室发送消息

发送消息非常简单,通过如下代码就可以向特定聊天室发送消息了:

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

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

基类:AVIMTypedMessage

所有富媒体消息的基类,其声明为

//SDK定义的消息类型,LeanCloud SDK 自身使用的类型是负数,所有正数留给开发者自定义扩展类型使用,0 作为「没有类型」被保留起来。
enum AVIMReservedMessageType {
  UnsupportedMessageType(0),
  TextMessageType(-1),
  ImageMessageType(-2),
  AudioMessageType(-3),
  VideoMessageType(-4),
  LocationMessageType(-5),
  FileMessageType(-6);
};

public abstract class AVIMTypedMessage extends AVIMMessage {
  public AVIMTypedMessage();

  public int getMessageType();

  @Override
  public final String getContent();

  @Override
  public final void setContent(String content);
}

接收聊天室消息

接收一个聊天室的消息,与接收单聊的消息一样,需要开发者实现 AVGroupMessageReceiver 接口,并在 AndroidManifest.xml 中注册即可,如代码清单 8 所示:

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

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

文本消息(AVIMTextMessage)

AVIMTypedMessage 子类,表示一般的文本消息,其声明为

public class AVIMTextMessage extends AVIMTypedMessage {
  public String getText();
  public void setText(String text);

  public Map<String, Object> getAttrs();
  public void setAttrs(Map<String, Object> attr);
}

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

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

查询聊天室成员

在加入一个聊天室之后,我们第一步就是看看有哪些人在这个群组里面。LeanMessage 和 LeanStorage 是结合在一起的,通过使用 LeanStorage 的数据存储功能,来保存一个聊天室的基本信息(表名:AVOSRealtimeGroups),在 LeanStorage 应用管理平台的数据中心,我们可以看到 AVOSRealtimeGroups 的所有字段。

LeanStorage 的数据中心
LeanStorage 也是 LeanCloud 平台的核心服务之一,提供了应用内数据和文件数据的存储功能。对于应用内数据,LeanStorage 支持 schema free 的存储,开发者不需要事先定义数据的模式,只要符合 JSON 格式的 Object 都可以自由存储到 LeanStorage 云端。同时,LeanStorage 也提供一个 Web 版的数据管理界面,可以非常方便地增、删、改、查任何数据。

当然,在我们知道一个聊天室的 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());
              }
            }
       })

上面第一个查询会拿到「Tom」和「Bob」在特定时间点以前的 100 条聊天记录;第二个查询会拿到特定聊天室的所有聊天记录(如果总数不超过 1000 条的话)。

音频消息(AVIMAudioMessage)

AVIMFileMessage 子类,专门用来发送语音和附带文本的混合消息,其构造函数声明为:

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

发送音频消息的示例代码为:

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

接收到这样消息之后,开发者可以通过如下方法,获取到若干音频元数据(时长 duration、音频 size)和一个包含音频数据的 AVFile 对象:

  • double getDuration() 方法会返回音频的长度(单位:秒)
  • AVFile getAVFile() (继承自 AVIMFileMessage)方法会返回一个音频文件的 AVFile 实例
  • String getFileUrl() (继承自 AVIMFileMessage)方法会返回音频文件的 url
  • long getSize() (继承自 AVIMFileMessage)方法会返回音频文件的实际大小(单位:byte)
  • String getText() (继承自 AVIMFileMessage)方法会返回随音频一起发送的文本信息。
  • Map<String, Object> getFileMetaData() (继承自 AVIMFileMessage)可以获取音频的其他元数据信息。

一览查看所有聊天室

查看所有聊天室的方法和查看单个聊天室成员的方法类似,都是直接通过 AVQuery 或者 AVObject 来遍历 AVOSRealtimeGroups 表实现的,这里不再赘述。

视频消息(AVIMVideoMessage)

AVIMFileMessage 子类,专门用来发送视频和附带文本的混合消息,其构造函数声明为:

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

发送视频消息的示例代码为:

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

接收到这样消息之后,开发者可以可以通过如下方法,获取到若干视频元数据(时长 duration、视频 size)和一个包含视频数据的 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);
}

与文本消息类似,地理位置消息只是增加了一个 AVGeoPoint 的 Location 属性。要发送位置消息的示例代码为:

AVIMLocationMessage message = new AVIMLocationMessage();
message.setText("快点过来!");
message.setLocation(new AVGeoPoint(15.9, 56.4));
conversation.sendMessage(message, new AVIMConversationCallback() {
  @Override
  public void done(AVException e) {
    if (null != e) {
      // 出错了。。。
      e.printStackTrace();
    } else {
      Logger.d("message sent");
    }
  }
});

接收到这样的消息之后,开发者可以获取到具体的地理位置数据。

结束语

LeanMessage 是一个非常稳定可靠的聊天服务平台,提供的功能也足以满足我们应用开发者的需求。这里我通过介绍 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 上增加一个 @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;
  }
}

群组聊天

与前面的单聊类似,群组聊天也需要先建立一个对话(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 还有一个发送消息的方法:

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() 表示对话的成员中至少包含这些人员,可用来根据部分成员查找对话;与此类似的还有一个 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 这种自由灵活的使用体验,以及稳定迅捷的服务质量。

本文由必赢437登录发布于动漫动画,转载请注明出处:让你的 Android 应用也能聊天

关键词:

【必赢437登录】如何鉴别真爱

"海上生明月,天涯共此时。情人怨遥夜,竟夕起相思。” 必赢电子游戏娱乐,——张九龄《望月怀远》 在饥饿的年...

详细>>

「电影+」布署Vol.1——那电影里有你的正儿八

「电影+」计划Vol.1 「电影+」计划第一期感谢各位的支持~ 第二期见啦,希望能够有更多的朋友通过电影讲讲你们自己...

详细>>

「电影+」布署Vol.1——那电影里有你的正儿八

「电影+」计划Vol.1 「电影+」计划第一期感谢各位的支持~ 第二期见啦,希望能够有更多的朋友通过电影讲讲你们自己...

详细>>

iOS开发初学者入门 | 第十章:在真机上运行

在此生机勃勃章节,你将学会怎么样在真机上运转你的App,你将学会怎么成立证书、注册你的测量检验设施,设置你...

详细>>