Mars笔记

官方文档

启动本地服务 cd 到 server文件夹中执行 python start_server.py命令

Mars是微信提供的终端基础组件,是跨平台的

主要包括以下几个部分
  • comm : 基础库,包括socket、线程、消息队列、协程等基础工具
  • Xlog : 通用日志模块,提供高性能、高可用、安全性、容错性的日志功能
  • SDT : 网络诊断模块
  • STN : 信令传输网络模块,负责终端与服务器的小数据信令通道。

消息核心流程:一个消息任务以startTask开始,onTaskEnd结束。中间通过StnCallBack::Req2Buf与StnCallBack::Buf2Resp分别处理客户端的请求和响应的相关操作,比如数据处理,服务端响应和状态检测等等。

项目配置
  • 安装 cmake 和 XCode 以及 python2.7.x
  • python build_ios.py 生成配置文件
  • 数据传输使用谷歌的protocol buffer
  • 添加依赖库
    • CoreTelephony.framework
    • UIKit.framework
    • Foundation.framework
    • libz.tbd
    • SystemConfiguration.frmaework
    • libresolv9.tbd
    • mars.framework(由Mars提供的库)

STN 网络模块初始化

  • 涉及初始化方法,在
    didFinishLaunchingWithOptions 中调用

在初始化时必须先调用setCallback方法,最后在调用onForegroundmakesureLongLinkConnect中间的顺序可以随意

注意:STN 默认是后台,在初始化 STN 后需要主动调用一次BaseEvent.onForeground(true)

程序退出或进入后台时,释放STN
调用

mars::baseevent::OnDestroy();
- (void)setCallBack {
    mars::stn::SetCallback(mars::stn::StnCallBack::Instance());
    mars::app::SetCallback(mars::app::AppCallBack::Instance());
}

- (void) createMars {
    mars::baseevent::OnCreate();
}

- (void)setClientVersion:(UInt32)clientVersion {
    mars::stn::SetClientVersion(clientVersion);
}

- (void)setShortLinkDebugIP:(NSString *)IP port:(const unsigned short)port {
    std::string ipAddress([IP UTF8String]);
    mars::stn::SetShortlinkSvrAddr(port, ipAddress);
}

- (void)setShortLinkPort:(const unsigned short)port {
    mars::stn::SetShortlinkSvrAddr(port);
}

- (void)setLongLinkAddress:(NSString *)string port:(const unsigned short)port debugIP:(NSString *)IP {
    std::string ipAddress([string UTF8String]);
    std::string debugIP([IP UTF8String]);
    std::vector<uint16_t> ports;
    ports.push_back(port);
    mars::stn::SetLonglinkSvrAddr(ipAddress,ports,debugIP);
}

- (void)setLongLinkAddress:(NSString *)string port:(const unsigned short)port {
    std::string ipAddress([string UTF8String]);
    std::vector<uint16_t> ports;
    ports.push_back(port);
    mars::stn::SetLonglinkSvrAddr(ipAddress,ports);
}

数据处理

集成的时候加上日志打印 xlog,在 main中添加,因使用c++main.m,改为main.mm,方便排查问题

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", "");
  • 开启一个任务
// ChannelType_LongConn  通道 有长链、短链或者两者
// IM_CMD_LOGIN  CIMID号,自定义表示那种任务
// LONG_LINK_HOST_PROT  长链地址
// CGIURL  短链地址
CGITask * task = [[CGITask alloc] initAll:ChannelType_LongConn AndCmdId:IM_CMD_LOGIN AndCGIUri:CGIURL AndHost:LONG_LINK_HOST_PROT];
    [[NetworkService sharedInstance] startTask:task ForUI:self];

task 中关键字

  • taskid 任务的唯一标识,自动生成
  • channel_select 标识是长连接还是短连接获取两者,属性有:
    • ChannelType_ShortConn, ChannelType_LongConn, ChannelType_All
  • cgi 短连的utl, 短连的必填
  • cmid: 长连的cgi命令号,用于标识长连请求的cgi 如: IM_CMD_LOGIN
  • 发送数据requestSendData 向服务端发送数据,这里是发起登录请求

- (NSData *)requestSendData{
    // 自定义的一个pb解析类,和自定义些参数
    ImLogin * login = [[ImLogin alloc] init];
    Head * heads = [[Head alloc] init];
    heads.cmd = IM_CMD_LOGIN; 
    heads.seq = 1; 
    heads.version = 200; 
    heads.flag = 0;
    //  这里是做登录的,传相应的参数给服务端
    login.head = heads;
    login.no = @"ABC";
    login.token = @"abcd";
    login.timestamp = 829374432;
    login.devId = 37489237434;
    login.role = ROLE;
    login.platformId = 1;
   //  将数据转为data
    NSData * data = [login data];
    return data;
}
  • 收到服务返回
- (int)onPostDecode:(NSData *)responseData{
    NSError * error;
// 登录pb解析类,解析数据
    ImLoginRes * loginRes = [ImLoginRes parseFromData:responseData error:&error];
   // 这里返回 200 表示登录成功
    if (loginRes.code == 200) {
        dispatch_async(dispatch_get_main_queue(), ^{
            NSInteger uid = loginRes.uid;
            self.uids = loginRes.uid;
            if (self.iMLoginUserIdBlock) {
                self.iMLoginUserIdBlock(uid);
            }
        });
        // 可做登录后的事,如:保存消息偏移量或发起消息同步等
    }
    return loginRes.code == 200 ? 0 : -1;
}
- (int)onTaskEnd:(uint32_t)tid errType:(uint32_t)errtype errCode:(uint32_t)errcode{
    return 0;
}
  • 修改心跳设置

longlink_packer.cc

修改这个方法
uint32_t (*longlink_noop_interval)() = []() -> uint32_t { return 1 * 60 * 1000; };return为0时,会执行Mars自己的心跳逻辑

  • 设置用户名
    为保持心跳的连接频率,需设置用户名,否则Mars会降低请求的频率
AccountInfo AppCallBack::GetAccountInfo() {
    AccountInfo info;
    info.username = "wxy";
    info.uin = 11984;
    return info;
}
  • 出现C++方法中未定义的错误
    修改 Build Setting -> Apple Clang - Language - c++
    修改地方.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 198,322评论 5 465
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,288评论 2 375
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 145,227评论 0 327
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,015评论 1 268
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,936评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,534评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,995评论 3 389
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,616评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,907评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,923评论 2 315
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,741评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,525评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,016评论 3 301
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,141评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,453评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,054评论 2 343
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,249评论 2 339

推荐阅读更多精彩内容