Java Annotation之介绍篇 (1)
JAVA从J2SE5开始提供名为annotation(注释,标注)的功能。Java的annotation,可以附加在package, class, method, field等上面,相当于给它们添加了额外的辅助信息。附加在package, class, method, field等上的Annotation,如果没有外部解析工具等对其加以解析和处理的情况,本身不会对Java的源代码或class等产生任何影响,也不会对它们的执行产生任何影响。
但借助外部工具,比如javac,EJB容器等,可以对附加在package, class, method, field的annotation进行解析,可以根据annotation而做出相应的处理,比如运行时改变对象/方法的行为。
Java标准Annotation
@Deprecated 相当于Javadoc的@deprecated,被@Deprecated标注的对象class, method等被注明为不推荐使用。主要用于javac等编译工具。
@Override 注明对象method重载了父类的方法。javac等编译工具编译时会根据此Annotation判断重载方法是否正确。
@SuppressWarnings 告诉javac等编译器忽略所指定的特定的警告信息。
@Target 被定义的annotation可以附加在那些对象上。
@Retention annotation的作用期间
Java标准Annotation的使用
@Deprecated:
@Deprecated public class TestBean { … }
@SuppressWarnings
@SuppressWarnings("serial") public class TestBean implements java.io.Serializable { … } @SuppressWarnings(value = {"serial", "unchecked"}) public String doSth() { … }
@Override
@Override public String doSth() { … }
Annotation的定义
定义方法:
@interface Annotation名 {定义体}
定义例1:
public @interface MyAnnotation {}
该例定义了一个无任何属性/方法的Annotation。
定义例2:
public @interface MyAnnotation { public String value(); }
该例定义了只有一个方法为value()的Annotation。一般来说,只有一个方法的Annotation,方法名一定定义为value。
定义例3:
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface MyAnnotation { public String value(); public String [] multiValues(); int number() default 0; }
该例定义了一个具有多方法的Annotation。并设置其中一个方法number的默认值为0。multiValues 方法定义为数组类型。Annotation定义可以用MetaAnnotation(元注释)修饰。MetaAnnotation有以下2个:
@Retention
@Target
我们将在以下对@Retention与@Target加以说明。
@Retention
@Retention 可以设置为RetentionPolicy类型的值。
例:
@Retention(RetentionPolicy.RUNTIME)
RetentionPolicy的值 |
说明 |
RetentionPolicy.CLASS |
annotation信息将被编译器编译时保存在class文件中,但执行时不会在VM装载。也就是说不能在执行时动态取得annotation信息。未设置@Retention时这将是默认设置值。 |
RetentionPolicy.RUNTIME |
annotation信息将被编译器编译时保存在class文件中,执行时也会被VM装载。 |
RetentionPolicy.SOURCE |
annotation信息将被编译器编译时舍弃掉。 |
@Target
@Target表明Annotation可以附加在哪种JAVA元素之上,可以设置为java.lang.annotation.ElementType数组类型的值。
使用例1:
1. @Target(ElementType.METHOD)
@Target(ElementType.METHOD)
使用例2:
1. @Target(value={ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD})
@Target(value={ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD})
ElementType是一个枚举类型,它具有以下定义:
ElementType值 |
说明 |
ElementType.ANNOTATION_TYPE |
应用于其他注解的元注解 |
ElementType.CONSTRUCTOR |
构造函数 |
ElementType.FIELD |
字段 |
ElementType.LOCAL_VARIABLE |
方法中的本地变量 |
ElementType.METHOD |
方法 |
ElementType.PACKAGE |
包 |
ElementType.PARAMETER |
方法的参数 |
ElementType.TYPE |
类,接口或者枚举声明
|