《Android 高性能编程》—— @IntDef 注解，减缓枚举的使用

在书中的 P120 - 123，有介绍枚举，因为枚举对开发者友好，数量有限的元素、描述性的文字，可以增强代码的可读性，并且还支持多态。

但是在性能上说，使用枚举却不一定是最佳的选择，因为枚举在经过编译器之后，变成了一个抽象类，它继承了 java.lang.Enum，为其定义的枚举常量则会变成相应的内部类，等。（具体见：java枚举类型的实现原理）

所以文中有提替代枚举的主要方式就是利用类的 public static 来声明整形值，如下：

public enum TYPE_ENUM {
    TYPE1,
    TYPE2,
    TYPE3
}

可替代为：

public class TYPE_CLASS {
    public static final int TYPE1 = 1;
    public static final int TYPE2 = 2;
    public static final int TYPE3 = 3;
}

简单的说，使用枚举会消耗更大的内存，相应的也会增加耗时，而类的静态变量的实现方式更加轻量级，就如上面的示例，仅分配了 3 个整型值，更节省内存。

另外，枚举需要被复制到每个使用到它的进程中，因此在多进程应用程序中，枚举会增加额外的消耗。但是从另外一个角度来说，枚举是可以保证线程安全的。

---

在上面有说过，如果使用枚举，是可以增强代码可读性的，因为枚举使得枚举常量限制在一个有限的集合内，在取值时只能取集合内存在的值，就如在 switch 语句中：

//type 为枚举 TYPE_ENUM 类型，非类 TYPE_CLASS 类型，
//只能取值 {TYPE.TYPE1、TYPE.TYPE2、TYPE.TYPE3} 中的一个
TYPE_ENUM type;

switch (type) {
    case TYPE_ENUM.TYPE1:break;
    case TYPE_ENUM.TYPE2:break;
    case TYPE_ENUM.TYPE3:break;
}

但是，一般情况下，当用类的静态变量实现类似于枚举的效果时，是不能像枚举那样，限制变量的取值：

//type_ 类型为 TYPE_CLASS 定义的静态常量类型，即 int 型，因此 type_ 可以定义为任意 int 型的数据
//不能像枚举那样限制其取值范围
int type_ ;//can set any int value \

switch (type_) {
    case TYPE_CLASS.TYPE1:break;
    case TYPE_CLASS.TYPE2:break;
    case TYPE_CLASS.TYPE3:break;
}

为了减缓上述问题，Android 提供一个有用的注解，用于简化从枚举到整型值的转换：@IntDef（实现 String 类型的效果时用 @StringDef，还有 LongDef ），使用示例如下：

在 android.support.annotation 下，可能需要导入：com.android.support:support-annotations

public class TYPE_CLASS {

    //本质上还是 int 类型的，因此作为成员变量时，mType 的默认值还是 0
    //只是为了避免警告，不能显示的设置为具体的数值
    private @Type int mType;

    //这几个常量实际上还是属于 TYPE_CLASS 的，只不过集合在 @Type（即自己创建的注解）中
    public static final int TYPE1 = 1;
    public static final int TYPE2 = 2;
    public static final int TYPE3 = 3;

    //以注解的将几个整形值集合起来，转换为类似枚举的东西
    @IntDef({TYPE1, TYPE2, TYPE3})
    @interface Type{}//声明自己创建的注解名

    public void setType(@Type int type) {
        this.mType = type;
    }

    @Type
    public int getType() {
        return mType;
    }
}

基本的实现就是在原基础上使用 @IntDef 注解设置一个 @interface（示例中命名为 Type），把需要的几个整形值都列出来，然后在使用且对变量声明类型的时候，加上 @Type 即可，如上述的 setType() 和 getType() 方法。或者是在 switch 语句中使用：

private void test(@TYPE_CLASS.Type int type) {
    switch (type) {
        case TYPE_CLASS.TYPE1:
            break;
        case TYPE_CLASS.TYPE2:
            break;
        case TYPE_CLASS.TYPE3:
            break;
    }
}

然后在使用的时候，如果 @Type 类型的变量没有赋值为前面设定的那几个值（而且必须为声明名字 TYPE1, TYPE2, TYPE3，而不能是其具体的值），编译器就会发出警告：

TYPE_CLASS.TYPE1 的值就为 1，但是对 test() 的 type 参数直接赋值为 1，也会发出警告。

但是，需要注意的是，即是发出了警告，但是代码还是能正常通过编译的，因为上述的实现只是 Android 提供的一个注解，就类似于语法糖，只是检查代码的作用，编译层面没有实质的改变。

switch (type) {
    case 1:
        break;
    case 2:
        break;
    case 3:
        break;
}

的本质还是：

switch (type) {
    case TYPE_CLASS.TYPE1:
        break;
    case TYPE_CLASS.TYPE2:
        break;
    case TYPE_CLASS.TYPE3:
        break;
}

且在 switch 语句中用具体的对应的值代替 TYPE_CLASS.X，编译器是不会发出警告的。

( @SringDef 的用法类似)

另外，IntDef 还有一个 flag 属性，是布尔类型的（LongDef 也有，SringDef 没有），使用方法如下：

@IntDef(flag = true, value = {TYPE1, TYPE2, TYPE3})
@interface Type{}

其作用就是定义常量是否可以用作标志（flag = true），使得多个常量可以结合使用，或者仅用作枚举（默认值，flag = false）。

文档原文：
Defines whether the constants can be used as a flag, or just as an enum (the default)

仅根据官方文档，还不是很清楚 flag 具体的作用，也没有给出具体的示例，后来在 Stack Overflow 上看到来一个解释：

截图自：https://stackoverflow.com/questions/34583796/android-intdef-for-flags-how-to-use-it

意思就是如果 flag 设置为 true，value 中的那些常量指定为标记性质的类型，这样客户端代码就通过 |、& 等操作符同时传递多个常量了。
（引用自：Android注解支持(Support Annotations) - 6. IntDef/StringDef: 类型定义注解）

---

参考文章：

（1）https://developer.android.com/reference/android/support/annotation/IntDef.html
（2）Android中用IntDef、StringDef注解代替Enum枚举类型