什么是注解?
定义:注解(Annotation),也叫元数据。
一种代码级别的说明。
它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。
它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。
注解是元数据,元数据(metadata )就是描述数据的数据。
给一个元素打上注解可以理解为:A给猪打上一个印章,猪并不知道印章的意义,而B通过印章可得到某些信息。
自定义注解
· 格式
public @interface 注解名{
// 定义体
}
自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。
在定义注解时,不能继承其他的注解或接口。
· 注解的属性
注解的属性即注解的成员变量,但是定义格式略有不同。
注解中没有成员方法。
格式
// 类型名 属性名();
String value();
支持的类型
所有基本类型(int,float,boolean,byte,double,char,long,short)
String、Class、enum、Annotation
上述类型的数组
Java内置注解
· Java5提供的
在java.lang包
@Deprecated:标注在方法上,表示该方法已经过时。
@Override:标注在方法上,表示该方法是覆写父类的。
@SuppressWarnings:其注解目标:类、字段、方法、参数、构造方法、局部变量。
通过设置其属性参数,抑制编译器的警告信息。(并不是真正解决问题,仅屏蔽作用)
· Java7提供的
在java.lang包
@SafeVarargs :抑制堆污染警告。
· 元注解
在java.lang.annotation包
元数据是描述数据的数据,那么元注解就是描述注解的注解。
@Retention
表示注解保留到哪一个时期。共有三种策略:SOURCE,CLASS,RUNTIME。
相关常量封装在RetentionPolicy枚举类中。
public enum RetentionPolicy {
SOURCE,CLASS,RUNTIME
}
1、SOURCE:仅存在于源文件中,编译后就不存在了。
2、CLASS:缺省策略。存在于源文件和编译后的字节码文件中,加载入JVM就不存在了。
3、RUNTIME:存在于源文件、字节码文件、虚拟机中。
@SuppressWarnings()的策略是SOURCE,因为其作用是抑制编译器警告信息,
所以这个标注是给编译器看的,看完后也就没有存在的必要了。
而我们自定义的注解,一般是在运行时,可以通过反射来获取注解数据,完成相应的功能,所以一般选用RUNTIME策略。
@Target
表示注解可在什么位置进行标注。相关常量封装在ElementType中。
public enum ElementType {
TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,
LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE,
/**
* @since 1.8
*/
TYPE_PARAMETER,TYPE_USE
@Document
拥有@Document的注解,所标注的成员,都会保存到API文档中。
如@Deprecated注解上标注了@Document注解:
@Documented
public @interface Deprecated {
}
那么被@Deprecated标注的成员,会自动保存到API文档中。
@Deprecated
public void addItem(String item) {
addItem(item, -1);
}
API文档中
addItem
@Deprecated public void addItem(String item, int index)
已过时。 由
add(String, int)
取代。
@Inherited
表示注解可被继承