楔子
log在发布版本中打印会出现极大的安全问题,但在debug版本中确是不可缺少的。
需求
自动判断当前版本类型,选择是否输出log
实现
查阅了stormzhang的文章,提出使用BuildConfig.DEBUG和自定义BuildConfig字段,网上还有第三种方法通过 ProGuard 优化掉 Log 代码
stormzhang的文章地址
一.BuildConfig.DEBUG
首先在Gradle脚本中默认的debug和release两种模式BuildCondig.DEBUG字段分别为true和false,而且不可更改。该字段编译后自动生成,在Studio中生成的目录在 app/build/source/BuildConfig/Build Varients/package name/BuildConfig 文件下。
if (BuildConfig.DEBUG) {
Logger.d(Xml);
}
- 需要注意的事,并不是通过条件判断去除的log。而是通过编译器优化的原理,因为BuildConfig.DEBUG是一个常量,所以这整段代码都会在编译时删除。
二.自定义BuildConfig字段
我的这篇博客有详细介绍,和上面类似,能适应更复杂的情况
http://www.jianshu.com/p/88fb3876d92d
三.通过 ProGuard 优化掉 Log 代码
https://yq.aliyun.com/articles/5544
四.一个可能遇到的问题
可以看到stormzhang的文章下有个被顶起来的问题没有得到解答。小僧不才,斗胆一试。
问题出现原因
大的项目一般不会只有一个主模块,会抽取出一些公用类和方法放在子模块,主模块依赖子模块。而BuildConfig是根据模块来生成的,每个模块都有一个。
那么他们的BuildConfig.DEBUG就毫无相关性了。也失去了这段代码的意义。
解决问题
主模块由于依赖可以直接使用子模块的方法和属性。但是子模块想得到主模块的变量就要依靠java的神器,反射。
//主模块方法
public static boolean isDebug(){
return BuildConfig.DEBUG;
}
//子模块通过反射调用主模块的debug属性
public static boolean getGotobusIsDebug() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
return (boolean) Class.forName(classGotobusConfig).getMethod("isDebug").invoke(null);
}