Android - 将@IntDef值放在@interface中可以吗?

Ahm*_*dli 42 java android annotations

我正在尝试@IntDef在Android开发中实现注释.

第一种方法:在Constant.java类中分隔定义看起来很棒:

public class Constant {
   @IntDef(value={SORT_PRICE, SORT_TIME, SORT_DURATION})
   @Retention(RetentionPolicy.SOURCE)
   public @interface SortType{}
   public static final int SORT_PRICE = 0;
   public static final int SORT_TIME = 1;
   public static final int SORT_DURATION = 2;
}
Run Code Online (Sandbox Code Playgroud)

用法:

@Constant.SortType int sortType = Constant.SORT_PRICE;
Run Code Online (Sandbox Code Playgroud)

但是当在一个文件中存在多个定义(例如UserType,StoreType等)时,事情会变得更加混乱.

第二种方法:所以我想出了这样的东西来分隔定义之间的值:

public class Constant {
   @IntDef(value={SortType.SORT_PRICE, SortType.SORT_TIME, SortType.SORT_DURATION})
   @Retention(RetentionPolicy.SOURCE)
   public @interface SortTypeDef{}

   public static class SortType{
       public static final int PRICE = 0;
       public static final int TIME = 1;
       public static final int DURATION = 2;
   }
}
Run Code Online (Sandbox Code Playgroud)

用法:

@Constant.SortTypeDef int sortType = Constant.SortType.PRICE;
Run Code Online (Sandbox Code Playgroud)

但正如你所看到的,我为它创建了两个不同的名称:SortTypeDefSortType

第三种方法:我试图在里面移动可能的值列表@interface:

public class Constant {
   @IntDef(value={SortType.SORT_PRICE, SortType.SORT_TIME, SortType.SORT_DURATION})
   @Retention(RetentionPolicy.SOURCE)
   public @interface SortType{
       int PRICE = 0;
       int TIME = 1;
       int DURATION = 2;
   }
}
Run Code Online (Sandbox Code Playgroud)

用法

@Constant.SortType int sortType = Constant.SortType.PRICE;
Run Code Online (Sandbox Code Playgroud)

虽然它确实有效,但我不知道有什么缺点.将可能的值@IntDef放在里面@interface是否可以?上述三种方法之间是否有任何性能差异?

小智 10

简短的回答:对于简单的项目,没关系,但对于更复杂的项目,第一种方法是首选.

答案很长:尽管sortType在所有三种情况下字节码都是相同的,但是有区别.关键在于Retention注释,它将保留策略设置为SOURCE.这意味着您的SortType注释" 将被编译器丢弃 ",因此不会生成注释本身的字节码.

第一种方法定义注释之外的常规静态字段,并为它们生成常规字节码.第二种和第三种情况在注释中定义常量,并且不生成常量的字节码.

如果编译器可以访问包含SortType声明的源文件,那么任何一种方法都可以,并且字节码sortType是相同的.但是如果无法访问源代码(例如,您只编译了库),则无法访问注释.对于第一种方法,只有注释本身不可访问,但对于后者,常量值也不可访问.

我曾经更喜欢第三种方法,因为它最干净,最有条理.我曾经有一天遇到过一个问题:当我开始为该代码编写Espresso测试时,编译器无法访问定义注释的源代码.我不得不切换到规范IntDef声明或使用整数值而不是符号常量进行测试.

所以底线是:

  • 坚持规范的方式,除非你的注释是你的代码的内部,你不会从其他任何地方引用它,包括测试