Android-日志库Timber/Xlog

Timber

Google官方Demo使用的日志库

 implementation 'com.jakewharton.timber:timber:4.7.1'

详细用法参考:

Timber

Timber说明:

• 默认的Tree是DebugTree,继承自Tree

     /**
       * Return whether a message at {@code priority} should be logged.
       * @deprecated use {@link #isLoggable(String, int)} instead.
       */
      @Deprecated
      protected boolean isLoggable(int priority) {
        return true;
      }
  
      /** Return whether a message at {@code priority} or {@code tag} should be logged. */
      protected boolean isLoggable(@Nullable String tag, int priority) {
        //noinspection deprecation
        return isLoggable(priority);
      }
  

  isLoggable控制日志是否显示,看源码DebugTree Log是一直显示

• 每个Tree都是独立的个体，各自控制日志的输出和开关

• DebugTree中getTag有TAG的显示逻辑，tag不设置的时候，默认用的是类名

    @Nullable
      protected String createStackElementTag(@NotNull StackTraceElement element) {
        String tag = element.getClassName();
        Matcher m = ANONYMOUS_CLASS.matcher(tag);
        if (m.find()) {
          tag = m.replaceAll("");
        }
        tag = tag.substring(tag.lastIndexOf('.') + 1);
        // Tag length limit was removed in API 24.
        if (tag.length() <= MAX_TAG_LENGTH || Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
          return tag;
        }
        return tag.substring(0, MAX_TAG_LENGTH);
      }
  
      @Override final String getTag() {
        String tag = super.getTag();
        if (tag != null) {
          return tag;
        }
  
        // DO NOT switch this to Thread.getCurrentThread().getStackTrace(). The test will pass
        // because Robolectric runs them on the JVM but on Android the elements are different.
        StackTraceElement[] stackTrace = new Throwable().getStackTrace();
        if (stackTrace.length <= CALL_STACK_INDEX) {
          throw new IllegalStateException(
              "Synthetic stacktrace didn't have enough elements: are you using proguard?");
        }
        return createStackElementTag(stackTrace[CALL_STACK_INDEX]);
      }
  

• setTag只决定当前行

微信Xlog

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

MMAP机制

MMAP。MMAP是一种内存映射文件的方法，即将一个文件或者其它对象映射到进程的地址空间，实现文件磁盘地址和进程虚拟地址空间中一段虚拟地址的一一对应关系。

[图片上传失败...(image-569296-1574993131425)]

简单来说，MMAP实际是一段内存空间，我们可以实时将日志写入MMAP，因为它是内存，所以速度非常快；而另外，它也不存在丢失风险，因为在如内存不足，进程退出的时候操作系统会自动回写文件，因此也极大降低了丢失的风险。

XLog的短语式压缩

在压缩方面，xLog采用的方案是每产生一条日志，都进行压缩且写入MMAP。这里采用的压缩算法是LZ77压缩。压缩率可以达到83.7%。

LZ77是一种基于字典的算法，它将长字符串（也称为短语）编码成短小的标记，用小标记代替字典中的短语，从而达到压缩的目的。

这种压缩算法的核心就是从以前压缩的内容里找到相同的短语，然后把当前的文本短语换成数字，参考下图：

Github官方地址:

Mars

XLog说明:

• 默认是debugLog,调的系统的日志输出

  private static LogImp debugLog = new LogImp() {
          private Handler handler = new Handler(Looper.getMainLooper());
  
          @Override
          public void logV(String tag, String filename, String funcname, int line, int pid, long tid, long maintid, String log) {
              if (level <= LEVEL_VERBOSE) {
                  android.util.Log.v(tag, log);
              }
          }
  
          @Override
          public void logI(String tag, String filename, String funcname, int line, int pid, long tid, long maintid, String log) {
              if (level <= LEVEL_INFO) {
                  android.util.Log.i(tag, log);
              }
          }
  
          @Override
          public void logD(String tag, String filename, String funcname, int line, int pid, long tid, long maintid, String log) {
              if (level <= LEVEL_DEBUG) {
                  android.util.Log.d(tag, log);
              }
  
          }
  
          @Override
          public void logW(String tag, String filename, String funcname, int line, int pid, long tid, long maintid, String log) {
              if (level <= LEVEL_WARNING) {
                  android.util.Log.w(tag, log);
              }
  
          }
                        ...
  }
  

• 每次启动时会删除过期文件，只保留十天内的日志文件(该值定义在appender.cc中的 kMaxLogAliveTime )，所以给 Xlog 的目录请使用单独目录，防止误删其他文件。

• 立即更新文件

  Log.appenderFlush(true);
  

• 退出关闭日志

  Log.appenderClose();
  

• application初始化配置

          final String logPath = LocalFileManager.createLogFolder(this);
          final String cachePath = this.getFilesDir() + "/xlog";
          Xlog.open(true,Xlog.LEVEL_ALL, Xlog.AppednerModeAsync, cachePath, logPath, "MarsSample", "");
          Xlog.setConsoleLogOpen(!AppUtil.isPRDReleaseEnv());
          Log.setLogImp(new Xlog());
  

• log存储

  • 在sd卡读取权限开启的情况下

    文件存储在logPath

  • 如果sd卡读取权限未开启

    文件存储在cachePath

  • 如果sd卡权限从未开启到开启

    会将cachePath的文件拷贝一份到logPath

• 文件解密

  python xxxx/mars/log/crypt/decode_mars_nocrypt_log_file.py xxxxx.log
  

• 自定义存储文件,暂不支持 issue有说明 后期会拓展

强调:

一定要在合适的时机调

Log.appenderFlush(true);
Log.appenderClose();