Toast中@Duration注解的使用

1、duration 属性

代码原型是这样的：

public static Toast makeText(Context context, CharSequence text, @Duration int duration) {

下面这段代码是使用 Toast 的示例代码

//下面是两个显示时间的常量
public static final int LENGTH_SHORT = 0;
public static final int LENGTH_LONG = 1;

Toast.makeText(context,"toast message",Toast.LENGTH_SHORT).show();

假如用这种方式编写：

//直接使用 0 表示 LENGTH_SHORT  可以吗
Toast.makeText(context,"toast message",0).show();

假如使用 0 来表示 LENGTH_SHORT 的话， AS 就直接报错了，提示信息在截图中可以看出，显示这个值必须是 Toast.LENGTH_LONG/LENGTH_SHORT 两个之一。

Toast.png

2、@Duration的使用

在上面 makeText 中的第三个参数 duration 中添加了一个 @Duration 的东东，就是这个注解约束了duration变量的赋值。

@IntDef({LENGTH_SHORT, LENGTH_LONG})
@Retention(RetentionPolicy.SOURCE)
public @interface Duration {}

3、 @IntDef

@IntDef 表示定义该注解 Duration 元素类型为 long 类型，并且只能取这两个值，LENGTH_SHORT, LENGTH_LONG，这两个值就是 Toast 的常量了，分别表示0和1。

//该注解标注的信息会保留到编译时期
@Retention(SOURCE)
//可用于类，接口（包括注解接口）还有枚举
@Target({ANNOTATION_TYPE})
public @interface IntDef {
    /** Defines the allowed constants for this element */
    //定义 long 型常量
    long[] value() default {};

    /** Defines whether the constants can be used as a flag, or just as an enum (the default) */
    boolean flag() default false;
}

使用示例

@IntDef({LENGTH_SHORT, LENGTH_LONG})
@Retention(RetentionPolicy.SOURCE)
public @interface Duration {}

4、@StringDef

除了 @IntDef 之外还有 @StringDef ，表示该注解的元素类型为 String 类型，并且所取的值就在 StringDef 规定范围内。在系统提供的 API 中也有体现，那就是 Context#getSystemService(@ServiceName @NonNull String name); ServiceName 就是使用 @StringDef 的注解。

//该注解标注的信息会保留到编译时期
@Retention(SOURCE)
//可用于类，接口（包括注解接口）还有枚举
@Target({ANNOTATION_TYPE})
public @interface StringDef {
    /** Defines the allowed constants for this element */
    String[] value() default {};
}

使用示例

//定义
@Retention(RetentionPolicy.SOURCE)
@StringDef({POWER_SERVICE,WINDOW_SERVICE,LAYOUT_INFLATER_SERVICE})
public @interface ServiceName {
    public static final String POWER_SERVICE = "power";
    public static final String WINDOW_SERVICE = "window";
    public static final String LAYOUT_INFLATER_SERVICE = "layout_inflater";
}

//使用
public abstract Object getSystemService(@ServiceName String name);

5、使用场景

当某些参数的值需要是固定的值时，那么就可以使用 @StringDef
或者@IntDef （目前只发现了这两种）去标识，例如系统提供的 Toast 就使用了 @Duration 注解，它是使用 @IntDef 去限制 duration 变量的设置，而 Context 中的 getSystemService 中的 name 变量就是使用 @ServiceName 去标识的,该注解就使用使用 @StringDef 去限制 name 的取值。

我感觉这种做法有点像枚举的做法。

我们注意到系统提供的这两个注解的定义：

@Retention(RetentionPolicy.SOURCE)

它们都是用 RetentionPolicy.SOURCE 标识的，它标识该注解的信息不会被编译，会被编译器抛弃，也就是在编译前就知道是否发生了错误，既然不会被编译，也就无法被加载到 JVM 中了。

@IntDef 和 @StringDef 可以像枚举一样在变量的赋值时做一些约束操作，相对比在类中定义一些常量来说，这种方式更加集中同时也实现了类型安全。

6、使用@String自己定一个 @FlagColor

事先说明，这个 demo 并没有实际意义，只是对模仿 @Duraiton 来写的一个 demo 而已。

• 模仿 @Duration 自己定义一个 FlagDemo 类

  1.定义需要约束的几个常量
  2.定义注解类FlagColor，使用@StringDef限定上面定义的常量
  3.在提供的一些方法使用@FlagColor注解进行传参和返回值的约束。

public class FlagDemo {

    public final static String RED = "red";
    public final static String GREEN = "green";
    public final static String YELLO = "yello";


    private String color;

    //定义枚举
    @Retention(RetentionPolicy.RUNTIME)
    @StringDef({RED, GREEN, YELLO})
    public @interface FlagColor {
    }


    public String setColor(@FlagColor String color) {
        return this.color = color;
    }

    @FlagColor
    public String getColor() {
        return color;
    }
}

• 测试

注意这里 flagDemo.setColor("") 报错，报错结果跟上面 duration 参数传入 0 一样的，也就是说我们自己定义的 @FlagColor 可以正常使用的。

public static final void main(String[] args) {
    FlagDemo flagDemo = new FlagDemo();
    //flagDemo.setColor("");
    flagDemo.setColor(FlagDemo.GREEN);
    System.out.println("color:"+flagDemo.getColor());
}