搜索消息

大约 6 分钟

搜索消息

本文介绍环信即时通讯 IM Android SDK 如何搜索本地消息。调用本文中的消息搜索方法可以搜索本地数据库中除命令消息之外的所有类型的消息，因为命令消息不在本地数据库中存储。

技术原理

环信即时通讯 IM Android SDK 通过 EMChatManageropen in new window 和 EMConversationopen in new window 类支持搜索用户设备上存储的消息数据，其中包含如下主要方法：

  • EMConversation#searchMsgFromDB(string keywords, long timeStamp, int maxCount, string from, EMSearchDirection direction)：根据关键字搜索本地数据库中单个会话中指定用户发送的消息。
  • EMChatManager#searchMsgFromDB(java.lang.String, long, int, java.lang.String, EMConversation.EMSearchDirection, EMConversation.EMMessageSearchScope): 根据关键字搜索消息时，可以选择搜索范围在所有会话中进行消息搜索。
  • EMConversation#searchMsgFromDB(java.lang.String, long, int, java.lang.String, EMConversation.EMSearchDirection, EMConversation.EMMessageSearchScope)：根据关键字搜索消息时，可以选择搜索范围在当前会话中进行消息搜索。
  • EMChatManager#searchMsgFromDB(java.util.Set<EMMessage.Type>, long, int, java.lang.String, EMConversation.EMSearchDirection)：根据单个或多个消息类型，搜索本地数据库中所有会话的消息。
  • EMConversation#searchMsgFromDB(java.util.Set<EMMessage.Type>, long, int, java.lang.String, EMConversation.EMSearchDirection) 根据单个或多个消息类型，搜索本地数据库中单个会话的消息。

前提条件

开始前，请确保满足以下条件：

  • 完成 SDK 初始化并连接到服务器，详见 快速开始。
  • 了解环信即时通讯 IM API 的使用限制，详见 使用限制。

实现方法

根据关键字搜索会话中的用户发送的消息

你可以调用 searchMsgFromDB(string keywords, long timeStamp, int maxCount, string from, EMSearchDirection direction) 方法根据关键字搜索本地数据库中单个会话中指定用户发送的消息，示例代码如下：

//conversationId：会话 ID
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
// keywords：搜索关键字；timeStamp：搜索的起始时间戳；maxCount：每次获取的消息数量，取值范围为 [1,400]。
// direction：消息搜索方向：（默认）`UP`：按消息时间戳的逆序搜索；`DOWN`：按消息时间戳的正序搜索。
List<EMMessage> messages = conversation.searchMsgFromDB(keywords, timeStamp, maxCount, from, EMConversation.EMSearchDirection.UP);

根据搜索范围搜索所有会话中的消息

你可以调用 EMChatManager#searchMsgFromDB(java.lang.String, long, int, java.lang.String, EMConversation.EMSearchDirection, EMConversation.EMMessageSearchScope) 方法，除了设置关键字、消息时间戳、消息数量、发送方、搜索方向等条件搜索所有会话中的消息时，你还可以选择搜索范围，如只搜索消息内容、只搜索消息扩展信息以及同时搜索消息内容以及扩展信息。

提示

若使用该功能，需将 SDK 升级至 V4.4.0 或以上版本。

String keyWord = "123";
List<EMMessage> messages = EMClient.getInstance().chatManager().searchMsgFromDB(keyWord, -1, 200, null, EMConversation.EMSearchDirection.UP, EMConversation.EMMessageSearchScope.ALL);

根据搜索范围搜索当前会话中的消息

你可以调用 EMConversation#searchMsgFromDB(java.lang.String, long, int, java.lang.String, EMConversation.EMSearchDirection, EMConversation.EMMessageSearchScope) 方法除了设置关键字、消息时间戳、消息数量、发送方、搜索方向等条件搜索当前会话中的消息，你还可以选择搜索范围，如只搜索消息内容、只搜索消息扩展信息以及同时搜索消息内容以及扩展信息。

提示

若使用该功能，需将 SDK 升级至 V4.4.0 或以上版本。

String keyWord = "123";
String conversationId = "jack";
EMConversation conversation = EMClient.getInstance().chatManager().getConversation(conversationId);
List<EMMessage> messages = conversation.searchMsgFromDB(keyWord, -1, 200, null, EMConversation.EMSearchDirection.UP, EMConversation.EMMessageSearchScope.ALL);

根据消息类型搜索所有会话中的消息

你可以调用 EMChatManager#searchMsgFromDB(java.util.Set<EMMessage.Type>, long, int, java.lang.String, EMConversation.EMSearchDirection) 方法除了设置消息时间戳、消息数量、发送方、搜索方向等条件搜索当前会话中的消息，你还可以设置单个或多个消息类型搜索本地数据库中所有会话的消息。

提示

若使用该功能，需将 SDK 升级至 V4.7.0 或以上版本。

// count：要查询的消息条数。取值范围为 [1,400]。
// fromuser：会话中发送方的用户 ID。若传空字符串，搜索对发送方不限制。
Set types=new HashSet<>();
types.add(EMMessage.Type.TXT);
types.add(EMMessage.Type.VOICE);
List messages = EMClient.getInstance().chatManager().searchMsgFromDB(types, -1, 400, "xu", EMConversation.EMSearchDirection.UP);
for (int i = 0; i < messages.size(); i++) {
    EMMessage message = (EMMessage) messages.get(i);
    if (message.getBody() instanceof EMTextMessageBody) {
        EMTextMessageBody body = (EMTextMessageBody) message.getBody();
        EMLog.e(TAG, "message: " + body.getMessage() + ",time: " + message.getMsgTime());
    } else {
        EMLog.e(TAG, "message: " + message.getBody() + ",time: " + message.getMsgTime());
    }
}

根据消息类型搜索当前会话中的消息

你可以调用 EMConversation#searchMsgFromDB(java.util.Set<EMMessage.Type>, long, int, java.lang.String, EMConversation.EMSearchDirection) 方法除了设置消息时间戳、消息数量、发送方、搜索方向等条件搜索当前会话中的消息，你还可以设置单个或多个消息类型搜索本地数据库中单个会话的消息。

提示

若使用该功能，需将 SDK 升级至 V4.7.0 或以上版本。

// count：要查询的消息条数。取值范围为 [1,400]。
// fromuser：当前会话中发送方的用户 ID。若传空字符串，搜索对发送方不限制。
Set types=new HashSet<>();
types.add(EMMessage.Type.TXT);
types.add(EMMessage.Type.VOICE);
List messages = EMClient.getInstance().chatManager().getConversation("xu").searchMsgFromDB(types, -1, 400, "xu", EMConversation.EMSearchDirection.UP);
for (int i = 0; i < messages.size(); i++) {
    EMMessage message = (EMMessage) messages.get(i);
    if (message.getBody() instanceof EMTextMessageBody) {
        EMTextMessageBody body = (EMTextMessageBody) message.getBody();
        EMLog.e(TAG, "message: " + body.getMessage() + ",time: " + message.getMsgTime());
    } else {
        EMLog.e(TAG, "message: " + message.getBody() + ",time: " + message.getMsgTime());
    }
}

关键字搜索规则

调用以下消息搜索 API 搜索不同类型的消息时，其中的 keywords 参数对应不同的内容。

只搜索消息内容

消息类型关键字匹配的消息内容关键字搜索内容示例
文本消息EMTextMessageBody#getMessage文本消息的实际内容“你好世界”。
图片消息EMImageMessageBody#getFileName图片文件名“photo.jpg”。
语音消息EMVoiceMessageBody#getFileName语音文件名“audio.amr”。
视频消息EMVideoMessageBody#getFileName视频文件名“video.mp4”。
文件消息EMFileMessageBody#getFileName文件名“report.pdf”。
位置消息EMLocationMessageBody#getAddress 和 EMLocationMessageBody#getBuildingName地址\建筑物名称“北京市朝阳区\国贸大厦”
自定义消息EMCustomMessageBody#event自定义事件名“gift”
合并消息EMCombineMessageBody#getTitle 和 EMCombineMessageBody#getSummary标题\摘要“聊天记录\包含5条消息”

只搜索扩展信息

若只搜索消息的扩展属性（ext）JSON 字符串，keywords 字段匹配用户自定义添加的扩展属性，例如：

{"key1":"value1", "key2":"value2"}

全搜索

同时搜索消息内容和扩展信息，任一匹配即返回。

上次编辑于:
环信 IM 文档 Version: 1.0.0 ©️环信