Android中不使用枚举类（enum）替代为@IntDef @StringDef

1. 概述

Enum 是 java 中一种包含固定常数的类型
当我们需要预先定义一些值，并限定范围时，使用 Enum，来做到编写和编译都查错

• Java 的 Enum 的实质是特殊单例的静态成员变量
• Enum 可以在编写器，编译器做到各种静态检查防呆
• Enum 在运行期，所有枚举类作为单例，全部加载到内存中

因为上述原因，Enum 增加了APK 的内存占用，比常量多5到10倍的内存占用
所以放弃枚举，就是关于安卓应用性能的内存占用部分的最佳实践方法之一

2. Android 单例类占用内存原理

单例增加了APK 的内存占用的原因是

• apk 经常初始化加载到虚拟机，作为一个新的用户应用来使用，而服务端 java 应用不怎么初始化加载到虚拟机
  另外每个 Android 应用的可用内存是非常有限的
• 因为 Android 系统下，每个 APP 就是一个独立用户，Android 系统分配给这个用户的内存非常小，一般只有 32MB 64MB 左右

这个配置一般在文件 /system/build.prop中
具体看 ROM 厂商的定制，别希望 ROM 厂商修改这个的大小

• 初始化单例太多，设备在不能处理情况下，非常容易出现 ANR 错误
• AndroidManifest.xml 中 application 节点下 android:largeHeap 开启也不会给太多额外的内存

/system/build.prop 中

dalvik.vm.heapsize=128m
dalvik.vm.heapgrowthlimit=64m

• heapgrowthlimit 是普通应用的内存限制
• heapsize 是开启后的内存限制，也没大多少

3. 为什么不推荐使用枚举

请参考这篇：
深入理解枚举enum类型，以及为什么不建议在Android中使用enum

简单来说enum的产物是一个类，每个枚举值是它下面的的一个static final值，除此之外，还维护了String、数组等对象。运行时所占用的内存非常大。

每一个枚举值都是一个单例对象,在使用它时会增加额外的内存消耗,所以枚举相比与 Integer 和 String 会占用更多的内存
较多的使用 Enum 会增加 DEX 文件的大小,会造成运行时更多的IO开销,使我们的应用需要更多的空间
特别是分dex多的大型APP，枚举的初始化很容易导致ANR。

3.1 重点

说是不推荐使用，但没有说强制不使用Java枚举，当我们使用时，我们是需要用到枚举类型的特定的，比如

推荐使用的场景：

1. 类型检查-----------类型检查本来就是枚举的唯一特点，及优势，表明你的函数是只需要接受列出的值（枚举的值），并且他们是不连续的
2. 方法重载，每个类型要进行方法的重载

比如下面这段代码，使用枚举是很推荐的：

public enum UnitConverter{
     
    METERS{
     
        @Override
        public double toMiles(final double meters){
     
            return meters * 0.00062137D;
        }

        @Override
        public double toMeters(final double meters){
     
            return meters;
        }
    },
    MILES{
     
        @Override
        public double toMiles(final double miles){
     
            return miles;
        }

        @Override
        public double toMeters(final double miles){
     
            return miles / 0.00062137D;
        }
    };

    public abstract double toMiles(double unit);
    public abstract double toMeters(double unit);
}

不推荐的情况：

1. 你的函数可以接受一种类型所有的值，而你所列出来的只是这些值里面比较重要的值
2. 你的函数可以接受连续的数据
3. 用于名称
4. other…

4. 不使用枚举类型的解决方案

既然使用枚举是因为参数的类型太泛了造成的类型不安全，那么我只要将参数限定在某一个类型集合里面
要将的@IntDef/@StringDef + @interface来进行限定参数

build.gradle 文件中添加依赖

dependencies {
     
    compileOnly 'com.android.support:support-annotations:25.1.0'
}

也可以使用对应的版本 compileOnly 是不会让 support-annotations 到下一个依赖库，如果想让下一个库依赖，请使用 api
特别的，如果是 app 出包，依赖必须使用 implementation

然后就可以使用注解帮助检查参数，代码如下

public class SexTest {
     
public final int MAN = 2;
public final int WOMEN = 3;

    /**
     * 只能使用 {@link #MAN} {@link #WOMEN}
     */
    @Documented // 表示开启Doc文档
    @IntDef({
     
        MAN,
        WOMEN，
    }) //限定为MAN,WOMEN
    @Target({
     
            ElementType.PARAMETER,
            ElementType.FIELD,
            ElementType.METHOD,
    }) //表示注解作用范围，参数注解，成员注解，方法注解
    @Retention(RetentionPolicy.SOURCE) //表示注解所存活的时间,在运行时,而不会存在 .class 文件中
    public @interface Sex {
      //接口，定义新的注解类型
    }
    public void setSex(@Sex int sex){
     
        this.sex = sex;
    }
}

如果我们尝试在调用setSex()方法的时候，传入不在限定之内的值，那么编译就不会通过，有错误提示

同理，我们也可以使用@StringDef

public class FlagContants {
     
    public static final String UNDEFINE = "undefine";
    public static final String OK = "ok";
    public static final String ERROR = "error";

    private @FlagDef
    String flag = UNDEFINE;

    @Documented // 表示开启Doc文档
    @StringDef({
     
            OK,
            ERROR
    }) //限定为 FlagContants.OK, FlagContants.ERROR
    @Target({
     
            ElementType.PARAMETER,
            ElementType.FIELD,
            ElementType.METHOD,
    }) //表示注解作用范围，参数注解，成员注解，方法注解
    @Retention(RetentionPolicy.SOURCE) //表示注解所存活的时间,在运行时,而不会存在 .class 文件中
    public @interface FlagDef {
      //接口，定义新的注解类型
    }

    public @FlagDef
    String getFlag() {
     
        return flag;
    }

    public void setFlag(@FlagDef String flag) {
     
        this.flag = flag;
    }
}

5. AndroidStuido @*Def 模板

自动模板，用于快速生产这种枚举类(智能模板不包括引包，引入包请手动，或者配置自动引入)

5.1 @IntDef 模板

• 分组 Android
• 名称 Abbreviation defInt
• 描述 Description add Android IntDef Source block
• Template text

   @IntDef({
     
        $END$
    })
    @Documented
    @Target({
     
        ElementType.FIELD,
        ElementType.METHOD,
        ElementType.PARAMETER,
    })
    @Retention(RetentionPolicy.SOURCE)
    public @interface $IntDefName$Def {
     
    }

• 生效范围 Application in Java:declaration
• Edit variables

Name	Expression	Default value	Skip if define
IntDefName	classNameComplete		No

5.2 @StringDef 模板

• 分组 Android
• 名称 Abbreviation defString
  描述 Description add Android StringDef Source block
• Template text

    @StringDef({
     
        $END$
    })
    @Documented
    @Target({
     
        ElementType.FIELD,
        ElementType.METHOD,
        ElementType.PARAMETER,
    })
    @Retention(RetentionPolicy.SOURCE)
    public @interface $StringDefName$Def {
     
    }

• 生效范围 Application in Java:declaration
• Edit variables

Name	Expression	Default value	Skip if define
StringDefName	classNameComplete		No

6. 注解生命周期

RetentionPolicy.SOURCE 源码注解，编译成.class文件后注解就不存在，用来提示开发者
RetentionPolicy.CLASS CLASS汇编注解，编译成.class文件后注解也还存在，用于自动生成代码
RetentionPolicy.RUNTIME 运行时动态注解，生命周期一直程序运行时都存在，常用于自动注入