XLog是什么

腾讯开源的Mars项目中有个XLog日志库。

XLog是一个高性能文本存储方案，在真实环境中经受了微信数亿级别的考验，具有很好的稳定性。

由于其是使用C语言来实现的，故有占用性能、内存小，存储速度快等优点，支持多线程，甚至多进程的使用，支持定期删除日志，同时，拥有特定算法，进行了文件的压缩，甚至可以配置文件加密。

网上其实还有另外一个XLog的日志库，也很强大。但是这里要介绍的是腾讯项目中的XLog。

为什么开发XLog

先来看一下没有XLog，腾讯收到用户提的app问题后，腾讯理论上的处理流程：

当用户反馈问题后，腾讯需要联系用户，在用户愿意配合的前提下，去修改一些代码，增加一些关键性的日志，打包后让用户安装定制版app，然后进行复现，复现成功后还需要指导用户提取日志，将日志传给公司。等开发工程师拿到日志后，才能分析定位bug。这还是最理想的情况，实际生活中往往重启一下或者切换一下app，就不能复现出原来的bug。这个流程是由具体使用的日志方案所决定的。

例如Android平台使用java实现日志模块，每有一段日志就加密写进文件。这样在使用过程中不仅存在大量的GC，更致命的是因为有大量的IO需要写入，影响程序性能很容易导致程序卡顿。所以release版本只能选择把日志关掉。这就导致定位问题的效率低下，而且并不是每个需要定位的问题都能复现。太深入的就不讲了，应该也没什么人愿意看。

XLog就是为了解决上面这种“明知有问题，但是又无法定位是哪里导致的”这种尴尬局面开发的。

XLog在Android工程中的具体使用

第一步肯定是添加依赖：

implementation 'com.tencent.mars:mars-xlog:1.2.5'

第二步添加so库：

在main文件夹下面新建一个jniLibs文件夹，用于存放armeabi-v7a文件夹，里面的两个so文件，都是通过Mars工程编译后得到的。但是要完成Mars的编译其实挺麻烦的，需要ndk、cmake，如果是Windows环境还要visual studio。安装了最新版也许还会报错，反正挺掉头发的。

然后，不要忘了在gradle中配置abiFilters：

	ndk {
        abiFilters "armeabi-v7a"
    }

第三步是添加权限，AndroidManifest.xml里：

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

也可以在MainActivity或者MainApplication里面申请权限：

ActivityCompat.requestPermissions(this,new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE},123);

这里是以Java为编程语言的，如果有使用kotlin的同学，可以自行转换一下。

第四步就是初始化XLog了，如果前面没有在gradle中配置abiFilters，也可以在初始化之前加载一下so库，加载方法：

				//加载so库
        System.loadLibrary("c++_shared");
        System.loadLibrary("marsxlog");

初始化的代码：

        String logPath = this.getExternalFilesDir("").getPath() + "/test/xlog"; //日志地址
        String cachePath = this.getExternalFilesDir("").getPath() + "/test/xlog/cache"; //缓存地址
        Log.d("XLOG", logPath);
        Xlog xlog = new Xlog();
        xlog.setConsoleLogOpen(10,true); //是否把日志打印到控制台
        xlog.appenderOpen(Xlog.LEVEL_DEBUG, Xlog.AppednerModeAsync, cachePath, logPath, "dbxLog", 10); //开启日志

这里需要注意几点：

• 如果你的程序使用了多个进程，不要把多个进程的日志输出到同一个文件中，保证每个进程独享一个日志文件；
• 保存log的目录请使用单独的目录，不要存放任何其他文件防止被xlog自动清理功能误删；
• debug版本下建议把控制台日志打开，日志级别设为Verbose或者Debug，release版本建议把控制台日志关闭，日志级别使用Info；
• cachePath这个参数必传，mmap文件会放在这个目录，如果传空串，可能会发生SIGBUS的crash。

初始化都顺利完成后，就可以在后续业务代码中使用XLog打印日志了，比如这样：

        TextView tv = (TextView) findViewById(R.id.tv_one);
        tv.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Toast.makeText(MainActivity.this, "Hello", Toast.LENGTH_SHORT).show();
                com.tencent.mars.xlog.Log.i("test","hello world!");
            }
        });

最后别忘了在合适的生命周期中关闭日志，关闭方法如下：

Log.appenderClose()

获取log日志

从前面初始化的动作中，就可以知道日志都存放在了logPath的目录里面。可以直接通过adb pull取出来。

日志文件解压

直接获取到的是定义的前缀（appenderOpen方法中传入的nameprefix参数）+日期+.xlog的日志文件。

因为没有进行加密，使用Mars项目中的
decode_mars_nocrypt_log_file.py进行解压缩就可以：

python decode_mars_nocrypt_log_file.py dbxLog-20220502.xlog

执行完就能获取到直接阅读的.log文件了。

python
decode_mars_nocrypt_log_file.py文件在Mars的位置是：mars/log/crypt/。

需要注意的是这个解压脚本使用的是python2，如果你不想在本地安装python2，就想使用python3的话，可以自己对这个解压脚本修改一下。

总结

xlog相对以前的一些日志库，还是有很大提升的，但是项目的文档几乎没什么用，介绍十分潦草，没有对应的Api文档说明。网上的一些集成教程也因为版本的原因或多或少都有一些小坑，总能踩中几个。