在聊天页面中渲染对话消息
功能简介
本文介绍了如何使用 ZIM SDK 在基本的聊天页面中渲染消息。
前提条件
已在项目中集成了 ZIM SDK 并实现了基本收发消息的功能，详情请参考 快速开始 - 实现基本收发消息。
消息数据来源概述
页面上需要渲染的消息数据来源主要有以下几种：
- 历史对话消息： 首次进入聊天页面和查看历史消息时，需要查询历史对话消息并渲染到聊天界面。
- 实时收到的消息： 实时收到的聊天消息需要渲染到聊天界面。
- 本地发送的消息： 本地发送的聊天消息（包含发送中、发送成功、发送失败等状态）需要渲染到聊天界面。
获取消息数据渲染到聊天界面
以单聊会话为例，跳转到聊天页面时，需要保存对应单聊的 conversationID（对方的 userID）并维护一个用于保存当前会话的消息列表 myMessageList。
在获取消息数据时建议实现 addMessage 工具方法用于合并历史消息、实时接收的消息和本地发送的消息。
// 有新消息时，通过该方法将消息更新到消息列表中
- (void)addMessage:(NSArray<ZIMMessage *> *)addList {
if (!addList || addList.count == 0) return;
NSMutableArray<ZIMMessage *> *mutableList = [self.myMessageList mutableCopy];
if (!mutableList) {
mutableList = [NSMutableArray array];
}
for (ZIMMessage *newMsg in addList) {
BOOL replaced = NO;
for (NSInteger i = 0; i < mutableList.count; i++) {
ZIMMessage *oldMsg = mutableList[i];
if ((newMsg.messageID && oldMsg.messageID && [newMsg.messageID isEqualToString:oldMsg.messageID]) ||
(newMsg.localMessageID && oldMsg.localMessageID && [newMsg.localMessageID isEqualToString:oldMsg.localMessageID])) {
// 替换已有消息
mutableList[i] = newMsg;
replaced = YES;
break;
}
}
if (!replaced) {
[mutableList addObject:newMsg];
}
}
// 根据 orderKey 从小到大排序
[mutableList sortUsingComparator:^NSComparisonResult(ZIMMessage *msg1, ZIMMessage *msg2) {
if (msg1.orderKey < msg2.orderKey) return NSOrderedAscending;
if (msg1.orderKey > msg2.orderKey) return NSOrderedDescending;
return NSOrderedSame;
}];
self.myMessageList = [mutableList copy];
}每次调用消息相关的接口时（比如以下展示的接口），会得到一个消息列表 ZIMMessage[]。获得的消息列表需要进行合并数据的操作，从而得到一个无重复消息、有序的消息列表用于在消息页面进行渲染。消息排序规则为根据 ZIMMessage 中的 orderkey 属性进行排序（orderkey 越大表示当前消息越新）；去重规则为根据消息的 localMessageID 判断消息对象是否为同一条消息，重复时新数据替换旧数据。
查询历史消息并渲染到聊天界面
调用 queryHistoryMessageByConversationID 接口从新分页到旧分页（按时间顺序从最近的消息到更久之前的消息）进行查询，获取双方的历史消息并渲染到聊天界面。
ZIMMessageQueryConfig *queryConfig = [[ZIMMessageQueryConfig alloc] init];
queryConfig.count = 20;//
queryConfig.nextMessage = nil;//首次查询时传空，需要更多历史消息时，传入消息列表中最早的消息再次调用
[zim queryHistoryMessageByConversationID:myConversationID
conversationType:ZIMConversationTypePeer
config:queryConfig
callback:callback:^(NSString * _Nonnull conversationID, ZIMConversationType conversationType, NSArray<ZIMMessage *> * _Nonnull messageList, ZIMError * _Nonnull errorInfo){
[self addMessage:messageList];
// update UI
}];
ZIMMessageQueryConfig queryConfig;
queryConfig.count = 20;
queryConfig.nextMessage = nullptr; // 首次查询为空
zim->queryHistoryMessage(
myConversationID,
ZIMConversationType::Peer,
queryConfig,
[this](const std::string& conversationID, ZIMConversationType type,
const std::vector<ZIMMessage>& messageList, const ZIMError& errorInfo) {
addMessage(messageList);
refreshUI(); // 自定义 UI 刷新函数
});
获取实时接收的消息并渲染到聊天界面
监听 peerMessageReceived 接口获取实时接收的消息，并渲染到聊天界面。
- (void)zim:(ZIM *)zim
peerMessageReceived:(NSArray<ZIMMessage *> *)messageList
info:(ZIMMessageReceivedInfo *)info
fromUserID:(NSString *)fromUserID{
if(fromUserID != myConversationID){
return;// 非当前会话收到的聊天消息，忽略
}
[self addMessage: messageList];
// update UI
}将本地发送的消息渲染到聊天界面
监听 messageSentStatusChanged ，获取本地发送消息的发送状态的变化（发送中、发送成功、发送失败），渲染本地发送的消息及其发送状态到聊天界面。
- (void)zim:(ZIM *)zim
messageSentStatusChanged:
(NSArray<ZIMMessageSentStatusChangeInfo *> *)messageSentStatusChangeInfoList{
for(ZIMMessageSentStatusChangeInfo *info in messageSentStatusChangeInfoList){
if(info.message.conversationID != myConversationID){
continue;
}
[self addMessage:info.message];
}
// update UI
}通过以上方式，即可实现在聊天页面中渲染历史消息、实时接收的消息和本地发送的消息（包含发送状态）。
常见问题
消息数据在生命周期内可能发生变化，常见场景包括：
- 发送状态从 “发送中” 变为 “发送成功” 或 “发送失败”。
- 消息被撤回后，消息类型发生变更（例如从文本消息变为已撤回消息）。
- 已发送的消息被编辑。
SDK 会在上述变化发生时推送最新的消息对象。为保持消息数据的一致性，应使用最新消息对象替换已有消息，并刷新 UI。
messageID 由服务器分配，具备全局唯一性，是消息的主要标识符。
在以下场景中，消息可能尚未分配 messageID：
- 消息正在发送中
- 消息发送失败
- 消息仅保存在本地（通过
insertMessageToLocalDB插入）
此时需使用 localMessageID 作为客户端的临时标识符。匹配规则为：messageID 可用时优先使用 messageID，不可用时使用 localMessageID。
结合这两个标识符，可在消息生命周期的各个阶段准确判断两个消息对象是否为同一条消息。
timestamp 反映消息到达服务器的时间，orderKey 专为消息排序设计，能提供一致的排序结果。
在快速连续发送消息或网络条件不稳定时，timestamp 可能出现偏差，导致消息乱序。orderKey 综合考虑了全局消息顺序和同一发送者的发送顺序，确保消息显示与对话流程一致。
使用 orderKey 排序可保证：
- 排序结果稳定
- 对话顺序正确
- 不同客户端间显示一致
ZIM 在每个 API 或事件的返回结果中，已按 orderKey 对消息完成排序。
实际应用中，聊天页面的消息列表由多个数据源合并构成：
- 历史消息（
queryHistoryMessage） - 实时接收消息（
onPeerMessageReceived） - 消息更新（状态变更、撤回、编辑等）
客户端是唯一能同时获取所有数据源的层级，需在合并后统一按 orderKey 重新排序，以确保：
- 消息顺序稳定正确
- 对话流程连贯
- 所有数据源的视图统一
ZIM 负责各数据源内部的有序性，客户端负责合并后的全局排序一致性。