注解可以对类、类中成员和方法进行标注。主要作用有:
1.提供信息给编译器: 编译器可以利用注解来探测错误和警告信息
2.编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html文档或者做
其它相应处理。
3.运行时的处理: 某些注解可以在程序运行的时候接受代码的提取
1 定义一个注解
定义一个注解MyAnnotation:
public @interface MyAnnotation {
int value() default 1;
String tag() default "tag";
}
定义注解通过 @interface , 注解中可以定义成员 , 定义成员以“无形参的方法” 形式来定义,指明属性类型 ,属性类型必须是8种基本数据类型外加接口、类、注解与它们的数组类型。 方法名就是成员变量的名称, 可以通过default设置默认值,也可以不设置默认值。
2 使用注解
使用注解通过@+注解名字的方式来标注
@MyAnnotation(value=5, tag="llala")
public class TestAnnotation {
public static void main(String[] args)
{
}
}
如上,在类TestAnnotation上方标注上注解@MyAnnotation,并且设置注解属性value=5,tag="llala"。
3元注解
元注解就是用来标注注解的注解,Java提供5种元注解@Retention、@Documented、@Target、@Inherited、@Repeatable 。
@Retention
@Retention用来指明注解的有效期,有三种取值SOURCE、CLASS、RUNTIME:
- RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
- RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
- RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。
@Documented
顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。
@Tartget
Target指明注解的应用场景。
ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
@Inherited
如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。
@Repeatable
重复注解。标识该注解可以多次标注。
4 通过反射提取注解信息
如果注解使用@Retention(RetentionPolicy.RUNTIME)标注为运行时注解,通过反射得到的类对象clazz,使用isAnnotationPresent(MyAnnotation.class)方法来判断是否被MyAnnotation.class标注,通过getAnnotation(MyAnnotation.class)来获得指定的注解对象,然后可以访问注解对象内部的成员信息。
@MyAnnotation(value=5, tag="llala")
public class TestAnnotation {
public static void main(String[] args)
{
Class<TestAnnotation> clzz=TestAnnotation.class;
boolean isMarked=clzz.isAnnotationPresent(MyAnnotation.class);//是否被MyAnnotation标注
if(isMarked)
{
MyAnnotation annotation=clzz.getAnnotation(MyAnnotation.class);
int value=annotation.value();
String tag=annotation.tag();
System.out.println("v:"+value+" tag:"+tag);
}
}
}