在android应用开发过程中,通过log类输出日志是一种很重要的调试手段。
大家对于log类的使用,一般会形成几点共识:
在debug模式下打印日志,在release模式下不打印日志
避免滥用log类进行输出日志。因为这样可能造成日志刷屏,淹没真正有用的日志。
封装log类,以提供同时输出日志到文件等功能
具体细化为以下几点建议:
禁用system.out.println
android应用中,一般通过封装过的log类来输出日志,方便控制。而system.out.println是标准的java输出方法,使用不当,可能造成release模式下输出日志的结果。
禁用e.printstacktrace
禁用理由同上
建议通过封装过的log类来输出异常堆栈信息
debug模式下,通过一个静态变量,控制日志的显示隐藏。
我一般习惯直接使用buildconfig.debug,当然,你也可以自己定义一个。
4.release模式下,通过proguard配置来移除日志
在proguard配置文件中,确保没有添加 --dontoptimize选项 来禁用优化的前提下,
添加以下代码:
那么,是否我们按照上面的做,就真的一劳永逸呢?
我的脑海中浮现出几个相关问题:
proguard配置中添加的配置,真的可以在release模式下,移除日志吗?
如果我们用的是封装过的log工具类,应该怎么配置?
移除日志后,原来在日志方法中的拼接字符串参数,是否还会申请/占用内存?
...
本着大胆假设,小心求证的原则,下面我们通过实践来探索上面的问题答案。
本文基于以下项目进行测试实践:
<a href="https://github.com/snowdream/test/tree/master/android/test/logtest">https://github.com/snowdream/test/tree/master/android/test/logtest</a>
在添加上述proguard配置前后,编译打包release模式的正式包,使用jd-gui进行反编译,对比上述代码的编译后代码。
添加配置前
添加配置后
通过比对结果,我们可以得出结论:
通过添加proguard配置,可以在release模式下,移除掉日志。
在这种简单封装的情况下,我们不需要额外的配置,也可以将封装过的log工具类调用日志一起移除。
当然,实际使用过程中,可能封装更复杂。为了保险起见,可以也添加上log工具类的配置。示例如下:
上面代码的区别是:
前面是简单的字符串相加,而后面是字符串和变量的相加
在添加上述proguard配置的前提下,分别针对以上两段代码,编译打包release模式的正式包,使用jd-gui进行反编译,对比上述代码的编译后代码。
简单字符串相加
字符串和变量相加
如果只是简单字符串相加,是会彻底移除的,并且字符串拼接也不见了,不会占用内存。
而如果是字符串和变量相加,日志会移除,但是字符串拼接还在,还会占用内存。
前面是直接使用函数返回值,而后面是字符串和函数返回值的相加
直接使用函数返回值
字符串和函数返回值相加
以上两种场景下,日志移除,拼接字符串不在了,也不会占用内存。
如果你以为上面就是全部真相的话,就错了。
经过大量的测试实践,实际上真相更复杂。
以下是开启proguard前提下,各种情况下的测试结论:
log.i(简单字符串)
log.i(局部变量)
log.i(成员变量)
log.i(简单字符串+局部变量)
以上四种情况,日志被彻底移除,不会额外增加内存。
log.i(简单字符串+成员变量)
日志被移除,但是字符串拼接会存在,并占用内存。
log.i(成员函数) 其中,成员函数返回值为: 简单字符串
log.i(成员函数) 其中,成员函数返回值为: 简单字符串+局部变量
以上两种情况,日志被彻底移除,不会额外增加内存。
log.i(成员函数) 其中,成员函数返回值为: 简单字符串+成员变量
注:以上所有情况,参数都是指第二个或者后面的参数。第一个参数,我都使用了静态成员变量:
private static final string tag = mainactivity.class.getsimplename();
确保没有开启 --dontoptimize选项的前提下,添加proguard优化日志配置
针对这种情况“log.i(成员函数) 其中,成员函数返回值为: 简单字符串+成员变量”
目前并没有办法规避,不建议这么使用。
针对这种情况"log.i(简单字符串+成员变量)"
我们的解决方案是,在封装的log工具类方法中,使用变长参数。
下面是一个简单的示例:
<a href="http://weishu.me/2015/10/19/how-to-log-safely-in-android/">如何安全地打印日志</a>
<a href="http://droidyue.com/blog/2015/11/01/thinking-about-android-log/">关于android log的一些思考</a>
<a href="http://www.jianshu.com/p/4b61391a665f">androrid应用打包release版时关闭log日志输出</a>