背景
最近看了幾個(gè)日志框架,最后發(fā)現(xiàn)Logger
擴(kuò)展性最好,顯示效果也非常整齊,但Logger
每個(gè)日志都是最少分為兩部分顯示(頭部+日志內(nèi)容)
,連上分割線最少顯示五行,在日志很多的時(shí)候,會(huì)極為占空間,基于該原因,在該庫(kù)的基礎(chǔ)上進(jìn)行了一些修改,整理了一個(gè)可以精簡(jiǎn)顯示日志的庫(kù),并擴(kuò)展了一些其他功能,使用方式和原Logger
庫(kù)幾乎一致。
介紹
項(xiàng)目地址:https://github.com/naturs/Logger
其中參考的庫(kù)主要包括:
https://github.com/orhanobut/logger
https://github.com/ZhaoKaiQiang/KLog
https://github.com/JakeWharton/timber
https://github.com/pengwei1024/LogUtils
該庫(kù)除了原Logger
庫(kù)的特點(diǎn)以外,還包括以下特性:
- 將項(xiàng)目更改為Java工程,可以在Java平臺(tái)上輸出日志;
- 支持顯示簡(jiǎn)化的日志信息;
- 添加了對(duì)Collection、Map、多維數(shù)組、Intent、Bundle的格式化輸出;
- 支持指定調(diào)用方法棧;
- 大部分實(shí)現(xiàn)都能更改和替換;
使用方式
添加依賴
如果是Java平臺(tái),僅需添加核心依賴:
compile 'com.github.naturs.logger:logger-core:0.3'
如果是Android平臺(tái),還可以添加以下依賴,主要添加了對(duì)Intent、Bundle的格式化輸出,以及Logcat日志顯示支持:
compile 'com.github.naturs.logger:logger-android:0.3'
初始化
使用該庫(kù)之前,需要進(jìn)行初始化,主要是針對(duì)全局進(jìn)行一些設(shè)置。
如果是Java平臺(tái),可以進(jìn)行如下初始化操作:
// 以System.out.println()的方式輸出日志
Logger.addLogAdapter(new DefaultLogAdapter("Your Global Tag"));
Logger.setLogConverter(new DefaultLogConverter());
這兩個(gè)方法的作用分別為:
Logger.addLogAdapter()
:
添加日志顯示及輸出方式,顯示由DefaultLogAdapter
中的成員變量FormatStrategy
控制,它的作用主要是格式化日志,比如添加分割線、添加Log行數(shù)等,最后將格式化后的日志通過LogStrategy
輸出,比如DefaultLogAdapter
默認(rèn)的日志輸出方式為DefaultLogStrategy
,即使用System.out.println()
輸出。
我們可以添加多個(gè)LogAdapter
,比如部分日志需要輸出到文件,我們就可以自定義一個(gè)記錄到文件的LogAdapter
,添加進(jìn)來即可。
Logger.setLogConverter()
:
添加Log轉(zhuǎn)換方式,比如將Map、Intent這樣的對(duì)象轉(zhuǎn)換成一個(gè)格式化后的字符串,由于默認(rèn)帶有多個(gè)Converter,這里使用LogConverter進(jìn)行統(tǒng)一管理,同時(shí)方便外部調(diào)用。
最終Log輸出方式為:
Logger -> ConverterStrategy(轉(zhuǎn)換格式) -> LogAdapter -> FormatStrategy(添加額外信息并格式化) -> LogStrategy(輸出)
如果是Android平臺(tái),可以進(jìn)行如下初始化操作:
Logger.addLogAdapter(new AndroidLogAdapter("Your Global Tag"));
Logger.setLogConverter(new AndroidLogConverter());
功能和上面Java初始化方式一致。
使用
1、簡(jiǎn)單使用方式:
Logger.d("message");
Logger.i("message");
Logger.e(Throwable);
調(diào)用時(shí)會(huì)采用調(diào)用者的類名作為Tag,如果在初始化時(shí)指定了全局Tag,最終的Tag為:GlobalTag-YourTag
。
2、如果要自定義Tag:
Logger.tag("your tag").d("message");
3、如果要輸出格式化后的json或xml:
Logger.json(json);
Logger.xml(xml);
4、如果要輸出格式化后的對(duì)象:
Logger.obj(object);
目前Object類型支持Collection
、Map
、多維數(shù)組
、Bundle
、Intent
,同時(shí)你也可以自定義Object轉(zhuǎn)換方式:
- 實(shí)現(xiàn)
ConverterStrategy
接口; - 在初始化時(shí)通過
Logger.addConverterStrategy()
方法加進(jìn)去;
5、如果你需要對(duì)Logger
再進(jìn)行一層封裝,你可以寫成這樣:
public class LogUtils {
public static void d(String msg) {
Logger.d(msg);
}
}
但調(diào)用LogUtils.d()
方法時(shí),Tag和最終顯示的方法行數(shù)都會(huì)從LogUtils.java
中獲取,也就是沒法獲取到調(diào)用LogUtils.d()
方法的類的信息,這里可以稍作修改:
public class LogUtils {
public static void d(String msg) {
Logger.invokeClass(LogUtils.class).d(msg);
}
}
invokeClass()
方法指定的是調(diào)用Logger的那個(gè)類,如果不指定則為當(dāng)前類。