可以这样说,Log日志是除了debug外我们调试程序的全部了,但是在实际的开发中,系统原生的Log功能并不强大,它只能打印简单的字符串,如果碰到JSON,MAP一类的特殊字符串它的打印效果将极其糟糕。

机缘巧合下,我有幸见在github上见到了一个功能很强大的LOG日志库Logger,它功能强大,当你使用它打印LOG日志时,它不仅能把普通的字符串打印出来,甚至能定位你打印的位置。并且它能直接将JSON字符串格式化并打印出来,省下了我们手动格式化JSON字符串的时间。

下面是它的打印效果图
效果图

简单Logger日志实现

好了,看完Logger的功能介绍和效果图,想必你也很心动,也想要搞这样一个Logger库。
现在如果你想拥有这样一个日志系统,那么有两个简单的方法来供你选择:
一、Clone 点击我,然后关闭此窗口…
二、继续往下看。


非常感谢你留下来继续看我的废话,现在让我们一起研究Logger的主要功能吧!

JSON格式化部实现

当我第一次使用Logger JSON格式化的功能时,我心情是悲伤的,因为它让我抛弃了陪伴我多年的JSON格式化网页。本着无比悲痛的心情,有生以来我第一次极其认真的查看了开源项目的代码。
后来,看完代码后的我,心情是崩溃的,原本以为JOSN格式化这么高达上的功能一定是很复杂的代码实现,后来发现尼玛就一行代码就能搞定,这是什么鬼啊,说好的复杂代码呢??

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/**
* 打印JSON
*
* @param jsonStr
*/
public static void j(String jsonStr) {
if (isDebug) {
String message;
try {
if (jsonStr.startsWith("{")) {
JSONObject jsonObject = new JSONObject(jsonStr);
message = jsonObject.toString(JSON_INDENT); //这个是核心方法
} else if (jsonStr.startsWith("[")) {
JSONArray jsonArray = new JSONArray(jsonStr);
message = jsonArray.toString(JSON_INDENT);
} else {
message = jsonStr;
}
} catch (JSONException e) {
message = jsonStr;
}

message = LINE_SEPARATOR + message;
String[] lines = message.split(LINE_SEPARATOR);
StringBuilder sb = new StringBuilder();
printLog(D, lines);//请不要关注这行,这是控制台输出的Log方法
}
}

以上就是JSON格式化的方法,想必你和我当初一样充满了错愕,我们每天都在用toString()、toString()…然后竟然不知道还有个toString(int xxxx)的重载方法!!!!

是的,高大上的JSON格式化功能不需要你998行代码,也不需要你99行代码,没错,你没看错,它就只需要你一行toString(int xxxx),并且附带赠送你xxxx个缩进空格!!

代码定位的实现

当年,我还是个孩子的时候我就知道我很无知,后来当我看了Logger的Json格式化代码的实现后,我已经对它不屑一顾。后来当我看了代码定位的功能后,我觉得我还是太年轻了…

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
* 代码定位
*
* @param type
*/
private static void printLocation(char type, String... msg) {
StackTraceElement[] stack = Thread.currentThread().getStackTrace();
int i = 0;
//获取代码所运行的位置
for (StackTraceElement e : stack) {
String name = e.getClassName();
if (!name.equals(L.class.getName())) {
i++;
} else {
break;
}
}
//进行方法位置偏移
i += 3;
//当我能准确获取到I时,本部分已经完结,以下代码都是废话,请不要关注
String className = stack[i].getFileName();
String methodName = stack[i].getMethodName();
int lineNumber = stack[i].getLineNumber();
StringBuilder sb = new StringBuilder();
printHunk(type, HORIZONTAL_DOUBLE_LINE + " Location:");
sb.append(HORIZONTAL_DOUBLE_LINE)
.append(" (").append(className).append(":").append(lineNumber).append(")# ").append(methodName);
printHunk(type, sb.toString());
printHunk(type, msg == null || msg.length == 0 ? BOTTOM_BORDER : MIDDLE_BORDER);
}

注:上面并不是纯粹的Logger源码,那是我根据Logger的思路自己写的代码定位功能,事实上Logger源代码那部分写得很优秀,但是你也懂的,优秀也就意味着代码不好看懂…

好吧,我承认,我当初就是因为看这部分看得心烦,感觉很不爽,然后一怒之下,根据它的思路重新来写的。。。

好吧,现在来所说代码定位的原理。
如下图所示:
元素拦截
我想,上面的图你一定很熟悉,没错,那就是我们经常用的debug 然后watch某个元素时候的界面。
在上面的图片中,我们看到了一堆数组,其中圈红色的部分是不是感觉有点特殊,因为包名并不是系统的包名,那些都是我们自己的类,自己的方法的元素。

现在,我想聪明的你已经懂了,代码定位的原理是通过Thread.currentThread().getStackTrace()方法获取到所有的运行元素,并根据获取到的数组,进行一定的偏移来准确捕获Looger( )被调用的真正位置。

根据JVM的运行原理,每当JVM执行一个方法时,它都会把该方法压到一个方法栈里面,根据栈的后入先出原则,我们可以知道,Logger( )被调用的位置一定是方法栈里面最先被压入的函数的位置。也就是红圈里面的最后一个元素。也就是我为什么要 i += 3的原因;

附上我自己写的类L(Logger)的调用流程:
L流程

我们终于获取到了代码所在行的确切位置了,要在控制台上实现代码定位也就简单多了。

根据获取到的StackTraceElement元素,我们能通过api接口获取到运行类的类名及其该方法所被调用的位置,然后按照下面的格式进行封装,便能实现控制台代码的定位。
代码定位格式:
(类名:代码行)
只要按照上面的规则进行组合类名和行,再通过系统提供的Log进行输出,便能通过控制台直接跳转到所在的代码行。

打印Map

这个没啥好说的…

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/**
* 打印MAp
*/
public static void m(Map map) {
Set set = map.entrySet();
if (set.size() < 1) {
printLog(D, "[]");
return;
}

int i = 0;
String[] s = new String[set.size()];
for (Object aSet : set) {
Map.Entry entry = (Map.Entry) aSet;
s[i] = entry.getKey() + " = " + entry.getValue() + ",\n";
i++;
}
printLog(V, s);
}

最终效果

最终效果

最重要的还是放在最后面

我是伟大的DEMO