保利威文档中心

幫助中心

4_3-带货场景-聊天室

更新時間：2023-04-17 15:27:57

1 功能概述

聊天室模組包含發言、按讚、歷史記錄、歡迎語等功能。聊天室模組在 UI、互動、功能上，相較於其他模組，會更複雜且更龐大。因此設計、搭建、維護一個聊天室，也是一件較為費時費力的事情。我們推薦直接使用保利威封裝好的聊天室模組，該部分程式碼完全開源，支援直接使用以及二次開發。

2 核心類別介紹

2.1 PLVECChatroomViewModel

PLVECChatroomViewModel 是帶貨場景 Scene 層聊天室的核心類別，由於一個應用只允許存在一個聊天室，所以 PLVECChatroomViewModel 採用的是單例的模式，負責建立、持有、銷毀 Common 層聊天室核心類別 PLVChatroomPresenter 的實例物件，以及與 Common 層聊天室模組進行通訊。核心類別 PLVECChatroomViewModel 提供的功能如下：

  1. 對 View 層提供發送訊息的介面；

  2. 管理 Common 層回傳的訊息模型；

  3. 在 View 層需要重新整理 UI、更新列表資料時，透過回呼通知 View 層。

2.1.1 生命週期

PLVECChatroomViewModel 是單例類別，進入直播間啟動聊天室時呼叫 -setup 方法，離開直播間時呼叫 -clear 方法，程式碼如下：

// 使用新的直播间数据启动聊天室管理器
[[PLVECChatroomViewModel sharedViewModel] setup];
// 退出前调用，用于资源释放、状态位清零
[[PLVECChatroomViewModel sharedViewModel] clear];

程式碼註解提到的「直播間資料」指的是 PLVRoomDataManager 單例持有的 roomData。

2.1.2 取得聊天記錄

Common 層聊天室核心類別 PLVChatroomPresenter 在初始化完畢之後，會自動取得第一頁的聊天記錄，取得更多聊天記錄的程式碼如下：

[[PLVECChatroomViewModel sharedViewModel] loadHistory];

-loadHistory 使用在 2.1.1 的 -setup 方法裡初始化的 presenter 物件，呼叫 Common 層聊天室模組以取得聊天室記錄。

2.1.3 發送訊息

PLVECChatroomViewModel 類別提供帶貨場景所需的發送訊息 API，具體介面定義如下：

/// 发送文本消息
/// @param content 消息文本
/// @return YES表示数据将有更新，可等待收到回调后刷新列表；NO表示socket未登录或房间关闭，可进行toast提示
- (BOOL)sendSpeakMessage:(NSString *)content;

/// 发送礼物消息
/// @param data 礼物消息data字段
/// @param tip 礼物消息tip字段
/// @return 是否成功发送的布尔值
- (BOOL)sendGiftMessageWithData:(NSDictionary *)data tip:(NSString *)tip;

/// 发送自定义消息
/// @param event 自定义消息event字段
/// @param data 自定义消息data字段
/// @param tip 自定义消息tip字段
/// @param emitMode 自定义消息emitMode字段
/// @return 是否成功发送的布尔值
- (BOOL)sendCustomMessageWithEvent:(NSString *)event
                              data:(NSDictionary *)data
                               tip:(NSString * _Nullable)tip
                          emitMode:(int)emitMode;

/// 发送点赞消息
/// 点赞数的实时更新通过监听roomData的likeCount获得
- (void)sendLike;
2.1.4 訊息陣列

PLVECChatroomViewModel 類別提供以下訊息列表陣列，作為聊天室 View 層的資料來源：

/// 全部消息数组
@property (nonatomic, strong, readonly) NSMutableArray <PLVChatModel *> *chatArray;
2.1.5 監聽與回呼

PLVECChatroomViewModel 提供了屬性 delegate 用於設定回呼監聽，屬性 delegate 遵循協定 PLVECChatroomViewModelProtocol，用於在 View 層需要重新整理 UI、更新列表資料時，透過回呼通知 View 層：

@protocol PLVECChatroomViewModelProtocol <NSObject>

@optional

/// 返回本地发送的公聊消息（包含禁言的情况）
/// 用于刷新列表、滚动列表到底部
- (void)chatroomManager_didSendMessage;

/// 返回socket接收到的公聊消息
/// 用于刷新列表、显示新消息提示
- (void)chatroomManager_didReceiveMessages;

/// socket通知有消息被删除（1条或多条）
/// 用于刷新列表
- (void)chatroomManager_didMessageDeleted;

/// 获取历史聊天记录成功时触发
/// 用于刷新列表，停止【下拉加载更多】控件的动画
/// @param noMore 是否还有更多历史消息，YES表示已加载完，此时可隐藏【下拉加载更多】控件
/// @param first  是否是初次加载历史消息，初次加载需滚动列表到底部
- (void)chatroomManager_loadHistorySuccess:(BOOL)noMore firstTime:(BOOL)first;

/// 获取历史聊天消息失败时触发
/// 用于停止【下拉加载更多】控件的动画
- (void)chatroomManager_loadHistoryFailure;

/// 当前时间段内如果有用户登录聊天室（包括自己），间隔2秒触发一次
/// @param userArray 登录聊天室的用户数组，如果为nil，表示当前时间段内当前用户有登录事件
- (void)chatroomManager_loginUsers:(NSArray <PLVChatUser *> * _Nullable )userArray;

@end
联系客服，在线咨询