Java5增加了对MetaData
的支持,也就是Annotation
。
这些标记在编译、类加载、运行时被读取,并执行相应的处理。通过使用注解,可以在不改变原逻辑的情况下,在源文件中嵌入一些补充信息。
信息被存储在Annotation
的"name-value"键值对中。
Annotation是一个接口,程序可以通过反射获取指定程序元素的Annotation对象,通过该对象获取注解的元数据。
APT(Annotation Processing Tool)
一、基本Annotation
Annotation必须使用工具处理,工具负责提取其中的元数据,还会根据元数据增加额外的功能。
5个基本的Annotation(java.lang包下):
- @Deprecated
- @Override
- @SuppressWarning
- @SafeVarargs
- @FunctionalInterface
@Override
强制一个子类必须覆盖父类的方法。
@Deprecated
表示某个程序元素已过时
@SuppressWarnings
抑制编译器警告
@SuppressWarnings(value="unchecked")
public class Test{
public static void main(String[] args){
//不会有任何编译警告
List<String> t = new ArrayList();
}
}
@SageVararges
List list = new ArrayList<Integer>();
//未经检查的转换,警告
list.add(20);
List<String> ls = list;
//引起运行时异常
System.out.println(ls.get(0));
这种情况称为"堆污染",把一个不带泛型的变量赋给一个带泛型的变量时,往往会发生堆污染。
抑制堆污染警告:
- @SafeVarargs
- @SuppressWarnings("unchecked")
- 编译时使用-Xlint:varargs
@FunctionaInterface
JDK的元Annotation
除了java.lang
包下的5个基本注解。还有java.lang.annotation
报下提供的6个Meta Annotation
。五个用于修饰其他的Annotation
定义。@Repeatable
用于定义Java8新增的重复注释。
@Retention
用于修饰Annotation
定义,指定被修饰的注解可以保留多长时间。包含一个RetentionPolicy
类型的value成员变量。value的值只能有3个:
- RetentionPolicy.CLASS:jvm不可获取,默认值
- RetentionPolicy.RUNTIME:jvm可以获取
- RetentionPolicy.SOURCE:只保留在源代码中,编译器直接丢弃这种
Annotation
如果要使用反射机制获取注释信息,则需要使用RetentionPolicy.RUNTIME
。
@Retention(value=RetentionPolicy.RUNTIME)
public @interface Testable(){}
@Retention(RetentionPolicy.RUNTIME)
public @interface Testable(){}
@Target
只能修饰Annotation
定义,用于指定被修饰的注解能用于修饰哪些程序单元,也包含一个名为value
的成员变量。取值:
- ElementType.ANNOTATION_TYPE
- ElementType.CONSTRUCTOR
- ElementType.FIELD
- ElementType.LOCAL_VARIABLE
- ElementType.METHOD
- ElementType.PACKAGE
- ElementType.TYPE
- ElementType.PARAMETER
@Documented
被该Annotation
标注的Annotation
类将被javadoc工具提取成文档,如果定义Annotation
类是使用了该注解,则所有使用Annotation
修饰的程序元素的api文档中将会包含该Anntation
说明。
@Inherited
指定被它修饰的Annotation
将具有继承性。
二、自定义Annotation
public @interface Test{
}
还可以带成员变量:
public @interface Test{
String name();
int age();
}
非常像定义了一个注释接口,这个注释接口继承了
Annotation
接口
也可以为成员变量指定默认值:
public @interface Test{
String name() default "HelloWorld";
int age() default 25;
}
提取Annotation信息
java.lang.reflect
包下新增了AnnotatedElement
接口,代表程序中可以接受注解的程序元素。该接口的实现类:
- Class
- Constructor
- Field
- Method
- Package
方法:
- <T extends Annotation> T getAnnotation(Class<T> annotationClass)
- Annotation[] getAnnotations()
- default <T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
- default <T extends Annotation> T[] getDeclaredAnnotation(Class<T> annotationClass)
- Annotation[] getDeclaredAnnotations()
- default <T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)
- default boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)
网友评论