@interface 可以用来修饰注解,是注解的注解,称为元注解。(用来自定义注解)
注解相当于一种标记,在程序中加上了注解就等于为程序加上了某种标记,JAVAC编译器,开发工具和运行中程序可以用反射取得类以及各种元素上的标记,根据标记做相应的处理。比如:@Override,@Deprecated,@SuppressWarnings等。
类结构:
public @interface 自定义注解名 { 自定义注解体 }
1. 自定义注解自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成。
2. 在定义注解时,不能继承其他的注解或接口。
3. 使用@interface声明一个注解:
- 每一个方法实际上是声明了一个配置参数
- 方法的名称就是参数的名称
- 返回值类型就是参数的类型,(返回值类型只能是基本类型、Class、String、enum)
- 可以通过default来声明参数的默认值
配置项:
jdk提供了几个配置/注解来配合/规范注解类的使用,一般定义于注解类上
1. @Target
用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
值 | 注解使用范围 |
METHOD | 可用于方法上 |
TYPE | 可用于类或者接口上 |
ANNOTATION_TYPE | 可用于注解类型上(被@interface修饰的类型) |
CONSTRUCTOR | 可用于构造方法上 |
FIELD | 可用于域上 |
LOCAL_VARIABLE | 可用于局部变量上 |
PACKAGE | 用于记录java文件的package信息 |
PARAMETER | 可用于参数上 |
例子:@Target({ ElementType.METHOD }) 表示该注解用于方法上
3. @Retention
主要功能是定义注解保留时间的长短,可以设置的三个值都出自RetentionPolicy
值 | 注解保留时间的长短 |
SOURCE | 在源文件中有效(即源文件保留) |
CLASS | 在class文件中有效(即class保留,默认策略) |
RUNTIME | 在运行时有效(即运行时保留,可以通过此级别获取注解信息) |
例子:@Retention(RetentionPolicy.RUNTIME) 大多注解的使用此参数。
4. @Documented
仅仅作为一个标记注解,说明该注解类应该被javadoc工具记录(默认情况下是不记录的),不在代码运行时产生影响。
5. @Inherited
如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
如果一个子类想获取到父类上的注解信息,那么必须在父类上使用的注解上面 加上@Inherit关键字。
举例:
1、自定义注解MyAnnotation。
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
String version() default "1.0";
}
上面程序中,定义一个注解@MyAnnotation,定义了2个属性,他们的名字为:value,version
- 属性value类型为String,没有默认值
- 属性version类型为String,默认值为1.0
2、使用自定义注解
@MyAnnotation(value = "test", version = "2.0")
public class TestMyAnnotation{
public void output() {
System.out.println("output something!");
}
}
3、测试自定义注解
public static void main(String[] args) throws Exception {
Class cls = Class.forName("TestMyAnnotation");
Method[] method = cls.getMethods();
/** 判断类上是否有MyAnnotation注解 */
boolean flag = cls.isAnnotationPresent(MyAnnotation.class);
if (flag) {
MyAnnotation typeAnno = (MyAnnotation) cls.getAnnotation(MyAnnotation.class);
System.out.println("@MyAnnotation 值:" + typeAnno.value() +
" version:" + typeAnno.version());
}
}
运行数据结果:@MyAnnotation 值:test version:2.0