Java Enum and Android Intdef/Stringdef annotation

最新推荐文章于 2024-06-03 15:21:46 发布
转载 最新推荐文章于 2024-06-03 15:21:46 发布 · 1.2k 阅读 · 0
文章标签：

#Android #Annotation #Enum #Intdef #Stringdef

本文探讨了在Java中使用枚举（Enum）和Android中的IntDef注解来限定变量取值的方法，比较了整型常量、枚举及IntDef的优缺点，并介绍了如何在Android应用中正确使用IntDef。

本文转载自： https://noobcoderblog.wordpress.com/2015/04/12/java-enum-and-android-intdefstringdef-annotation/

参考资料：http://developer.android.com/reference/android/support/annotation/IntDef.html

When we want a variable x to have values from some predefined constants then what can we do. We can declare the constant variables and set x from these constants. Lets assume x is currentDay and it can have any value from sunday to friday. We can code like this in java using integer constants.

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 static final int THURSDAY = 4;
    public static final int FRIDAY = 5;
    public static final int SATURDAY = 6;
 
    private int currentDay = SUNDAY;
 
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        Main obj = new Main();
        obj.setCurrentDay(WEDNESDAY);
 
        int today = obj.getCurrentDay();
 
        switch (today) {
        case SUNDAY:
            System.out.println("Today is SUNDAY");
            break;
        case MONDAY:
            System.out.println("Today is MONDAY");
            break;
        case TUESDAY:
            System.out.println("Today is TUESDAY");
            break;
        case WEDNESDAY:
            System.out.println("Today is WEDNESDAY");
            break;
        case THURSDAY:
            System.out.println("Today is THURSDAY");
            break;
        case FRIDAY:
            System.out.println("Today is FRIDAY");
            break;
        case SATURDAY:
            System.out.println("Today is SATURDAY");
            break;
 
        default:
            break;
        }
    }
 
    public void setCurrentDay(int currentDay) {
        this.currentDay = currentDay;
    }
 
    public int getCurrentDay() {
        return currentDay;
    }
 
}

Problem with this code is I can set any integer value to currentDay.

obj.setCurrentDay(100);

and compiler will not give me any error. Then in switch/case we will miss that value. So Java gives us a solution that is Enumeration or Enum. If We rewrite the code with Enum in Java.

public class Main {
 
    public enum WeekDays {
        SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
    }
 
    private WeekDays currentDay = WeekDays.SUNDAY;
 
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        Main obj = new Main();
        obj.setCurrentDay(WeekDays.WEDNESDAY);
 
        WeekDays today = obj.getCurrentDay();
 
        switch (today) {
        case SUNDAY:
            System.out.println("Today is SUNDAY");
            break;
        case MONDAY:
            System.out.println("Today is MONDAY");
            break;
        case TUESDAY:
            System.out.println("Today is TUESDAY");
            break;
        case WEDNESDAY:
            System.out.println("Today is WEDNESDAY");
            break;
        case THURSDAY:
            System.out.println("Today is THURSDAY");
            break;
        case FRIDAY:
            System.out.println("Today is FRIDAY");
            break;
        case SATURDAY:
            System.out.println("Today is SATURDAY");
            break;
 
        default:
            break;
        }
    }
 
    public void setCurrentDay(WeekDays currentDay) {
        this.currentDay = currentDay;
    }
 
    public WeekDays getCurrentDay() {
        return currentDay;
    }
 
}

Now we have type safety. I can not have any value other then WeekDays in currentDay variable. That is a great improvement, and we should use it. But in Android there is a problem.

Enum in Android: Enum is a full fledged class in Java. Every value of Enum is an object of that Enum class. So Enum values will take more memory then int constant we used earlier. Even in old android devices (<=2.2), there were some performance issue related to Enum which were solved in JIT compiler. Now we can use Enum in Android Application, but if our application is a memory hungry application or a game application then we better use integer constants instead of Enum. But then problem remains.

There is a solution. Android support annotation library has some good annotation helper which can be used to find bug earlier (in compile time). IntDef and StringDef are two Magic Constant Annotation which can be used instead of Enum. These will help us to check variable assignment like Enum in compile time. Following code showed how to use IntDef instead of Enum.

public class MainActivity extends Activity {
 
    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 static final int THURSDAY = 4;
    public static final int FRIDAY = 5;
    public static final int SATURDAY = 6;
 
    @IntDef({SUNDAY, MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY})
    @Retention(RetentionPolicy.SOURCE)
    public @interface WeekDays {}
 
    @WeekDays int currentDay = SUNDAY;
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        setCurrentDay(WEDNESDAY);
 
        @WeekDays int today = getCurrentDay();
 
        switch (today){
            case SUNDAY:
                break;
            case MONDAY:
                break;
            case TUESDAY:
                break;
            case WEDNESDAY:
                break;
            case THURSDAY:
                break;
            case FRIDAY:
                break;
            case SATURDAY:
                break;
            default:
                break;
        }
 
    }
 
    public void setCurrentDay(@WeekDays int currentDay) {
        this.currentDay = currentDay;
    }
 
    @WeekDays
    public int getCurrentDay() {
        return currentDay;
    }
}

Now we can not set any value other than WeekDays in currentDay or today variable. Compiler will check it and will give error. And if we use Android Studio, IDE will give suggestion about the value. So how to use it. At first declare the constants.

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 static final int THURSDAY = 4;
public static final int FRIDAY = 5;
public static final int SATURDAY = 6;

Then declare the @IntDef for these constants,

@IntDef({SUNDAY, MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY})
@Retention(RetentionPolicy.SOURCE)
public @interface WeekDays {}

To set a variable of WeekDays type, so that no value other than weekdays can be set to that variable, we declare it like following,

@WeekDaysintcurrentDay ;

Now if there is any assignment which set currentDay to any other value than WeekDays, compiler will give a error. To set function parameter and function return type with WeekDays type,

public void setCurrentDay(@WeekDaysintcurrentDay) {
    this.currentDay = currentDay;
}
 
@WeekDays
public int getCurrentDay() {
    returncurrentDay;
}

@StringDef can be used in same manner.

public class MainActivity extends Activity {
 
    public static final String SUNDAY = "sunday";
    public static final String MONDAY = "monday";
    public static final String TUESDAY = "tuesday";
    public static final String WEDNESDAY = "wednesday";
    public static final String THURSDAY = "thursday";
    public static final String FRIDAY = "friday";
    public static final String SATURDAY = "saturday";
 
 
    @StringDef({SUNDAY, MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY})
    @Retention(RetentionPolicy.SOURCE)
    public @interface WeekDays {}
 
 
    @WeekDays String currentDay = SUNDAY;
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        setCurrentDay(WEDNESDAY);
 
        @WeekDays String today = getCurrentDay();
 
 
        switch (today){
            case SUNDAY:
                break;
            case MONDAY:
                break;
            case TUESDAY:
                break;
            case WEDNESDAY:
                break;
            case THURSDAY:
                break;
            case FRIDAY:
                break;
            case SATURDAY:
                break;
            default:
                break;
        }
 
    }
 
    public void setCurrentDay(@WeekDays String currentDay) {
        this.currentDay = currentDay;
    }
 
    @WeekDays
    public String getCurrentDay() {
        return currentDay;
    }
}

To use this feature, you have to add support-annotations library to your project. If you use Android Studio, then add following in your Gradle dependency.

dependencies {
    compile fileTree(include: ['*.jar'], dir: 'libs')
    ...
    compile'com.android.support:support-annotations:22.0.0'
}

You can learn more about support annotation library here.  And below is android performance patterns video about price of Enum.

Android Annotation使用快速入门，源码解读-别再说你不知道HashMap原理
m0_64319000的博客
11-17 235
@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。 2.注解事件处理器 编写注解事件处理器，通过反射获得场景类对象的annotation的source对象。并且为source对象调用setOnClickLi.
使用IntDef、StringDef注解代替ENUM
木偶16的博客
06-13 858
使用IntDef、StringDef注解代替ENUM 一、前言 在android系统中，不推荐使用ENUM类型，因为他占用内存较大，所以一般使用静态常量来代替枚举，但是有些场景我们只需要某几个固定的或一个范围内的值。此时静态常量就没有办法用来检查我们传递的是不是自己想要的值，这个场景下可以使用这两个注解来完成，它会在编译的时候检查我们的赋值是否符合要求，提前发现错误。 二、依赖 这两个注解实现需要...
Android中少用枚举类（enum）而多用@IntDef @StringDef
RikkaTheWorld
08-17 891
1. 概述 Enum 是 java 中一种包含固定常数的类型 当我们需要预先定义一些值，并限定范围时，使用 Enum，来做到编写和编译都查错 Java 的 Enum 的实质是特殊单例的静态成员变量 Enum 可以在编写器，编译器做到各种静态检查防呆 Enum 在运行期，所有枚举类作为单例，全部加载到内存中 因为上述原因，Enum 增加了APK 的内存占用，比常量多5到10倍的内存占用 所以放弃枚举，就是关于安卓应用性能的内存占用部分的最佳实践方法之一 2. Android 单例类占用内存原理 单例增加了
android中使用@IntDef @StringDef代替ENUM
ZyClient的博客
07-28 368
在没有@IntDef和@StringDef之前，对于一些常量值的维护和使用是一个困扰，到底是用enum还是静态常量呐。用静态常量只能是固定常量值，对于需要需一个范围值来说不适合，但是用enum对于内存消耗又是一个问题：Android官方文档中也有说明，enum中的每一个值其实都是一个Object对象，每声明一个值就会创建一部分的内存以使它能够被引用到这个对象，相比于静态常量，enum会花费近2倍的内存空间。 google也考虑到这点了，因此推荐大家使用@IntDef和@StringDef来代替enum问题
Android进阶之将注解@IntDef @StringDef替代枚举类（enum）
chenliguan的博客
12-02 1677
1 概述 Enum是java中一种包含固定常数的类型。当我们需要预先定义一些值，并限定范围时，使用 Enum，来做到编写和编译都查错。 　　Java的Enum的实质是特殊单例的静态成员变量，可以在编写器，编译器做到各种静态检查防呆；在运行期，所有枚举类作为单例，全部加载到内存中。 　　因此，Enum增加了APK的内存占用，比常量多5到10倍的内存占用。所以放弃枚举，就是关于安卓应用性能的内存占用部...
@IntDef
06-13
我们使用Android的`@IntDef`注解来替代枚举，以限制一个整型变量的取值范围。`@IntDef`是...[^1]: Android使用@IntDef和枚举enum限制元素取值范围的比较 [^2]: Android使用@IntDef注解替代枚举
@IntDef详细参数说明和使用方法是怎样的？
最新发布
10-25
import androidx.annotation.IntDef; @Retention(RetentionPolicy.SOURCE) // 注解仅保留在源码级别 @IntDef({ NetworkStatus.NETWORK_UNKNOWN, NetworkStatus.NETWORK_WIFI, NetworkStatus.NETWORK_4G, ...
android enum的使用
03-19
import androidx.annotation.IntDef; public class Status { public static final int SUCCESS = 0; public static final int FAILURE = 1; public static final int PENDING = 2; @IntDef({SUCCESS, FAILURE...
Android使用注解代替枚举节省系统内存开销的方法
08-25
Android提供了两种主要的注解类型：IntDef和StringDef，分别用于整型和字符串的类型检查。 1. Int类型注解检查类型安全 IntDef注解可以用于定义一组整型常量，实现类似枚举的功能，但不占用额外的内存。以下是一个...
使用Android 中的@IntDef @StringDef替代枚举
Mr_Tony的专栏
09-07 975
@IntyDef @StringDef
Android中使用@IntDef、@StringDef注解来替代Enum用于提升性能
a2250742657的博客
10-21 493
众所周知，在Android中使用Enum枚举会极大的影响 性能，内存消耗大。原因如下: Android官方文档中也有说明，enum中的每一个值其实都是一个Object对象，每声明一个值就会创建一部分的内存以使它能够被引用到这个对象，相比于静态常量，enum会花费近2倍的内存空间。 通常使用定义静态常量来代替Enum使用，如下： public class Constant{ ...
使用注解@StringDef替代枚举-以切换环境为例
liuhedev的博客
11-27 2209
由于项目采用组件化开发，涉及公司多个app，所有考虑切换环境合理解耦。在Application对环境进行初始化。
Android IntDef与StringDef注解
huihuishou_su的博客
12-19 2059
这篇文章只是想让自己记住这两个注解，之前见过几次，不用就忘了，再看到又有些陌生，用这篇博客来记住它吧。想说一下这两个注解，大家都清楚在Android中，官方并不推荐使用enum因为它占用的内存相对较大，对于比较吃内存的应用我们可能会选择静态常亮，但是有些地方我们只想让它赋予指定的一个范围的值，这个时候静态常量就没有办法用来检查了我们需要用的地方是不是自己想要的值，这个时候可以使用这两个注解来完成，它
Android限制参数传递之StringDef注解的使用
fxjzzyo的博客
06-03 1331
在参数传递时，如果你想限制传入的参数只能是特定的几个值，该怎么做呢？ 除了把参数类型定义为枚举值，还可以使用注解来限制参数只能是你规定的几个值。以下3个注解就是起到了这样的作用： @StringDef 限制参数只能是规定的几个String类型的值 @IntDef 限制参数只能是规定的几个Int类型的值 @LongDef 限制参数只能是规定的几个Long类型的值
错误: 程序包android.support.annotation不存在
anfenggang的博客
05-31 2816
今天导入一个Android Demo项目，编译出现多处“错误: 程序包android.support.annotation不存在”错误。原因是安装的版本不符。
android enum 字符串,Java 枚举和 Android IntDef/StringDef 注解
weixin_34732771的博客
05-26 316
[TOC]#Java 枚举 和 Android IntDef/StringDef 注解##翻译自原文：[Java Enum and Android IntDef/StringDef Annotation]##使用 Integer 常量当我们想要一个变量 x，并且它的值来自于一些已经定义好的常量。那么我们可以这样做：我们可以先定义一些常量，然后把这些常量的值赋值给 x 。现在我们假设 x 就是 `c...
android 枚举替换方案,Java Enum枚舉替代方案--Android IntDef/StringDef Annotation注解
weixin_42149153的博客
05-27 250
當我們想把一個變量x的取值限制在幾個預先定義的常量時，我們會怎么做呢？我們可以先定義一些常量值，然后從這些常量中選擇賦值給x。下面，讓我們假設變量x為currentDay，它的取值包含了星期天到星期五。我們可以在Java中，通過Integer的常量寫出下面的代碼：public class Main {public static final int SUNDAY = 0;public static ...
Android中@IntDef，@StringDef + 注解使用—替代Enum
weixin_33881753的博客
05-28 497
使用枚举的地方 在我们日常开发中经常要定义一些限定范围内的常量，比如说，性别类型、大中小等，不能保证入参的范围，如果要是提供Api给别人使用，更易出现传参错误的情况： public static final int TYPE_BIG = 1; public static final int TYPE_MIDDLE = 2; public static final int T...
java enum int和string转换
04-29
在Java中，一个枚举类型是由一组常量所组成的。这些常量在编译时就已经确定，因此与普通的变量不同，枚举类型的值不能随意改变。 有时候我们需要将一个枚举类型的值转换成整数或字符串类型，或者将一个整数或字符串类型的值转换为枚举类型。这时，我们可以使用Java中提供的一些方法来实现。 如果我们要将一个枚举类型的值转换为整数类型，可以使用枚举类型中的ordinal()方法。该方法返回该枚举常量在枚举类型中的序号，从0开始计数。示例代码如下： ``` enum Color{ RED, GREEN, BLUE } Color color = Color.RED; int index = color.ordinal(); // 0 ``` 如果要将一个整数类型的值转换成枚举类型，可以使用枚举类型中的values()方法。该方法返回一个包含所有枚举常量的数组。我们可以利用这个数组和整数类型的值来获取要转换的枚举类型。示例代码如下： ``` enum Color{ RED, GREEN, BLUE } int index = 1; Color color = Color.values()[index]; // GREEN ``` 如果要将一个枚举类型的值转换为字符串类型，可以使用枚举类型中的name()方法。该方法返回该枚举常量的名称。示例代码如下： ``` enum Color{ RED, GREEN, BLUE } Color color = Color.RED; String name = color.name(); // "RED" ``` 如果要将一个字符串类型的值转换为枚举类型，可以使用枚举类型中的valueOf()方法。该方法接受一个字符串类型的参数，并返回相应的枚举常量。需要注意的是，该方法对于不存在的枚举常量或空字符串会抛出IllegalArgumentException异常。示例代码如下： ``` enum Color{ RED, GREEN, BLUE } String name = "GREEN"; Color color = Color.valueOf(name); // GREEN ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值