Android Logger 日志框架实现

写在前面

这篇文章也是我以前写在CSDN上的文章...


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

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

下面是它的打印效果图


效果图

简单Logger日志实现

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


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

JSON格式化部实现

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

    /**
     * 打印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格式化代码的实现后,我已经对它不屑一顾。后来当我看了代码定位的功能后,我觉得我还是太年轻了...

    /**
     * 代码定位
     *
     * @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

这个没啥好说的...

     /**
     * 打印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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,165评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,720评论 1 298
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,849评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,245评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,596评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,747评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,977评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,708评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,448评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,657评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,141评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,493评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,153评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,108评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,890评论 0 198
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,799评论 2 277
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,685评论 2 272

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,103评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,577评论 25 707
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,908评论 0 6
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,817评论 1 13
  • 本文参加#感悟三下乡,青春筑梦行#活动,文章内容为原创,且未在其他平台发表过。 作者:张子旭 我是生科院15级生态...
    奕工阅读 561评论 0 0