在Android应用开发过程中,通过Log类输出日志是一种很重要的调试手段。 大家对于Log类的使用,一般会形成几点共识:
在Debug模式下打印日志,在Release模式下不打印日志避免滥用Log类进行输出日志。因为这样可能造成日志刷屏,淹没真正有用的日志。封装Log类,以提供同时输出日志到文件等功能具体细化为以下几点建议:
禁用System.out.println Android应用中,一般通过封装过的Log类来输出日志,方便控制。而System.out.println是标准的Java输出方法,使用不当,可能造成Release模式下输出日志的结果。禁用e.printStackTrace 禁用理由同上建议通过封装过的Log类来输出异常堆栈信息
Debug模式下,通过一个静态变量,控制日志的显示隐藏。 我一般习惯直接使用BuildConfig.DEBUG,当然,你也可以自己定义一个。
private static final boolean isDebug = BuildConfig.DEBUG; public static void i(String tag, String msg) { if (isDebug) { Log.i(tag, msg); } }4.Release模式下,通过Proguard配置来移除日志 在Proguard配置文件中,确保没有添加 --dontoptimize选项 来禁用优化的前提下,添加以下代码:
-assumenosideeffects class android.util.Log { public static *** d(...); public static *** e(...); public static *** i(...); public static *** v(...); public static *** println(...); public static *** w(...); public static *** wtf(...); }那么,是否我们按照上面的做,就真的一劳永逸呢?我的脑海中浮现出几个相关问题:
Proguard配置中添加的配置,真的可以在Release模式下,移除日志吗?如果我们用的是封装过的Log工具类,应该怎么配置?移除日志后,原来在日志方法中的拼接字符串参数,是否还会申请/占用内存? ...本着大胆假设,小心求证的原则,下面我们通过实践来探索上面的问题答案。
本文基于以下项目进行测试实践:https://github.com/snowdream/test/tree/master/android/test/logtest反编译工具:JD-GUI
在添加上述Proguard配置前后,编译打包Release模式的正式包,使用JD-GUI进行反编译,对比上述代码的编译后代码。
添加配置前
添加配置后
通过比对结果,我们可以得出结论: 通过添加Proguard配置,可以在Release模式下,移除掉日志。
在添加上述Proguard配置前后,编译打包Release模式的正式包,使用JD-GUI进行反编译,对比上述代码的编译后代码。
添加配置前
添加配置后
通过比对结果,我们可以得出结论: 在这种简单封装的情况下,我们不需要额外的配置,也可以将封装过的Log工具类调用日志一起移除。
当然,实际使用过程中,可能封装更复杂。为了保险起见,可以也添加上Log工具类的配置。示例如下:
-assumenosideeffects class com.github.snowdream.logtest.LogUtil { public static *** d(...); public static *** e(...); public static *** i(...); public static *** v(...); public static *** w(...); }上面代码的区别是:前面是简单的字符串相加,而后面是字符串和变量的相加在添加上述Proguard配置的前提下,分别针对以上两段代码,编译打包Release模式的正式包,使用JD-GUI进行反编译,对比上述代码的编译后代码。
简单字符串相加字符串和变量相加
通过比对结果,我们可以得出结论: 如果只是简单字符串相加,是会彻底移除的,并且字符串拼接也不见了,不会占用内存。而如果是字符串和变量相加,日志会移除,但是字符串拼接还在,还会占用内存。
上面代码的区别是:前面是直接使用函数返回值,而后面是字符串和函数返回值的相加在添加上述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();
下面是一个简单的示例:
package com.github.snowdream.logtest; import android.text.TextUtils; import android.util.Log; /** * Created by snowdream on 16-10-22. */ public class LogUtil { private static final boolean isDebug = BuildConfig.DEBUG; public static void i(String tag, String... args) { if (isDebug) { Log.i(tag, getLog(tag,args)); } } public static void d(String tag, String... args) { if (isDebug) { Log.i(tag, getLog(tag,args)); } } public static void v(String tag, String... args) { if (isDebug) { Log.i(tag, getLog(tag,args)); } } public static void w(String tag, String... args) { if (isDebug) { Log.i(tag, getLog(tag,args)); } } public static void e(String tag, String... args) { if (isDebug) { Log.i(tag, getLog(tag,args)); } } private static String getLog(String tag, String... args){ StringBuilder builder = new StringBuilder(); for (String arg : args){ if (TextUtils.isEmpty(arg)) continue; builder.append(arg); } return builder.toString(); } }