Annotation(注解)是一个以@interface声明的一个接口,程序可以通过反射来获取指定程序元素的Annotion对象,然后通过Annotion对象来获取注解里面的元数据,要求JDK版本要1.5才有这个功能。Annotation使用起来跟普通的接口基本上相似,只是多了一个@符号。
在系统内部已经内嵌了三个标准的Annotation:
@Override:用于修饰此方法覆盖了父类的方法;
@Deprecated:用于修饰已经过时的方法;
@SuppressWarnnings:用于通知java编译器禁止特定的编译警告。
除了这些外,我们想要自定义一个Annotation的话首先需要了解以下这些内容。
@Target:用于描述注解的使用范围
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
@Retention定义了该Annotation被保留的时间长短
1.SOURCE:在源文件中有效
2.CLASS:在class文件中有效
3.RUNTIME:在运行时有效
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。
@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。
接下来定义一个大学生,包括学校,专业,名字。
学校
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface School {
String schoolName();
}
专业
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Prefessional {
String prefessinalName();
}
名字
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Person {
String name();
}
声明完了Annotation后,接下来就可以定义一个类了(备注:学校纯属乱想的)。
public class Student {
@School(schoolName="清华大学")
private String school;
@Prefessional(prefessinalName="计算机科学与技术专业")
private String prefessional;
@Person(name="Jayuchou")
private String name;
}
那我们怎么取我们定义的这些值呢?
这就需要反射机制来处理:
方法1:< T extends Annotation> T getAnnotation(Class< T > annotationClass): 返回改程序元素上存在的、指定类型的注解,如果该类型注解不存在,则返回null。
方法2:Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
方法3:boolean is AnnotationPresent(Class< ? extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解,存在则返回true,否则返回false.
方法4:Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。
那么我们就可以这么拿值了:
Class clazz = Student.class;
Field[] fields = clazz.getDeclaredFields();
for (Field field : fields) {
if (field.isAnnotationPresent(School.class)) {
School school = field.getAnnotation(School.class);
System.out.println(school.schoolName());
} else if (field.isAnnotationPresent(Prefessional.class)) {
Prefessional prefessional = field.getAnnotation(Prefessional.class);
System.out.println(prefessional.prefessinalName());
} else if (field.isAnnotationPresent(Person.class)) {
Person person = field.getAnnotation(Person.class);
System.out.println(person.name());
}
}
跑起来后就可以看到输出了:
清华大学
计算机科学与技术专业
Jayuchou
ok,像世面上很多优秀的开源库都用到Annotation,有必要好好的了解一下。