前言
Mars 是微信官方的跨平台跨业务的终端基础组件，基于C++语言开发，可支持Android、iOS、Mac、Windows 平台。
包含四大模块
- comm：可以独立使用的公共库，包括 socket、线程、消息队列、协程等；
- xlog：高可靠性高性能的运行期日志组件；
- SDT： 网络诊断组件；
- STN： 信令分发网络模块，也是 Mars 最主要的部分。
本篇主要介绍iOS下集成mars 的 xlog日志系统指南。
iOS接入项目全过程
一、Clone mars 项目
这里用的ssh方式克制， 如果没有配置github ssh,可以选择https的，这里不多赘述。
git clone git@github.com:Tencent/mars.git
二、 编译Mars
由于 Mars 是采用C++编写，我们需要编译Mars才可以导入到iOS项目中。这里我分步讲解。
- 检查是否安装cmake
如果没有则需要安装
which cmake
/usr/local/bin/cmake
安装cmake 采用brew 安装,如果没有安装brew 请自行百度安装。
brew install cmake
- 编译mars
mars项目有许多py脚本一键编译，这里采用ios的脚本
// 进去项目的 mars 文件夹中
cd ./mars/mars
python build_ios.py
//然后选择 2 Clean && build xlog （由于只集成xlog 我们选2即可) 等待编译
当看到如下文案既是编译成功
==================Output========================
cmake_build/iOS/Darwin.out/mars.framework
三、 导入framework到项目中
将/mars/mars/cmake_build/iOS/Darwin.out/mars.framework 拖入到iOS项目中
[图片上传失败...(image-969f3e-1658282875387)]
导入如下系统Frameworks
[图片上传失败...(image-de8429-1658282875387)]
- 将AppDelegate.m 改为 AppDelegate.mm 兼容c++
[图片上传失败...(image-e7982f-1658282875387)]
四、编写Helper方法，可以参考Mars iOS Demo
[图片上传失败...(image-44eab0-1658282875387)]
JRXlogManager 为基于Mars中 ios demo Helper类编写的单例子
@interface JRXlogManager : NSObject
+ (instancetype)shared;
- (void)initXlog:(const char *)prefixName pathName:(NSString *)pathName;
/** 关闭Xlog */
- (void)closeXlog;
- (void)log:(XLoggerType)level tag:(const char *)tag content:(NSString *)content;
- (void)infoLogWithTag:(const char *)tag Content:(NSString *)content;
- (void)debugLogWithTag:(const char *)tag Content:(NSString *)content;
- (void)errorLogWithTag:(const char *)tag Content:(NSString *)content;
- (void)warningLogWithTag:(const char *)tag Content:(NSString *)content;
@end
- 初始化Xlog
这里我选择在app didfinish中初始化， 实际应该在登录中切换，demo项目就随意一点了。
[[JRXlogManager shared] closeXlog];
[[JRXlogManager shared] initXlog:[@"test_xlog_userId" UTF8String] pathName:XlogDirName];
[[JRXlogManager shared] infoLogWithTag:JRDebugMessage Content:@"App init()"];
- 核心方法
其中pub_key 对应 一个private_key 到时解码xlog文件的时候 要替换脚本里面的一个private_key ， mars 也提供了 gen_key.py 脚本 生成 RSA Key。在 /mars/mars/log/crypt 目录中
- (void)initXlog:(const char *)prefixName pathName:(NSString *)pathName {
NSString* logPath = getXlogPath(pathName);
// 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);
mars::xlog::appender_set_console_log(true);
#else
xlogger_SetLevel(kLevelInfo);
appender_set_console_log(false);
#endif
mars::xlog::XLogConfig config;
config.mode_ = mars::xlog::kAppenderAsync;
config.logdir_ = [logPath UTF8String];
config.nameprefix_ = prefixName;
config.compress_mode_ = mars::xlog::kZlib;
config.compress_level_ = 0;
config.cachedir_ = "";
config.cache_days_ = 0;
// config.pub_key_ = "";
config.pub_key_ = "572d1e2710ae5fbca54c76a382fdd44050b3a675cb2bf39feebe85ef63d947aff0fa4943f1112e8b6af34bebebbaefa1a0aae055d9259b89a1858f7cc9af9df1";
// PRIV_KEY = "145aa7717bf9745b91e9569b80bbf1eedaa6cc6cd0e26317d810e35710f44cf8"
// PUB_KEY = "572d1e2710ae5fbca54c76a382fdd44050b3a675cb2bf39feebe85ef63d947aff0fa4943f1112e8b6af34bebebbaefa1a0aae055d9259b89a1858f7cc9af9df1"
appender_open(config);
}
五、上传日志
xlog日志已经存到到你设置的沙盒路径，正常来说你要拿这个沙盒路径上传到自己服务器，你可以选择定时上传 也可以选择强拉用户数据（依赖socket 推送到客户端）。 当然开发模式情况下 我们可以选择自己上传，使用苹果自带的UIActivityViewController 就可以很轻松的使用Air Drop发到自己mac 或者 复制到微信。具体代码可以看我下面的demo地址源码
[图片上传失败...(image-b8921d-1658282875387)]
六、解析日志
方法一
mars 目录/mars/mars/log/crypt 下 提供了三个脚本，我们去解析xlog日志。但是如果你直接使用应该会报错，它有很多模块依赖，需要你一一用pip去安装。
分别是
- decode_mars_crypt_log_file.py
此为加密的解析方式，需要替换里面的private_key 参数
- decode_mars_nocrypt_log_file.py
此为不加密的解析，如果你ios项目中的pub_key 为空传，也就是不加密，就用这个py脚本解析。
- gen_key.py
生成一对新的RSA 可以
方法二
使用我用Flutter Desktop开发的 XlogDecoder解析桌面工具。目前只支持Mac， 稍后会支持window。 无需任何py环境,直接把xlog日志，或文件夹拖到窗口即可。 会自动给你解析出相应日志。支持加密与不加密，加密的话需要你手动输入private_key
[图片上传失败...(image-394be2-1658282875387)]
七、附件地址
末尾
后续我编写的xlog docoder GUI 也会编写相应文章，详细说明原理 欢迎git hub star 以及 掘金点赞。
