移动架构<第九篇>：注解详解与使用

注解（Annotation）可以理解为标签，我们可以在类、方法、参数上打上我们想要的标签（自定义注解），除此之外，Java和Android还提供了一些其它注解。

（1）内置注解

[@Override]

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
}

以上是Android新建Activity的onCreate方法，其中@Override的作用是：检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。

[@Deprecated]

当查看Java或Android自带的API时，经常发现用[@Deprecated]修饰的成员变量或者方法，用于标记过时的成员变量和方法。

@Deprecated
public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;

[@SuppressWarnings]

指示编译器去忽略注解中声明的警告，这个注解了解即可。

@SuppressWarnings({"unchecked"})
public void layout(int l, int t, int r, int b) {}

（2）元注解

什么叫元注解？

用于修饰注解本身的注解叫做元注解，当自定义注解时会经常用到。

Java中的常用的元注解有：@Retention、@Target、@Document、@Inherited、@IntDef、@StringDef、@LongDef

@Retention 注解的作用域（生命周期）

RetentionPolicy.SOURCE：作用于源码阶段，仅仅在源码阶段可用，编译成Class就找不到了
RetentionPolicy.CLASS：仅仅在Class阶段有用
RetentionPolicy.RUNTIME：在什么时候都有用

代码编写：

@Retention(RetentionPolicy.SOURCE)
public @interface Model{

}

@Target注解的作用目标

ElementType.TYPE 作用于类的任何元素
ElementType.FIELD 作用于字段或属性
ElementType.METHOD 作用于方法级注释
ElementType.PARAMETER 作用于方法的参数
ElementType.CONSTRUCTOR 作用于构造函数
ElementType.LOCAL_VARIABLE 作用于局部变量
ElementType.ANNOTATION_TYPE 作用于注释类型
ElementType.PACKAGE 作用于包声明
ElementType.TYPE_PARAMETER 1.8版本新增，作用于类型变量
ElementType.TYPE_USE 1.8版本新增，作用于任何使用类型的语句中（例如声明语句、泛型和强制转换语句中的类型）

代码编写：

@Target({ElementType.PARAMETER,ElementType.METHOD,ElementType.FIELD})
public @interface Model{

}

@Document

当使用Javadoc命令成成API文档时采用用到，被@Document标记的元素会写到API文档里。

@Inherited

表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解

@IntDef、@StringDef、@LongDef

定义可选范围，如果flag=true，那么可以使用“|”传递多个参数，value是可选值。

代码：

@IntDef(flag = true, value = {1,2,3,4})
public @interface Model{

}

（3）场景一：代码优化之限定传参

定义一个工具类，这个工具类中不仅有播放器的播放状态，还有其他状态

public class Tools {

    //预备状态
    public static final int PREPARE = 1;
    //播放状态
    public static final int PLAY = 2;
    //暂停状态
    public static final int PAUSE = 3;
    //停止状态
    public static final int STOP = 4;
    //单曲循环
    public static final int SINGLE  = 5;
    //其它状态1
    public static final int OTHER_STATUS_1  = 0x10;
    //其它状态2
    public static final int OTHER_STATUS_2  = 0x11;
    //其它状态3
    public static final int OTHER_STATUS_3  = 0x12;
}

一个播放器的Bean

public class Audio {

    //播放状态
    private int status;

    public Audio() {
    }

    public int getStatus() {
        return status;
    }

    public void setStatus(int status) {
        this.status = status;
    }
}

当设置Audio的播放状态时，代码如下：

    Audio audio = new Audio();
    //设置播放状态
    audio.setStatus(Tools.PAUSE);

以上代码虽然简单，但是很形象的暴露出了一个很严重的问题，是什么问题呢？如图：

图片.png

当设置状态时，由于可被访问的成员变量过多，导致很容易搞错，那么，有没有什么办法解决这个问题呢？

答案是有的。

第一种方案：使用枚举，将5种播放状态放在一个枚举里面，但是，枚举有一个很大缺点，就是太消耗内存，枚举里面定义5个常量，每一个常量都是一个对象，非常的消耗内存。所以我不推荐使用枚举。那么，还有什么方法解决这个问题呢？

使用自定义注解的方式可以完美解决这个问题，又避免使用枚举。

[第一步] 自定义注解

//flag=true时，参数可以“|”传递多个参数，flag=false时，只能传递一个参数
@IntDef(flag = false, value = {Tools.PREPARE,Tools.PLAY,Tools.PAUSE,Tools.STOP,Tools.SINGLE})
//注解作用域参数、方法、成员变量
@Target({ElementType.PARAMETER,ElementType.METHOD,ElementType.FIELD})
//仅仅在源码阶段有效
@Retention(RetentionPolicy.SOURCE)
public @interface Model{

}

关键注解是@IntDef，value限定了取值范围。

[第二步]修改Audio类，将status成员变量和status参数用@Model注解修饰

public class Audio {

    //播放状态
    private @Model int status;

    public Audio() {
    }

    public int getStatus() {
        return status;
    }

    public void setStatus(@Model int status) {
        this.status = status;
    }

}

[第三步] 调用

如果不小心参数传递错误

图片.png

在编译之前就会报错，因为@IntDef确定了取值范围，Tools.OTHER_STATUS_3不在这个范围之内。

如果传递的值在取值范围内，则不会报错

图片.png

@IntDef设置的flag为false，所以只能传递一个参数，如果传递两个参数，则报错

图片.png

将flag改成true之后，则不会报错

图片.png

此时的播放状态是单曲循环播放。

（4）场景二：简化代码，在编译时设置初始值，不需要后期主动传值

//注解作用于类
@Target({ElementType.TYPE})
//仅仅在源码阶段有效
@Retention(RetentionPolicy.RUNTIME)
public @interface Model {

    String key();

    String value();

}

该注解之作用于类，所以，key和value的传值只在类中。（当然，根据需求的变化，也有可能会作用于方法或者成员变量上）。

@Model(key = "main/audio", value = "Audio.class")
public class Audio {

}

一旦Audio类生成Class文件，key和value就被初始化好了。

这种场景常用于路由框架，在Android组件化架构中就用到了路由框架，如果Audio对象在外部无法访问，通过反射机制可以轻松得到Audio的注解信息。

    Class clazz= null;
    try {
        clazz = Class.forName("com.juexing.mytest.Audio");
        //找到类上的注解
        if (clazz.isAnnotationPresent(Model.class)){
            Model model= (Model) clazz.getAnnotation(Model.class);
            System.out.println(model.key());
            System.out.println(model.value());
        }

        //找到方法上的注解
        Method[] methods = clazz.getMethods();
        for (Method method : methods) {
            for (Annotation annotation : method.getAnnotations()) {
                if (annotation instanceof Model) {
                    System.out.println(((Model) annotation).key());
                    System.out.println(((Model) annotation).value());
                }
            }
        }
    } catch (ClassNotFoundException e) {
        e.printStackTrace();
    }

[本章完]