Android中避免使用枚举类(Enum)

如需转载请评论或简信,并注明出处,未经允许不得转载

目录

前言

Android官方training文档中有一句话

Enums often require more than twice as much memory as static constants. You should strictly avoid using enums on Android

http://www.androiddocs.com/training/articles/memory.html

枚举类的好处

在java中,使用枚举类可以保证类型安全提高代码可读性。无论需求如何变化,比如枚举常量增加一个数据,或是增加一条状态,都可以很方便的实现,比直接在全局常量类里定义状态来的便捷

static与Enum比较

  • 第一步:有一个Android Project,编译后生成的dex的体积为3,465,228byte

  • 第二步:新增创建一个类,如下所示,编译后生成的dex的体积为3,465,532byte(比初始增加304byte

public class Test {
    public static final int RED = 1;
    public static final int BLACK = 2;
    public static final int GREEN = 3;
    public static final int YELLOW = 4;

    public int fun(int color) {
        switch (color) {
            case RED:
                return -1;
            case BLACK:
                return -2;
            case GREEN:
                return -3;
            case YELLOW:
                return -4;
            default:
                return 0;
        }
    }
}
  • 第三步,改写第二步中创建的类,如下所示,编译后生成的dex的体积为3,466,568 byte(比初始增加1340byte,比使用static增加1036byte

初步结论:使用Enum会比static增加2-3倍的byte,从而增加apk的体积

Enum源码分析

我们创建了一个枚举类Color

public enum Color {
    RED, GREEN, BLACK, YELLOW
}

编译项目,在app/build/intermediates/javac/debug/classes/项目名称目录下,可以找到Color.class文件,执行javap -c Color.class命令对class文件进行反编译,结果如下所示

Compiled from "Color.java"
public final class com.geekholt.kotlinandjavademo.Color extends java.lang.Enum<com.geekholt.kotlinandjavademo.Color> {
  public static final com.geekholt.kotlinandjavademo.Color RED;

  public static final com.geekholt.kotlinandjavademo.Color GREEN;

  public static final com.geekholt.kotlinandjavademo.Color BLACK;

  public static final com.geekholt.kotlinandjavademo.Color YELLOW;

  public static com.geekholt.kotlinandjavademo.Color[] values();
    Code:
       0: getstatic     #1                  // Field $VALUES:[Lcom/geekholt/kotlinandjavademo/Color;
       3: invokevirtual #2                  // Method "[Lcom/geekholt/kotlinandjavademo/Color;".clone:()Ljava/lang/Object;
       6: checkcast     #3                  // class "[Lcom/geekholt/kotlinandjavademo/Color;"
       9: areturn

  public static com.geekholt.kotlinandjavademo.Color valueOf(java.lang.String);
    Code:
       0: ldc           #4                  // class com/geekholt/kotlinandjavademo/Color
       2: aload_0
       3: invokestatic  #5                  // Method java/lang/Enum.valueOf:(Ljava/lang/Class;Ljava/lang/String;)Ljava/lang/Enum;
       6: checkcast     #4                  // class com/geekholt/kotlinandjavademo/Color
       9: areturn

  static {};
    Code:
       0: new           #4                  // class com/geekholt/kotlinandjavademo/Color
       3: dup
       4: ldc           #7                  // String RED
       6: iconst_0
       7: invokespecial #8                  // Method "<init>":(Ljava/lang/String;I)V
      10: putstatic     #9                  // Field RED:Lcom/geekholt/kotlinandjavademo/Color;
      13: new           #4                  // class com/geekholt/kotlinandjavademo/Color
      16: dup
      17: ldc           #10                 // String GREEN
      19: iconst_1
      20: invokespecial #8                  // Method "<init>":(Ljava/lang/String;I)V
      23: putstatic     #11                 // Field GREEN:Lcom/geekholt/kotlinandjavademo/Color;
      26: new           #4                  // class com/geekholt/kotlinandjavademo/Color
      29: dup
      30: ldc           #12                 // String BLACK
      32: iconst_2
      33: invokespecial #8                  // Method "<init>":(Ljava/lang/String;I)V
      36: putstatic     #13                 // Field BLACK:Lcom/geekholt/kotlinandjavademo/Color;
      39: new           #4                  // class com/geekholt/kotlinandjavademo/Color
      42: dup
      43: ldc           #14                 // String YELLOW
      45: iconst_3
      46: invokespecial #8                  // Method "<init>":(Ljava/lang/String;I)V
      49: putstatic     #15                 // Field YELLOW:Lcom/geekholt/kotlinandjavademo/Color;
      52: iconst_4
      53: anewarray     #4                  // class com/geekholt/kotlinandjavademo/Color
      56: dup
      57: iconst_0
      58: getstatic     #9                  // Field RED:Lcom/geekholt/kotlinandjavademo/Color;
      61: aastore
      62: dup
      63: iconst_1
      64: getstatic     #11                 // Field GREEN:Lcom/geekholt/kotlinandjavademo/Color;
      67: aastore
      68: dup
      69: iconst_2
      70: getstatic     #13                 // Field BLACK:Lcom/geekholt/kotlinandjavademo/Color;
      73: aastore
      74: dup
      75: iconst_3
      76: getstatic     #15                 // Field YELLOW:Lcom/geekholt/kotlinandjavademo/Color;
      79: aastore
      80: putstatic     #1                  // Field $VALUES:[Lcom/geekholt/kotlinandjavademo/Color;
      83: return
}

把上面的字节码文件翻译成java大致如下所示

public final class Color extends java.lang.Enum<Color> {
    public static final Color RED;

    public static final Color GREEN;

    public static final Color BLACK;

    public static final Color YELLOW;

    static {
        RED = new Color("RED", 0);

        GREEN = new Color("GREEN", 1);

        BLACK = new Color("BLACK", 2);

        YELLOW = new Color("YELLOW", 3);

        VALUES = new Color[]{RED, GREEN, BLACK, YELLOW};
    }

    public static Color[] values() {
        Color tmp = new Color[VALUES.length];
        system.arraycopy(VALUES, 0, tmp, 0, VALUES.length);
        return tmp;
    }

    public static Color valueOf(String name) {
        return Enum.valueOf(name);
    }
}

由此我们可以得出以下结论:

  • Enum中的每一个值都是一个Object,它的每个声明都会占用运行时的部分内存以便能够引用到这个Object。因此Enum的值会比对应的IntegerString所占用的内存多
  • 很多时候我们声明static变量只需要在已有的类中进行声明,而如果使用枚举类,就会多出一个类,最终则会增大Dex的体积,显然Enum的空间占用是远大于Integer常量或String常量的

解决方案

  1. 为了弥补 Android 平台不建议使用枚举的缺陷,官方推出了两个注解,@IntDef@StringDef,用来提供编译期的类型检查
  • 添加依赖
    在build.gradle文件中的依赖块中添加:
    dependencies { compile 'com.android.support:support-annotations:24.2.0' }

  • 声明常量和@IntDef

    @IntDef({
          Color.RED,
          Color.GREEN,
          Color.BLACK,
          Color.YELLOW
    })
    @Retention(RetentionPolicy.SOURCE)
    public @interface Color {
       int RED = 1;
       int GREEN = 2;
       int BLACK = 3;
       int YELLOW = 4;
    }
    

    这里@TypeDef注解使用了@interface来声明新的枚举注解类型。其中@IntDef@StringDef注解以及@Retention标注了新的注解,目的是定义这个枚举类型。而@Retentino(RententionPolicy.SOURCE)注解告诉编译器在生成.class文件时不保留枚举注解数据

  • 使用方法如下, 这样外界就无法传递 Color 之外的成员作为参数

    public static void doSth(@Color int color){
       switch (color){
          case Color.RED:
              //do something
              break;
           case Color.GREEN:
              break;
           case Color.BLACK:
              break;
           case Color.YELLOW:
              break;
        }
    }
    
  1. 如果开启了Proguard可以在很多情况下将枚举Enum优化到整数对象。

结论

在android中使用枚举类不仅会增加apk体积,同时也会增加运行时内存,所以在架构设计上还是要慎用枚举类。如果希望进行编译期类型检查可以使用@IntDef@StringDef类保证类型安全

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

推荐阅读更多精彩内容