IM消息收发调整版

接收消息

接口设计

如果需要感知新消息的通知，可以注册消息通知回调IIMMsgListener。新消息到来时，onNewMsg方法将被调用。当某条消息被撤回时，onMsgRevoked方法将被调用。

/**监听消息事件 */
@protocol IIMMsgListener <NSObject>

/**
* 收到新消息
* @msgList      新消息列表
*/
- (void)onNewMsg:(NSArray<IMBaseMessage *> *)msgList;

/**
* 消息被撤回
* @msg 被撤回的消息
*/
- (void)onMsgRevoked:(IMBaseMessage *)msg;

@end

在IIMBaseMessageManager里面，提供了注册消息监听和移除消息监听的接口

/** 监听全局的消息事件 */
- (void)addMsgListener:(id<IIMMsgListener>)listener;
/** 取消监听 */
- (void)removeMsgListener:(id<IIMMsgListener>)listener;

为了方便使用，把onNewMsg和onMsgRevoked两个消息回调接口封装成Block的方式使用，因此可直接使用IMMsgListerner作为监听者。

typedef void(^NewMsg)(NSArray<IMBaseMessage *> *); //收到新消息Block
typedef void(^MsgRevoked)(IMBaseMessage *);  // 收到消息撤回通知Block

@interface IMMsgListener : NSObject <IIMMsgListener>

- (instancetype)initWithNewMsgBlock:(NewMsg)newMsgBlock revokedMsgBlock:(MsgRevoked)revokedMsgBolck;

@end

使用示例

IMMsgListener *msgListener = [[IMMsgListener alloc] initWithNewMsgBlock:^(NSArray<IMBaseMessage *> * _Nonnull msgList) {

} revokedMsgBlock:^(IMBaseMessage * _Nonnull msg) {

}];

id<IIMAppMsgService> msgService = [[JSObjection defaultInjector] getObject:@protocol(IIMAppMsgService)];
id<IIMAppMsgManager> msgManager = [msgService getMessageMgr];

[msgManager addMsgListener:msgListener];

自定义消息元素(Elem)使用事例

为了能够传输自定义消息，我们使用PB协议对消息元素(Elem)进行编码和解码。

自定系消息元素结构

消息收发Leslie.png

使用流程如下：

自定义消息元素（以IMPBFileElem为例）

查看.proto文件，明晰自定义Elem需要的所有字段。

// 文件内容
message IMPBFileElem{
    optional bytes file_name = 1;   // 文件名
    optional uint64 file_size = 2;    // 文件大小
    optional bytes url = 3;             // 文件路径
}

根据proto文件规定的字段自定义Elem，需遵守IBaseElem协议。

@interface IMFileMsgElem : NSObject <IBaseElem>

/** 文件名 */
@property(nonatomic, strong) NSString *fileName;
/** 文件大小 */
@property(nonatomic, assign) uint64_t fileSize;
/** 文件路径 */
@property(nonatomic, strong) NSString *url;
@end

在Elem的实现中，参考proto文件, 定义字段的编码(解码)的顺序，实现toByteArray方法，将数据以二进制形式发送。

@implementation IMFileMsgElem

// 参考proto文件,定义字段的编码(解码)的顺序
PBCODER_TABLE_BEGIN(IMFileMsgElem)
PBCODER_OBJ_PROPERTY(IMFileMsgElem, fileName, NSString, 1)
PBCODER_UINT64_PROPERTY(IMFileMsgElem, fileSize, 2)
PBCODER_OBJ_PROPERTY(IMFileMsgElem, url, NSString, 3)
PBCODER_TABLE_END(IMFileMsgElem)

// 将Elem转化为二进制数据
-(NSData *)toByteArray
{
    return [PBCoder encodeDataWithObject:self];
}

// 指定自定义Elem的类型
- (int32_t)getType
{
    return IM_FILE_TYPE;
}
...
@end

自定义消息元素解析

收到消息后，需要将二进制数据解析为自定义的消息元素。
在IMMessageFactory协议里面，我们提供了将二进制数据转化为自定义消息元素的方法。

- (id<IBaseElem>)createElem:(int32_t)type
                       data:(NSString *)data;

在IMMessageFactory里面，添加自定义Elem的解析即可。

@implementation IMMessageFactory

-(id<IBaseElem>)createElem:(int32_t)type data:(NSString *)data
{
    id<IBaseElem> customElem = nil;
    NSData *elemData = (NSData *)data;
    
    if(type == IM_FILE_TYPE)
    {   // 将data转化为IMFileMsgElem
        customElem = (IMFileMsgElem *)[PBCoder decodeObjectOfClass:[IMFileMsgElem class] fromData:elemData];
    }
    else if(type == IM_Audio_TYPE)
    {   // 将data转化为IMAudioMsgElem
        customElem = (IMAudioMsgElem *)[PBCoder decodeObjectOfClass:[IMAudioMsgElem class] fromData:elemData];
    }
    return customElem;
}

@end