@IntDef的使用

最新推荐文章于 2025-07-09 14:31:39 发布
转载 最新推荐文章于 2025-07-09 14:31:39 发布 · 2.7k 阅读 · 0

android开发Enum （枚举）的完美替代 —— @IntDef的使用

2015-11-21 10:52 4603人阅读 评论(0) 收藏 举报
分类：

     官方文档说明，安卓开发应避免使用Enum（枚举类），因为相比于静态常量Enum会花费两倍以上的内存。参 http://developer.android.com/training/articles/memory.html#Overhead

    那么如果需要使用Enum应该怎么做呢？

    https://noobcoderblog.wordpress.com/2015/04/12/java-enum-and-android-intdefstringdef-annotation/

[java] view plain copy
  1. public class MainActivity extends Activity {  
  2.     
  3.     //先定义 常量  
  4.     public static final int SUNDAY = 0;  
  5.     public static final int MONDAY = 1;  
  6.     public static final int TUESDAY = 2;  
  7.     public static final int WEDNESDAY = 3;  
  8.     public static final int THURSDAY = 4;  
  9.     public static final int FRIDAY = 5;  
  10.     public static final int SATURDAY = 6;  
  11.     
  12.     //用 <span></span>@IntDef "包住" 常量；  
  13.     // @Retention 定义策略  
  14.     // 声明构造器  
  15.     @IntDef({SUNDAY, MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY})  
  16.     @Retention(RetentionPolicy.SOURCE)  
  17.     public @interface WeekDays {}  
  18.     
  19.     @WeekDays int currentDay = SUNDAY;  
  20.     
  21.     @Override  
  22.     protected void onCreate(Bundle savedInstanceState) {  
  23.         super.onCreate(savedInstanceState);  
  24.         setContentView(R.layout.activity_main);  
  25.         setCurrentDay(WEDNESDAY);  
  26.     
  27.         //声明变量  
  28.         @WeekDays int today = getCurrentDay();  
  29.     
  30.         switch (today){  
  31.             case SUNDAY:  
  32.                 break;  
  33.             case MONDAY:  
  34.                 break;  
  35.             case TUESDAY:  
  36.                 break;  
  37.             case WEDNESDAY:  
  38.                 break;  
  39.             case THURSDAY:  
  40.                 break;  
  41.             case FRIDAY:  
  42.                 break;  
  43.             case SATURDAY:  
  44.                 break;  
  45.             default:  
  46.                 break;  
  47.         }  
  48.     
  49.     }  
  50.     
  51.     public void setCurrentDay(@WeekDays int currentDay) {  
  52.         this.currentDay = currentDay;  
  53.     }  
  54.     
  55.     @WeekDays  
  56.     public int getCurrentDay() {  
  57.         return currentDay;  
  58.     }  
  59. }  

使用注解库

这些注解不是默认加载的，它们被包装为一个单独的库。Support Library现在是由一些更小的库组成的，包括：v4-support、appcompat、gridlayout、mediarouter等等。
添加注解的最简单的方法就是打开Project Structure对话框。首先在左边选中module，然后右边选中Dependencies标签，点击“+”号按钮，选择Library Dependency。如果SDK中已经包括了Android Support库，那么注解支持库就会显示在快捷选择列表中了，只需要点击选择就可以。
《Android 高性能编程》—— @IntDef 注解，减缓枚举的使用
Dev Blog
12-11 475
在Android开发中官网不推荐使用枚举enums。 为什么呢？ 占用内存多（Enums often require more than twice as much memory as static constants.）。 Android中当你的App启动后系统会给App单独分配一块内存，App的DEX code、Heap以及运行时的内存分配都会在这块内存中。 例如： public cl...
使用IntDef、StringDef注解代替ENUM
木偶16的博客
06-13 827
使用IntDef、StringDef注解代替ENUM 一、前言 在android系统中，不推荐使用ENUM类型，因为他占用内存较大，所以一般使用静态常量来代替枚举，但是有些场景我们只需要某几个固定的或一个范围内的值。此时静态常量就没有办法用来检查我们传递的是不是自己想要的值，这个场景下可以使用这两个注解来完成，它会在编译的时候检查我们的赋值是否符合要求，提前发现错误。 二、依赖 这两个注解实现需要...
@IntDef的使用（替代枚举）
guopeng的博客
05-27 1万+
安卓开发应避免使用Enum（枚举类），因为相比于静态常量Enum会花费两倍以上的内存。使用@IntDef注解来代替枚举是个不错的选择。 添加android注解依赖： compile 'com.android.support:support-annotations:25.1.0'使用： public class MainActivity extends Activity {
Kotlin 中@IntDef 与@StringDef 枚举 注解
chuyouyinghe的专栏
07-09 86
Kotlin/Java中的@IntDef和@StringDef注解用于创建类型安全的常量组。@IntDef适用于整型常量（如状态码），内存占用小；@StringDef适用于字符串常量（如颜色名称），可读性更强。两者都需配合@Retention(SOURCE)使用，提供编译时检查但无运行时保障。选择依据：数字型用@IntDef，字符串型用@StringDef，复杂逻辑用枚举类。这些注解在Android开发中能平衡类型安全与性能。
@IntDef的使用--替代Enum
xindeluoye的专栏
08-03 5343
public class Main { public static final int SUNDAY = 0; public static final int MONDAY = 1; public static final int TUESDAY = 2; public static final int WEDNESDAY = 3; public st...
Android中代替枚举的@IntDef用法
刘鑫的博客
02-21 721
IntDef本身是个Android中提供的一种注解，用于替代枚举的使用 定义static final的常量 private static final int ADD = 0; private static final int SUB = 1; private static final int MUL = 2; private static final int DIV = 3; 定义一个In...
Android注解（二）使用@IntDef代替枚举
Crazy Android
03-21 441
大家都知道，枚举是非常消耗内存的。每个枚举实例都是一个Object对象。拥有12字节头+内容+8字节的对齐。注意，这里@IntDef后面要包住我们的定义的常量。
@property的使用
热门推荐
有关心情
10-04 3万+
文章目录前言普通示例对属性赋值进行约束@property的使用@property原理 前言 手机QQ有一个根据条件查找陌生人的功能。我初中时挺爱玩儿的，也因此在好友列表里添加了不少女生，相隔十年，我不得不感谢当时做出英明决定的自己，因为现在浏览空间总能看到大量的美女自拍，爽歪歪…… ……咳咳！不扯了，进入正题。 普通示例 既然我们要查找符合条件的陌生人，那当然得先构建一个具有这样条件的人出来，再...
Python @property使用方法解析
12-31
使用property类来实现，也可以使用property装饰器实现，二者本质是一样的。多数情况下用装饰器实现。 class Student(object): @property def score(self): return self._score @score.setter def score(self, ...
解释def __int__(self):和def __init__(self):的区别
再来一下！
06-02 1278
_init__：初始化对象的构造方法。创建对象时自动调用，用于设置对象的初始状态。__int__：定义对象转换为整数时的行为。通过int()函数或在需要整数的地方自动调用。这两个方法的主要区别在于它们的用途和调用时机。__init__是用于对象的初始化，而__int__则是用于定义对象如何被转换为整数。
android开发Enum （枚举）的更轻量级的替代方案 —— @IntDef的使用
wolfking0608的博客
11-28 1756
最近在翻看Android源码的时候,无意中看到这么一个注解,@IntDef 好奇心重的我,查看了一下注释,原来是用来替换掉枚举的!他比int更安全,比枚举更轻量! 开始之前我们先看看Android 官方文档中的一段话。 Be careful with code abstractions Developers often use abstractions simply as a good
Android开发中用于替代Enum的@IntDef的使用
codingismylife的专栏
11-07 6682
在Android的官方文档的内存管理中http://developer.android.com/training/articles/memory.html#Overhead提到由于Enum通常需要两倍以上的存储空间，因此应当尽量避免Enum的使用。对此，Google官方推出了IntDef作为对Enum的替代。以下通过一个具体的例子来说明其用法： 例如我们有如下的一组Enum:public enu
Android开发小技巧@IntDef(译 )
zhangle1hao的博客
10-23 6221
Android开发小技巧@IntDefTip使用IntDef不仅可以使你的代码更具可读性，也可以让lint阻止你犯错，所以能够让你写代码更快解释@IntDef 是我最喜欢的注释，在（ support.annotations ）包里面。它的主要目标是限定一个特定的整数变量，但它可以做的更多。它不仅可以让你轻松改变你的枚举值（# perfmatters / # enummatters选择你更喜欢），仍然
Java注解：@IntDef 替换 Emum
carter_yu的博客
04-17 2221
枚举（Eeum）的缺点 每一个枚举值都是一个对象,在使用它时会增加额外的内存消耗,所以枚举相比与 Integer 和 String 会占用更多的内存。 较多的使用 Enum 会增加 DEX 文件的大小,会造成运行时更多的开销,使我们的应用需要更多的空间。 使用@IntDef代替枚举 public class IntDefClass { IntDefClass(){} priva...
Android @IntDef注解取代Java enum枚举提高性能
Zhang Phil
05-22 2786
Android @IntDef注解取代Java enum枚举提高性能为提高Android性能，Android官方建议使用@IntDef注解替代Java的enum枚举。@IntDef的使用给出一个例子，先建立@IntDef数据结构模型，例如MyDay.java：package zhangphil.test; import android.support.annotation.IntDef; im...
Java 用注解(@IntDef/@StringDef)替代枚举
qq_34723470的博客
01-15 1794
我项目里面定义网络类型，原本是用枚举这样定义的： public enum NetType { /** * 有网络，包括Wifi/gprs */ AUTO, /** * wifi */ WIFI, /** * PC/笔记本/PDA */ CMNET, /** * 手机端 ...
常用注解@Intdef与@Stringdef
banyinlve3147的博客
05-22 684
1.优点 　　可以代替枚举，静态常量，可以让注解只在代码中存在，编译后就删除，可以省内存。 2.@IntDef 2.1 官网 　　https://developer.android.com/reference/kotlin/androidx/annotation/IntDef.html 2.2 java示例 1 //1.指定注解的保留策略，RetentionP...
Kotlin @IntDef 详解 注解 枚举
最新发布
chuyouyinghe的专栏
07-09 49
Kotlin的@IntDef注解是Android开发中用于创建类型安全整型常量组的工具，主要替代枚举类以优化内存。它通过编译时检查确保变量只能赋值为预定义的整数值，同时避免了枚举类的对象创建开销。基本用法包括定义常量组、添加注解限制参数类型，并支持位掩码组合值。虽然可读性不如枚举，但在性能敏感场景（如Android组件）中优势明显。需注意它仅提供编译时检查，运行时仍需手动验证非法值，且应配合SOURCE保留策略使用。@IntDef在保持类型安全的同时有效降低了内存占用，是Android性能优化的实用方案。
@IntDef
06-13
<think>我们使用Android的`@IntDef`注解来替代枚举，以限制一个整型变量的取值范围。`@IntDef`是AndroidSupportAnnotations库（或Jetpack中的Annotation库）提供的一个元注解，用于在编译时检查整数值是否在指定的范围内。步骤：1.添加依赖（如果尚未添加）：在build.gradle文件中添加：```groovydependencies{implementation'androidx.annotation:annotation:1.7.0'}```2.定义注解：使用`@IntDef`注解定义一个注解类型，其中列出允许的整数值。3.使用注解：在需要限制的整型变量（如方法参数、返回值、字段）上使用自定义的注解。4.验证取值：由于`@IntDef`仅在编译时进行静态检查，运行时无法直接验证。但我们可以通过编写工具方法在运行时检查。具体实现：###1.定义注解```javaimportandroidx.annotation.IntDef;//使用@IntDef定义允许的值publicclassStatus{//定义常量publicstaticfinalintSUCCESS=200;publicstaticfinalintNOT_FOUND=404;publicstaticfinalintSERVER_ERROR=500;//定义注解，限定取值@IntDef({SUCCESS,NOT_FOUND,SERVER_ERROR})@Retention(RetentionPolicy.SOURCE)//仅保留在源码中，编译后不保留public@interfaceStatusCode{}}```###2.使用注解```javapublicclassApiResponse{//使用注解限定字段@StatusCodeprivateintstatus;//使用注解限定参数publicvoidsetStatus(@StatusCodeintstatus){this.status=status;}@StatusCodepublicintgetStatus(){returnstatus;}}```###3.运行时验证（可选）由于`@IntDef`在编译后不会保留（通常使用`RetentionPolicy.SOURCE`），因此运行时无法通过反射获取允许的值。如果需要在运行时验证，可以单独定义一个验证方法：```javapublicclassStatusValidator{publicstaticbooleanisValidStatusCode(intcode){returncode==Status.SUCCESS||code==Status.NOT_FOUND||code==Status.SERVER_ERROR;}}```然后在设置值的地方调用：```javapublicvoidsetStatus(intstatus){if(!StatusValidator.isValidStatusCode(status)){thrownewIllegalArgumentException("Invalidstatuscode");}this.status=status;}```###4.使用示例```javaApiResponseresponse=newApiResponse();response.setStatus(Status.SUCCESS);//正确response.setStatus(400);//编译时可能不会报错（取决于IDE和注解处理器），但运行时会抛出异常（因为我们做了运行时检查）```###注意点：-**编译时检查**：使用AndroidStudio时，如果开启了注解处理，那么直接传入不在列表中的值会在编译时提示错误（或警告）。-**运行时检查**：由于`@IntDef`不保留到运行时，所以必须自己编写运行时验证逻辑（如果需要）。-**多个值**：`@IntDef`支持多个值，也可以使用`flag=true`表示按位或的组合值（类似标志位）。###使用@IntDef作为标志位（flag）```java@IntDef(flag=true,value={FLAG_A,FLAG_B,FLAG_C})@Retention(RetentionPolicy.SOURCE)public@interfaceFlags{}//使用publicvoidsetFlags(@Flagsintflags){...}```###总结使用`@IntDef`可以有效地在编译时限制整型变量的取值范围，同时避免了枚举带来的性能开销。但需要注意的是，它不提供运行时的验证，因此如果需要运行时验证，应额外编写验证逻辑。[^1]:[Android使用@IntDef和枚举enum限制元素取值范围的比较](https://blog.youkuaiyun.com/weixin_34349320/article/details/91466510)[^2]:[Android使用@IntDef注解替代枚举](https://blog.youkuaiyun.com/qq_17766199/article/details/78487800)§§相关问题§§1.如何在Kotlin中使用@IntDef注解？2.@IntDef和@StringDef有什么区别？3.如何在AndroidStudio中启用注解处理器？4.如何为@IntDef注解添加运行时保留策略？5.使用@IntDef注解时，如何同时支持多个值的组合？</think>在 Android 开发中，使用 `@IntDef` 注解替代枚举类可以有效限制整型变量的取值范围，同时避免枚举带来的性能开销（枚举会消耗约两倍的内存）[^1][^2]。以下是完整实现方案： ### 实现步骤 #### 1. 添加依赖 在 `build.gradle` 中添加注解库： ```groovy dependencies { implementation 'androidx.annotation:annotation:1.7.0' } ``` #### 2. 定义常量与注解 ```java import androidx.annotation.IntDef; public class StatusCodes { // 定义常量值 public static final int SUCCESS = 200; public static final int NOT_FOUND = 404; public static final int SERVER_ERROR = 500; // 定义@IntDef注解 @IntDef({SUCCESS, NOT_FOUND, SERVER_ERROR}) @Retention(RetentionPolicy.SOURCE) // 仅保留在源码级别 public @interface ValidStatusCode {} } ``` #### 3. 使用注解限制参数类型 ```java public class ApiHandler { // 使用注解限定参数范围 public void handleResponse(@StatusCodes.ValidStatusCode int statusCode) { // 业务逻辑... } } ``` #### 4. 运行时验证方法 ```java public class StatusValidator { // 检查值是否在允许范围内 public static boolean isValidStatusCode(int code) { return code == StatusCodes.SUCCESS || code == StatusCodes.NOT_FOUND || code == StatusCodes.SERVER_ERROR; } } // 使用示例 int inputCode = 404; if (StatusValidator.isValidStatusCode(inputCode)) { // 有效值处理 } else { throw new IllegalArgumentException("Invalid status code: " + inputCode); } ``` ### 关键优势与说明 1. **性能优势** `@IntDef` 在编译后会被擦除，仅保留 `int` 类型值，相比枚举节省约 2 倍内存[^1]。 2. **编译时检查** Android Studio 会在编译时检查注解使用： ```java // 正确使用 handler.handleResponse(StatusCodes.SUCCESS); // 编译错误：Must be one of: StatusCodes.SUCCESS, StatusCodes.NOT_FOUND... handler.handleResponse(400); ``` 3. **组合值支持（标志位）** ```java @IntDef(flag = true, value = { FLAG_READ, FLAG_WRITE, FLAG_EXECUTE }) public @interface FileModes {} ``` 4. **Kotlin 支持** 在 Kotlin 中使用更简洁： ```kotlin fun processCode(@StatusCodes.ValidStatusCode code: Int) { require(StatusValidator.isValidStatusCode(code)) } ``` ### 使用场景 - HTTP 状态码验证 - 错误代码范围限制 - 配置参数白名单 - 标志位组合验证 ### 注意事项 1. **运行时验证必要** 由于 `@Retention(RetentionPolicy.SOURCE)` 只在源码级别保留，运行时需显式验证[^2]。 2. **常量值管理** 所有允许值必须在同一类中定义为 `public static final int` 3. **IDE 支持** 确保启用注解处理（Android Studio > Preferences > Build > Annotations） [^1]: Android使用@IntDef和枚举enum限制元素取值范围的比较 [^2]: Android使用@IntDef注解替代枚举
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值