微信Mars——xlog使用全解析
微信Mars——xlog使用全解析
如约而至，微信在12月19日开源了底层的通信库——Mars，其中有一个部分，是一个高性能的日志模块——xlog。
xlog的详细介绍，大家可以参考微信技术公众号的这篇文章——微信终端跨平台组件 mars 系列（一） - 高性能日志模块xlog。
本篇文章将带领大家将xlog模块抽取出来，作为一个单独的模块来使用。
编译so库
首先，我们clone下Mars的源码，然后进入其中的libraries目录，直接执行下面的Python脚本：
python build_android.py注意，这里需要配置好本地的NDK编译环境，这里不赘述
Enter menu:
1. build mars static libs.
2. build mars shared libs.
3. build xlog static libs.
4. build xlog shared libs.
5. exit.我们需要编译两个库：3和4。
编译好之后，就会生成下面的文件：
我们需要的就是里面的Java文件和so库，将mars_android_sdk/src目录下的Java文件以及 libs/复制到你的项目中：
如图所示，工程的配置就完成了。
使用
权限
xlog可以加密每一行输出的文件并写入文件，所以需要下面的权限：
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>加载so
xlog需要使用到我们前面编译出的两个so库：
System.loadLibrary("stlport_shared");
System.loadLibrary("marsxlog");初始化
在代码中对xlog进行初始化：
final String SDCARD = Environment.getExternalStorageDirectory().getAbsolutePath();
final String logPath = SDCARD + "/marssample/log";
//init xlog
if (BuildConfig.DEBUG) {
Xlog.appenderOpen(Xlog.LEVEL_DEBUG, Xlog.AppednerModeAsync, "", logPath, "MarsSample");
Xlog.setConsoleLogOpen(true);
} else {
Xlog.appenderOpen(Xlog.LEVEL_INFO, Xlog.AppednerModeAsync, "", logPath, "MarsSample");
Xlog.setConsoleLogOpen(false);
}
Log.setLogImp(new Xlog());使用
使用xlog下的Log类就可以打Log了，跟使用Android原生的Log方式基本一样：
import com.tencent.mars.xlog.Log;
Log.d("xys", "xysxysxys");停止Log记录
在Application或者Activity的销毁方法中，进行xlog的关闭操作，从而生成日志文件：
Log.appenderClose();解析Log
Log生成完毕后，会在指定的路径下生成相应的日志文件：
shell@R7:/sdcard/marssample/log $ ll
-rw-rw---- root sdcard_r 153600 2016-12-30 17:06 MarsSample.mmap2
-rw-rw---- root sdcard_r 29633 2016-12-30 17:06 MarsSample_20161230.xlog其中MarsSample.mmap2是缓存文件，不用关心，我们需要的是.xlog文件，我们把这个文件pull出来，使用Mars提供的Python脚本进行解密。
找到Mars源码log/crypt/decode_mars_log_file.py下的这个文件，执行：
mars_xlog_sdk python decode_mars_log_file.py ~/Downloads/log/MarsSample_20161230.xlog即可生成对应的log文件，用Sublime即可打开：
相关内容
大部分的内容实际上都在Mars源码的wiki中，但是内容比较散，所以我这里做了一个比较通用的Guide。
https://github.com/Tencent/mars/wiki/Mars-%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98
https://github.com/Tencent/mars/wiki/Mars-Android-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
优势在哪
很多人可能会说，这玩意儿跟原生Log系统，还有log4j这类的日志系统，强大在哪呢？实际上，xlog的优势主要有以下几点：
效率、效率、效率：这是最重要的，通过C层去写日志
低内存、低CPU：性能优势大，不占内存CPU
功能丰富：与原生Log使用几乎一致，但增加了写入文件功能，同时自带加密
更多内容请关注我的微信公众号
