Android 中关于枚举的优化

概述

Android 中使用 Kotlin 枚举 + when、java 枚举时，源代码编译后会产生额外的产物，进而带来一些额外开销，本文讲述了 Android 对枚举使用的优化的讲解和解决办法。

枚举的开销

详情描述

eg: 使用 enum 定义枚举类 ClazzEnum.

public enum ClazzEnum {
    ONE, TWO
} 

enum 标识符声明的枚举类 ClazzEnum 默认继承自 java.lang.Enum, 每个枚举类成员默认都是 public static final 修饰，每个枚举常量都相当于是一个 ClazzEnum 对象，而 Enum 默认实现已经声明了一些枚举属性，所以枚举通常会比静态常量多两倍以上的内存占用，所以在过去 Android 中不推荐使用枚举。

解决办法

1. 启用 R8 编译优化；
2. 使用静态常量或TypeDef注解替换枚举；

R8 编译优化

R8 编译优化枚举，解决枚举造成的额外开销；

Android Studio 3.4.0+ 以后，在 build.gradle 编译配置中通过 minifyEnabled=true 开启 R8 编译优化，R8 会直接调用枚举的序数值(ordinal)，在编译的时候将琐碎的枚举优化为整型，避免枚举造成的额外开销。

kotlin/java 代码的编译

为了更好的理解 R8 对枚举的优化，我们简单了解下kotlin/java 代码的编译流程。

在 Android 应用中，kotlin/java 代码的编译流程：

1. kotlin/javac 编译器编译源代码文件为 java 字节码：

   kotlin/javac 编译器会将代码转换为 java 字节码，Android 设备并不直接运行 Java 字节码，而是运行名为 DEX 的 Dalvik 可执行文件；

2. D8 编译器将 java字节码转为 DEX 代码；

3. R8 (可选项，推荐 release 使用)优化:

   R8 在 build.gradle 中通将 minifyEnabled 设为 true 来开启，它将在所有其他编译工作后执行，来保证您获得的是一个缩减和优化过的应用。

Kotlin: 枚举+when

问题描述

在 Kotlin 中使用枚举时，也仅仅是将其转换为 Java 编程语言中的枚举而已，本身并不包含任何隐藏开销。但当 枚举+when 配合使用时，就会引入额外的开销。

我们举个例子：

package enums

fun main() {
    val age: Int = getAge(People.CHILD);
    println("ret: ${age}")
}

fun getAge(p: People): Int {
    return when (p) {
        People.ADULT -> 30
        People.CHILD -> 18
    }
}

enum class People {
    ADULT,
    CHILD
} 

查看上述代码编译后的字节码：

# 查看字节码
# 方式一：IDEA(可能有些地方编译失败)
IDEA/AndroidStudio -> Tools -> Kotlin -> Show Kotlin Bytecode -> Decompile
# 方式二：kotlinc + JD-GUI
$ kotlinc test.kt -include-runtime -d ret.jar 

// 编译后的字节码
public final class TestKt$WhenMappings {
   public static final int[] $EnumSwitchMapping$0 = new int[People.values().length];

   static {
      $EnumSwitchMapping$0[People.ADULT.ordinal()] = 1;
      $EnumSwitchMapping$0[People.CHILD.ordinal()] = 2;
   }
}

@Metadata(...)
public final class TestKt {
  public static final void main() {
    int age = getAge(People.CHILD);
    String str = Intrinsics.stringPlus("ret: ", Integer.valueOf(age));
    boolean bool = false;
    System.out.println(str);
  }
  
  public static final int getAge(@NotNull People p) {
    Intrinsics.checkNotNullParameter(p, "p");
    People people = p;
    int i = WhenMappings.$EnumSwitchMapping$0[people.ordinal()];
    switch (i) {
      case 1:
      
      case 2:
      
    } 
    throw new NoWhenBranchMatchedException();
  }
} 

在上述编译后的代码中可以发现，当使用 when 语句接受枚举作为参数时，编译后 when 转换成的 switch 并没有让 switch 语句直接接受枚举，而是接受了 p 枚举对应 ordinal 作为索引对应 TestKt$WhenMappings 数组中的元素值作为参数。

可以发现使用 when 语句时，编译后产物中会生成 TestKt$WhenMappings类，这个类里面有一个存储映射信息的数组 $EnumSwitchMapping$0，接下来则是一些执行映射操作的静态代码。

示例中是只有一个 when 语句时的情况，如果我们写了更多的 when 语句，那么每个 when 语句都会在 TestKt$WhenMappings类中生成一个对应的数组，即使这些 when 语句都在使用同一个枚举也一样。所以这就意味着，在您不知情的时候，会生成一个类，而且其中还包含了一些数组，这些都会让类加载和实例化消耗更多的时间。

解决办法

1. Kotlin 中枚举可以用 Sealed Class 密封类替代；

2. 启用 Android R8 编译会自动优化，避免生成类和映射数组，而且只会创建了您所需的最佳代码；

   // 启用 R8 编译优化后，会直接把 when 转为 switch, 并接收 Enum#ordinal 作为参数；
   public static final int getAge(@NotNull People p) {
       switch (p.ordinal()) {
           case 0: 
           // ...
       }
   }