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

android java annotations

2022-09-01 01:09:45

我正在尝试在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;

但正如你所看到的，我为它创建了两个不同的名称：和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;
   }
}

用法

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

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

答案 1

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

长答案：尽管的字节码在所有三种情况下都是相同的，但存在差异。关键在于注释，它将保留策略设置为。这意味着您的注释是“编译器丢弃的”，因此不会生成注释本身的字节码。sortTypeRetentionSOURCESortType

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

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

我曾经更喜欢第三种方法，因为它是最干净和结构化的。我曾经这样做过，直到有一天我遇到了一个问题：当我开始为该代码编写Espresso测试时，编译器无法访问定义注释的源代码。我必须切换到规范声明，或者使用整数值而不是符号常量进行测试。IntDef

所以底线是：

坚持规范的方式，除非你的注释是代码内部的，并且你没有从其他任何地方引用它，包括测试

答案 2

要使第三种方法正常工作，您应该在界面中命名like。我使用了你的代码并使其工作：values

public class Constant {
    @IntDef(value = {SortType.PRICE, SortType.TIME, SortType.DURATION})
    @Retention(RetentionPolicy.SOURCE)
    @interface SortType {
        int PRICE = 0;
        int TIME = 1;
        int DURATION = 2;
    }
}

或

public class Constant {
    @IntDef(value = {SortType.SORT_PRICE, SortType.SORT_TIME, SortType.SORT_DURATION})
    @Retention(RetentionPolicy.SOURCE)
    @interface SortType {
        int SORT_PRICE = 0;
        int SORT_TIME = 1;
        int SORT_DURATION = 2;
    }
}

秒的用法：

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

选择一个，两者都应该有效。