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

Question

我正在尝试在Android开发中实现@IntDef注解。

第一种方法:在 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;
}

用法:

@Constant.SortType int sortType = Constant.SORT_PRICE;

但是当一个文件中有多个定义(例如 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;
   }
}

用法:

@Constant.SortTypeDef int sortType = Constant.SortType.PRICE;

但正如您所见，我为它创建了两个不同的名称:SortTypeDef 和 SortType

第三种方法:我试图移动@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;
   }
}

用法

@Constant.SortType int sortType = Constant.SortType.PRICE;

虽然它确实有效，但我不知道有什么缺点。 可以将 @IntDef 的可能值放在 @interface 中吗？以上三种方法是否存在性能差异？

Answer 1

简短回答:对于简单的项目，可以，但对于更复杂的项目，首选第一种方法。

长答案: 尽管 sortType 的字节码在所有三种情况下都是相同的，但还是有区别的。关键在于 Retention 注释，它将保留策略设置为 SOURCE。这意味着您的 SortType 注释是“to be discarded by the compiler ”，因此不会生成注释本身的字节码。

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

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

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

所以底线是:

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