高效的 Android 日志记录框架 ZLog

ZLog

用于记录 Android 运行时产生的日志、Crash 等信息并保存到本地文件中的框架。
代码地址:
https://github.com/0xZhangKe/ZLog

使用方式

首先添加 ZLog 依赖:

compile 'com.github.0xZhangKe:ZLog:3.0'

在使用前需要通过日志的输出文件夹对其初始化,例如下面这样:

ZLog.Init(String.format("%s/log/", getExternalFilesDir(null).getPath()));

一般来说可以在 Application 中的 onCreate() 方法中对其初始化,初始化完成后即可直接使用其中提供的方法输出日志,其中提供了一系列的打印日志的方法,使用方式如下:

ZLog.e("TAG", "Internet Error");

其中的日志输出的方法参数等等都是按照 Android 的日志工具 Log 来的,并且在调用 ZLog的方法后会自动调用 Log 对应的方法输出日志;
所以完全可以使用 ZLog替代 Log,因为使用 ZLog打印日志时,不仅会输出到文件中,还会调用 Log 中的相关方法打印到控制台;
为了灵活控制日志是否输出到日志文件还是单纯的只输出到控制台中,其中提供了两种控制方式控制其行为(默认情况下,日志会同时输出到控制台及日志文件中)。
第一种:调用 openSaveToFile() 或 closeSaveToFile() 方法开启或关闭整个 ZLog 框架的行为,比如只要调用了 closeSaveToFile() 方法,那么直到你调用 openSaveToFile() 方法前,所有的日志都不会输出到文件中,反之亦然;
第二种:针对单条日志文件,可以传一个 boolean 类型的参数控制,比如 ZLog.e(“TAG”, “Internet Error”, false) ,那么此条日志记录就不会输出到文件中。
具体可以查看下面的类文档。

日志文件的保存规则:

Error 类型日志保存到对应目录下的 errorLog1.txt 中,如果 errorLog1.txt 大小超过 1MB,则重新输出到 errorLog2.txt 中,以此类推,当 Error 类型的文件个数超过 9 个时,会自动清理所有 Error 类型的日志文件,并从 errorLog1.txt 重新开始;
INFO、DEBUG、WTF 类型的日志会保存到 log.txt 中,其他规则与同上;
CRASH 类型的文件会保存到 crash.txt 中,其他规则同上。

实现原理

在调用 ZLog.Init(String) 方法之后会通过日志保存的路径创建并初始化一个 LogQueue 对象并调用其 start() 方法,往后每次调用输出日志的方法都会像其中添加一条记录;
LogQueue 在初始化时会创建一个 LinkedBlockingQueue 阻塞队列用于存储日志,同时会通过日志保存的路径及LinkedBlockingQueue创建一条 LogDispatcher 线程,在调用其 start() 方法时,会启动 LogDispatcher 线程;
LogDispatcher 内有一个死循环用于不停地调用 take() 方法从阻塞队列 LinkedBlockingQueue 中取出一条日志信息并打印,如果 LinkedBlockingQueue 内没有日志数据线程则进入阻塞状态,直到有新的日志。

类文档

ZLog

public static synchronized void Init(String logDir)

初始化 ZLog, 必须先调用 Init 方法

Parameters:

logDir -> 保存日志的文件夹

public static void e(String TAG, String text)

输出错误信息,该方法内部会调用 Log.e(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

public static void e(String TAG, String text, boolean saveToFile)

输出错误信息,该方法内部会调用 Log.e(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

saveToFile -> 是否将该条日志输出到文件中

public static void e(String TAG, String text, Throwable e)

输出错误信息,该方法内部会调用 Log.e(TAG, text, e) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

e -> 异常信息

public static void e(String TAG, String text, Throwable e, boolean saveToFile)

输出错误信息,该方法内部会调用 Log.e(TAG, text, e) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

e -> 异常信息

saveToFile -> 是否将该条日志输出到文件中

public static void d(String TAG, String text)

输出 debug 信息,该方法内部会调用 Log.d(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

public static void d(String TAG, String text, boolean saveToFile)

输出 debug 信息,该方法内部会调用 Log.d(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

saveToFile -> 是否将该条日志输出到文件中

public static void i(String TAG, String text)

输出 info 信息,该方法内部会调用 Log.i(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

public static void i(String TAG, String text, boolean saveToFile)

输出 info 信息,该方法内部会调用 Log.i(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

saveToFile -> 是否将该条日志输出到文件中

public static void i(String TAG, String text, Throwable e)

输出 info 信息,此方法会将 text 与 e 组合之后输出,该方法内部会调用 Log.i(TAG, String.format("%s—>%s", text, e.toString())) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

e -> 异常信息

public static void i(String TAG, String text, Throwable e, boolean saveToFile)

输出 info 信息,此方法会将 text 与 e 组合之后输出,该方法内部会调用 Log.i(TAG, String.format("%s—>%s", text, e.toString())) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

e -> 异常信息

saveToFile -> 是否将该条日志输出到文件中

public static void wtf(String TAG, String text)

输出 wtf 信息,该方法内部会调用 Log.wtf(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

public static void wtf(String TAG, String text, boolean saveToFile)

输出 wtf 信息,该方法内部会调用 Log.wtf(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

saveToFile -> 是否将该条日志输出到文件中

public static void crash(String TAG, String text, boolean saveToFile)

输出 crash 信息,该方法内部会调用 Log.e(TAG, text) 方法将日志输出到控制台

Parameters:

TAG -> TAG 标签

text -> 要输出的文本

public static synchronized void openSaveToFile()

打开将日志保存到文件的开关

public static synchronized void closeSaveToFile()

关闭将日志保存到文件的开关

如果觉得还不错的话,欢迎关注我的个人公众号,我会不定期发一些干货文章~
高效的 Android 日志记录框架 ZLog_第1张图片

你可能感兴趣的:(android开发)