导入和插入消息

大约 5 分钟

导入和插入消息

功能说明

本文介绍环信即时通讯 IM Android SDK 如何将消息导入本地数据库,以及如何在本地会话中插入消息。

这些操作仅更新当前设备上的本地消息和会话数据,不会将消息发送给会话对端,也不会向服务器上传消息或同步到当前账号的其他设备。常见使用场景包括迁移历史消息、恢复本地消息记录,以及插入撤回提示、入群通知等仅用于本地展示的消息。

Android SDK 提供以下方式:

  • 批量导入消息:调用 EMChatManager#importMessages,将当前用户发送或接收的多条消息导入本地数据库,但不会更新对应会话的最新消息等会话信息。
  • 向指定会话插入消息:调用 EMConversation#insertMessage,按照消息中的 Unix 时间戳将消息插入指定会话,并更新会话的最新消息等会话信息。消息的会话 ID 必须与目标会话 ID 一致。
  • 直接保存消息:调用 EMChatManager#saveMessage,将消息保存到内存和本地数据库;若对应会话不存在,SDK 会自动创建会话。

批量导入消息时,如果对应会话尚无最新消息记录,从本地数据库加载会话且过滤空会话时,该会话会被过滤,不会出现在返回的会话列表中。EMOptions#setLoadEmptyConversations 默认设置为 false,即不加载空会话。

因此,建议按会话划分待导入的消息,将每个会话中按消息时间排序的最新一条消息预留出来,其余消息通过 EMChatManager#importMessages 批量导入,待批量导入完成后,再通过对应会话的 EMConversation#insertMessage 插入预留的消息,以更新会话信息。插入前应获取或创建对应会话。“最新”以 SDK 当前消息排序配置使用的时间戳为准。例如,同一个会话有 10:00、10:01 和 10:02 三条待导入的消息,可先通过 EMChatManager#importMessages 导入前两条,再通过 EMConversation#insertMessage 插入 10:02 的消息。不要先将三条消息全部批量导入,再重复插入 10:02 的消息,否则 SDK 会因消息已存在而直接返回,不会更新会话信息。

前提条件

开始前,请确保满足以下条件:

批量导入消息到数据库

如需在本地会话中批量导入消息,应先将待导入数据转换为 EMMessage 对象列表,再调用 EMChatManager#importMessages(List<EMMessage>)。

当前用户只能导入自己发送或接收的消息。导入后,消息保存在本地数据库中,但不会更新对应会话的最新消息等会话信息。建议每次导入不超过 1,000 条消息。

importMessages 是同步方法,无返回值,也不提供结果回调。 调用前,应确保 SDK 已初始化,并且当前用户的本地数据库已经打开。

// messages 为已准备好的消息列表,类型为 List<EMMessage>。
EMClient.getInstance()
        .chatManager()
        .importMessages(messages);

提示

EMOptions#setRegardImportedMsgAsRead 不用于设置通过 EMChatManager#importMessages 导入的本地消息是否已读。该配置适用于通过服务端消息导入接口导入、之后由客户端从服务器拉取的历史消息。

插入消息

如果需要在本地会话中加入一条无需发送、仅用于本地展示的消息,例如“XXX 撤回一条消息”“XXX 入群”或“对方正在输入”等,可以使用以下两种方式:

  • 调用 EMConversation#insertMessage,将消息插入指定的已有会话。消息会按照其中的 Unix 时间戳插入本地数据库,SDK 同时更新会话的 latestMessage 等属性。调用前应确保消息的会话 ID 与目标会话 ID 一致。
  • 调用 EMChatManager#saveMessage,将消息保存到内存和本地数据库。SDK 会根据消息的会话类型和收发方向确定会话;若对应会话不存在,SDK 会自动创建会话。透传消息(命令消息)不会保存到本地。

以上两个接口仅更新当前设备的本地数据,不会将消息发送到服务器或会话对端,也不会同步到当前账号的其他设备。

示例代码如下:

// 方式一:将消息插入指定的已有会话。
EMConversation conversation = EMClient.getInstance()
        .chatManager()
        .getConversation(conversationId);

if (conversation != null) {
    // 消息的会话 ID 应与目标会话 ID 一致。
    // SDK 按消息中的 Unix 时间戳确定插入位置。
    boolean inserted = conversation.insertMessage(message);
}

// 方式二:直接保存消息。
// SDK 会根据消息信息确定会话;若会话不存在,则自动创建。
// 注意:命令消息不会保存到本地。
EMClient.getInstance()
        .chatManager()
        .saveMessage(message);

接口列表

API 名称所属模块/类说明
importMessagesEMChatManager将当前用户发送或接收的消息批量导入本地数据库。
getConversationEMChatManager获取指定 ID 的本地会话;未找到时返回 null。
insertMessageEMConversation按消息中的 Unix 时间戳将消息插入指定本地会话。
saveMessageEMChatManager将消息保存到内存和本地数据库;必要时自动创建会话。
上次编辑于: