Android: 使用BuildConfig.DEBUG优化你的Log输出 & 开启混淆(proguard)的优化配置


一. 优化思路

  1. 现代编译器非常智能, 对于death blocks, 编译器会直接删除. 什么叫death blocks, 请看下面的代码:
public void method() {
    if(false) {
        System.out.println("Read the fucking source code !");
    }
}

此方法中的if语句块, 就是一个death blocks, 它是永远都不会执行的. 因此编译器会直接将其删除, 删除后代码如下:

public void method() {
}

编译器优化也是有条件的, 即if括号中的值必须在编译是就能确定为false且不可更改. 如下面的程序中, if括号中的值在运行时可以随时改变, flag的值可以为true也可以为false, 它是不确定的. 就算初始值为false, 但是因为它是可变的, 因此编译器不能优化掉if语句块.

public class Demo {
  boolean flag = false;

  public void d(String tag, String msg) {
      if(flag) {
          Log.d(tag, msg);
      }
  }
}

再看下面一个程序:

public final class DevUtil {
  //Bad implementation, dependence app module (MyApplication)
  private static final boolean flag = debuggable(MyApplication.getInstance());

  private DevUtil() {
      //no instance
  }

  //什么事情都不做, 只是为了初始化flag的值
  public static void init() {
  }

  public static void d(String tag, String msg) {
      if(flag) {
          Log.d(tag, msg);
      }
  }

  private static boolean debuggable(Context appContext) {
      final int DEBUG_SIGNATURE_HASH = -545093291;
      final int ONLINE_SIGNATURE_HASH = -283702024;

      // 判断是否为调试状态
      // http://stackoverflow.com/questions/3029819/android-automatically-choose-debug-release-maps-api-key
      PackageManager manager = appContext.getPackageManager();
      try {
          PackageInfo info = manager.getPackageInfo(appContext.getPackageName(), PackageManager.GET_SIGNATURES);
          for (Signature sig : info.signatures) {
              int sigHashCode = sig.hashCode();
              switch(sigHashCode) {
                  case DEBUG_SIGNATURE_HASH:
                      return true;
                  case ONLINE_SIGNATURE_HASH:
                      return false;
              }
          }
      } catch (PackageManager.NameNotFoundException e) {
          e.printStackTrace();
      }

      return false;
  }
}

虽然DevUtil类中log输出的开关边是常量(不可变的), 但是由于赋值给flag的是一个方法调用, 编译时并不能确定其值为false, 因此if语句块也是不能优化掉的.

要优化掉一个if语句块, 必须同时满足两个条件:

  1. if括号中的值必须编译时就能确认为false
  2. 且if语句中的值是不可变的

要满足上面的条件, if语句只中的值只能是字面常量false, 或者是一个常量 --- 赋值给这个常量的必须是一个字面常量或者一个字面常量的引用(指向一个字面常量的常量, 如final boolean flag = false; flag就是字面常量的引用)

  1. Android Studio编译module之后会在<module>/build/generated/source/buildConfig/{flavor}/{buildType} 目录下生成一个BuildConfig.java文件. 如果没有定义productFlavors生成的BuildConfig位于<module>/build/generated/source/buildConfig/{buildType}目录下. 如图:
BuildConfig.java文件所在目录.png

BuildConfig.java文件(buildType为release)的内容如下:

/**
 * Automatically generated file. DO NOT MODIFY
 */
package com.stone.mvp_demo;

public final class BuildConfig {
  public static final boolean DEBUG = false;
  public static final String APPLICATION_ID = "com.stone.mvp_demo";
  public static final String BUILD_TYPE = "release";
  public static final String FLAVOR = "flavor1";
  public static final int VERSION_CODE = 1;
  public static final String VERSION_NAME = "1.0";
  // Fields from build type: release
  public static final boolean LOG_DEBUG = false;
}

BuildConfig的DEBUG字段就是一个字面常量的引用. 这是满足编译器优化条件的.

BuildConfig类的DEBUG字段会因buildType的不同而不同, 具体为debug版DEBUG的值为true, release版DEBUG的值为false. 因此可以利用BuildConfig类的DEBUG字段来作为log的开关. 当我们打release包时, buildType肯定是release, 因此DEBUG的值是false. 此时log输出代码块变成了Death Blocks, 形如:

if(false) {
    Log.e(TAG, message)
}

编译器会删除此段. 这样log输出被优化成一个空方法, 减少了方法内部语句的入栈出栈.

二. 具体代码
推荐把DevUtil放在公共库中(这里有个巨坑, 请参考《Android中使用BuildConfig.DEBUG必须知道的内幕》), 方便代码重用.

public final class DevUtil {
    private static final boolean isDebug = BuildConfig.DEBUG;

    private DevUtil() {
        //no instance
    }

    public static void d(String tag, String msg) {
        if (isDebug) {
            Log.d(tag, msg + " - tag:" + tag);
        }
    }

    public static void v(String tag, String msg) {
        if (isDebug) {
            Log.v(tag, msg + " - tag:" + tag);
        }
    }

    public static void w(String tag, String msg, Throwable e) {
        if (isDebug) {
            Log.w(tag, msg + " - tag:" + tag, e);
        }
    }

    // 更多log输出方法 ....

    public static boolean isDebug() {
        return isDebug;
    }
}

反编译后的DevUtil类变成了下面的样子:


编译器优化后的代码.png

三. proguard优化配置
推荐release版的混淆开启优化选项, 要使用开启优化选项的规则文件, 默认配置必须使用<ANDROID_SDK>/tools/proguard/proguard-android-optimize.txt, 而不是<ANDROID_SDK>/tools/proguard/proguard-android.txt文件. proguard-android.txt文件中已经把优化选项给关闭了, 并且告诉你仅仅包含优化配置选项是没有用的, 因为这个文件已经将优化的开关给关了, 你需要使用proguard-android-optimize.txt这个文件来开启混淆的优化功能, proguard-android.txt文件的部分截图如下:

proguard-android.txt文件已经关闭了优化选项并且此文件中也告诉你怎么启用优化选项.png

主项目module下的构建脚本(build.gradle)的buildType配置(release版配置)如下:

release版的混淆配.png

proguard优化开启后, 没有用到的类、方法、变量、无用语句块 ... 等会被移除掉, 这样程序会有一定的性能提升.

下面推荐几款反编译工具:

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

推荐阅读更多精彩内容