微信Mars使用说明

Mars组件结构
Mars组件结构

github源码地址为https://github.com/Tencent/mars#mars_cn

使用前准备

将源码下载到本地,编译位于源码文件夹下的/mars/libraries/build_apple.py

python build_apple.py

编译成功得到

把 mars.framework 作为依赖加入到项目中,把和 mars.framework 同目录的后缀名为 rewriteme 的文件名删掉".rewriteme"和头文件一起加入到项目中,另外工程还需要导入的文件有:

在Mars源码文件夹下iOSDemo工程里还有需要导入的文件,包括:

使用

xlog组件

xlog组件为日志记录组件,使用时需要在main函数里初始化:

NSString* logPath = [[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0] stringByAppendingString:@"/log"];

// set do not backup for logpath
const char* attrName = "com.apple.MobileBackup";
u_int8_t attrValue = 1;
setxattr([logPath UTF8String], attrName, &attrValue, sizeof(attrValue), 0, 0);

// init xlog
#if DEBUG
xlogger_SetLevel(kLevelDebug);
appender_set_console_log(true);
#else
xlogger_SetLevel(kLevelInfo);
appender_set_console_log(false);
#endif
appender_open(kAppednerAsync, [logPath UTF8String], "Test");

在 applicationWillTerminate 函数中反初始化:

appender_close();

需要注意:

  • 保存 log 的目录请使用单独的目录,不要存放任何其他文件防止被 xlog 自动清理功能误删。
  • 请把 log 目录设上不备份的标识。
  • debug 版本下建议把控制台日志打开,日志级别设为 Debug, release 版本建议把控制台日志关闭,日志级别使用 Info.

stn组件

在 didFinishLaunchingWithOptions 函数中或者使用网络之前进行初始化:

[NetworkService sharedInstance].delegate = [[NetworkEvent alloc] init];
[[NetworkService sharedInstance] setCallBack];
[[NetworkService sharedInstance] createMars];
[[NetworkService sharedInstance] setClientVersion:200];
[[NetworkService sharedInstance] setLongLinkAddress:@"www.marsopen.cn" port:8081];
[[NetworkService sharedInstance] setShortLinkPort:8080];
[[NetworkService sharedInstance] reportEvent_OnForeground:YES];
[[NetworkService sharedInstance] makesureLongLinkConnect];
    
[[NetworkStatus sharedInstance] Start:[NetworkService sharedInstance]];

在程序退出时或需要释放 stn 时调用:

[[NetworkService sharedInstance] destroyMars];

当发生前后台切换时调用:

[[NetworkService sharedInstance] reportEvent_OnForeground:NO];
[[NetworkService sharedInstance] reportEvent_OnForeground:YES];

程序进入后台时选择NO,程序将要回到前台时选择YES。

消息发送

发送消息需要具体controller遵循代理UINotifyDelegate:

-(NSData*)requestSendData

该函数为将要发送的数据打包,demo中使用的数据格式为ProtocolBuffer,我们可以使用json数据格式。

-(int)onPostDecode:(NSData*)responseData

该函数为发送消息后接收到的服务器返回的消息数据解包。

-(int)onTaskEnd:(uint32_t)tid errType:(uint32_t)errtype errCode:(uint32_t)errcode

该函数为请求任务结束的回调,用于捕捉处理错误信息。

消息接收

接收消息需要具体controller遵循代理PushNotifyDelegate:

-(void)notifyPushMessage:(NSData*)pushData withCmdId:(int)cmdId

该函数为接收消息回调,解包数据后更新UI。

与服务端配合

首先来看官方的两个问题和答案:

如果我已经有现有服务器端了,客户端想使用 Mars,需要服务器做什么工作?

如果你已经深入了解了 Mars,感觉自己适合使用 Mars的,需要先理解长短连协议和加解包的区别。不论之前使用的哪种方式,长短连的协议是必须有的,你需要参照自定义扩展把长短连协议和服务器端对齐, 至于加解包逻辑是在 Req2Buf 和 Buf2Resp 回调中做的,给上实现就可以了。关于长短连协议的理解和 req2Buf buf2Resp 的理解可以看一个例子:就像你用 HTTP 发一个 json 数据 HTTP 就类似 Mars 的长短连协议, json 的组装和解析就是 req2Buf 和 buf2Resp 来做的

如果我已经有现有服务器端了,客户端想使用 Mars,客户端需要注意什么?

longlink_packer.cc中的自定义需要注意。心跳包的cmdid一定要和服务器的对应上,否则可能发生心跳包超时导致长连断开。longlink_complexconnect_need_verify的含义是如果设为 true 经过心跳包验证的连接才认为是成功的连接。如果你的长连接建立连接后第一个包必须是验证包,该函数的返回值一定要设为false。 长连的鉴权是会回调GetLonglinkIdentifyCheckBuffer这个函数,实现即可,记得处理回包:OnLonglinkIdentifyResponse,需要区分开长连接的鉴权和用户的登陆。长连的鉴权只是用来表示这个长连接是某个人的,不要用来做登陆功能。 强调:需要注意,mars长连的请求包和回包的对应关系的条件是seq一样,所以服务器对请求的回应要保证seq一样,或者可以自己在longlink_taskmanger.cc里修改(不推荐)。

因此与服务端配合需要对齐长短连协议以及数据的加解包格式,后者在UINotifyDelegate、PushNotifyDelegate的回调中实现,而长短连协议的自定义在以下几个函数中实现:

void longlink_pack(uint32_t _cmdid, uint32_t _seq, const void* _raw, size_t _raw_len, AutoBuffer& _packed);
int  longlink_unpack(const AutoBuffer& _packed, uint32_t& _cmdid, uint32_t& _seq, size_t& _package_len, AutoBuffer& _body);
void shortlink_pack(const std::string& _url, const std::map<std::string, std::string>& _headers, const AutoBuffer& _body, AutoBuffer& _out_buff);
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,530评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,403评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,120评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,770评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,758评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,649评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,021评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,675评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,931评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,751评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,410评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,004评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,969评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,042评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,493评论 2 343

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,431评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • __block和__weak修饰符的区别其实是挺明显的:1.__block不管是ARC还是MRC模式下都可以使用,...
    LZM轮回阅读 3,282评论 0 6
  • 首发地址:微信 Mars Android Sample 源码分析 注:为了避免看得懵逼(当然可能是我写得不好~),...
    cfanr阅读 7,121评论 3 23
  • 段落标题既是整篇文章的骨架,又是每个层次、段落的提领。大家都有一种体会,就是相同的内容、材料,好的标题能给文章增色...
    huoxing02阅读 1,313评论 0 1