注解在我们的项目代码中随处可见,是Java提供的设置程序中元素的关联信息和元数据( MetaData)的方法,它是一个接口,程序可以通过反射获取指定程序中元素的注解 对象,然后通过该注解对象获取注解中的元数据信息。平时看到的@override就是注解,我们认识注解之前,需要先学习一下元注解,元注解就是使用在注解之上的注解,标准的元注解包括这几个:@Target、@Retention、@Documented、@Inherited。
@Target说明了注解所修饰的对象范围,包括:
@ Retention定义了注解被保留的级别,SOURCE是源码级别,CLASS是编译期级别,RUNTIME是运行时级别。这三者的关系是SOURCE< CLASS< RUNTIME。
@Documented表明这个注解需要被javadoc工具记录,而后被文档化。
@Inherited是一个标记注解,表明某个被标记的类是被继承的。
我们从一个demo来了解下@Target注解的用法:
定义一个修饰学生的注解:
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.CLASS)
public @interface Student {
public String name() default "zhangsan";
public int age() default 18;
}
这里我设置的修饰范围是Method和Field,那么可以看到,只能在方法和域变量上生效,对于类和参数,则会提示:'@Student' not applicable to type/param
而且当我没有给默认值的话,如果使用了Student注解但未对属性设置值,也会报错:
注解在Android 中有个很好用的地方就是对一些基本数据类型进行校验
我们举个例子:正常我们限制传参时只能传某些个指定的参数的话,会使用枚举类型,但是使用枚举的话,会对每一个枚举项生成一个对象,这样子其实是比较耗内存的。
那如果使用注解的话:
@IntDef({Constant.MALE, Constant.FEMALE}) //android中的注解, 用于几个常用基础类型的定义
@interface Gender {
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
setGender(Constant.MALE);
setGender(9);//传其他的值会报错
}
private void setGender(@Gender int order) {
}
接下来看Retention,先设置Student的保留期为SOURCE,查看ClassMate的class文件可以发现,Student不存在了:
然后我修改成CLASS,就可以在class文件中看到:
这边先给个结果:设置为CLASS的Student注解可以保留到字节码等级,但是运行期却无法保留,现在我写个工具方法,读取ClassMate中带Student注解的元素:
private static String getStudentInfo(Class<?> clazz) {
String info = "";
Field[] declaredFields = clazz.getDeclaredFields();
for (Field field : declaredFields) {
if (field.isAnnotationPresent(Student.class)) {
Student student = field.getAnnotation(Student.class);
info += "name is: " + student.name() + ", age is: " + student.age() + System.lineSeparator(); //纯属为了方便,不要在意性能细节
}
}
return info;
}
然后在main方法中对其进行输出:
public static void main(String[] args) {
String info = getStudentInfo(ClassMate.class);
System.out.println(info);
}
当Retention为class的时候,执行main方法,并不能打印
然后我把保留级别修改成RUNTIME,可以看到,Student注解生效了。
其他两个注解平时见到的少,没啥研究,注解先总结这些,还有一些具体的使用后面再总结补充~