Android: 使用BuildConfig.DEBUG优化你的

---

一. 优化思路

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就是字面常量的引用)

2. 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优化开启后, 没有用到的类、方法、变量、无用语句块 ... 等会被移除掉, 这样程序会有一定的性能提升.

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

• (1) 农民工专用: apktool + jd-gui + dex2jar --- 免费
  apktool网站: https://ibotpeaches.github.io/Apktool/
  apktool下载地址: https://bitbucket.org/iBotPeaches/apktool/downloads
  jd-gui官网: http://jd.benow.ca/
  jd-gui GitHub地址: https://github.com/java-decompiler/jd-gui
  dex2jar下载地址: https://sourceforge.net/projects/dex2jar/
  dex2jar GitHub地址: https://github.com/pxb1988/dex2jar

• (2) 小市民专用: jadx --- 免费 墙裂推荐(　＾∀＾)

• (3) 土豪专用: JEB --- 收费