Java注解的使用
一、理解Annotation
- jdk5.0新增的功能。
- 是代码里的特殊标记,可以在编译、类加载、运行时被读取,并执行相应的处理。通过使用Annotation,程序员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充信息。
- 在JavaSE中,注解的使用目的比较简单。在JavaEE与Android中注解占据了更重要的角色。
二、Annotation的使用示例
示例一:生成文档相关的注解
示例二:在编译时进行格式检查(JDK内置的三个基本注解)
- @Override:限定重写父类方法,该注解只能用于方法。
- @Deprecated:用于表示所修饰的元素(类,方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择。
- @SuppressWarnings:抑制编译器警告。
示例三:跟踪代码依赖性,实现替代配置文件功能
三、如何自定义注解
参照@SuppressWarnings定义
- 注解声明为:@interface
- 内部定义成员,通常使用value表示
- 可以指定成员的默认值,使用default定义
- 如果自定义注解没有成员,表明是一个标识作用
如果注解有成员,在使用注解时,需要指明成员的值。
自定义注解必须配上注解的信息处理流程(使用反射)才有意义。
自定义注解通常都会指明两个元注解:Retention、Target
四、jdk提供的四种元注解
元注解:对现有的注解进行解释说明的注解
- Retention:指定所修饰的Annotation的生命周期:SOURCECLASSRUNTIME,只有声明为RUNTIME生命周期的注解,才能通过反射获取。
- Target:用于指定被修饰的Annotation能用于修饰哪些程序元素。
(以下两个注解出现频率较低) - Document:表示所修饰的注解在被javadoc解析时,保留下来。
- Inherited:被它修饰的Annotation将具有继承性。
@Inherited
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
String value() default "hello";
}
五、通过反射获取注解信息
@Test
public void testGetAnnotation() {
Class<Student> studentClass = Student.class;
Annotation[] annotations = studentClass.getAnnotations();
for (int i = 0; i < annotations.length; i++) {
System.out.println(annotations[i]);
}
}
六、jdk8中注解的新特性
-
可重复注解:
- 在MyAnnotation上声明@Repeatable,成员值为MyAnnotations.class
- MyAnnotation中的Target、Retention等元注解与MyAnnotations相同。
//jdk8之前的写法:
//@MyAnnotations({@MyAnnotation("hi"),@MyAnnotation("abc")})
@MyAnnotation("hi")
@MyAnnotation("abc")
-
类型注解:
- ElementType.TYPE_PARAMETER:表示该注解能写在类型变量的声明语句中(如:泛型声明)。
- ElementType.TYPE_USE:表示该注解能写在使用类型的任何语句中。
class Generic<@MyAnnotation T>{
public void show() throws @MyAnnotation RuntimeException{
ArrayList<@MyAnnotation String> list = new ArrayList<>();
int num = (@MyAnnotation int)10L;
}
}