转载:玄玉–https://jadyer.cn/2011/03/02/java-custom-annotation/ 参考: IT唐伯虎 – https://www.cnblogs.com/liangweiping/p/3837332.html
自定义注解
- 使用@interface 自定义注解时,实际上是隐式的自动继承java.lang.annotation.Annotation接口
- java.lang.annotation.Annotation本身只是接口,也不是注解
- 若显式定义一个接口去继承java.lang.annotation.Annotation接口,则得到的还是普通接口,不是注解
- 自定义注解时,不能继承或实现其它的注解或接口(即注解类型的后面不能跟任何东西)
/**
* @className: BlogDemo
* @description: 博客Demo
* @author: Ian
* @create: 2018-08-11 16:18
**/
enum EnumTest{
Hello,world,welcome;
}
/**
* 自定义注解
*/
public @interface BlogDemo{
/**
定义属性时,需要在后面加上小括号(这个和普通的类或接口是不同的)
且命名为"value"的属性会自动解析为注解的默认属性
比如@JadyerAnnotation("very")会被自动赋值给"value",不过也可以写成 @JadyerAnnotation(value="very")
*/
String value();
/*
对于属性名不叫value的,使用时若需赋值,就要显式的赋值,比如@JadyerAnnotation(username=“very”)
*/
String[] username();
/*
也可以为一个属性设置默认值,使用时若没有显式赋值,则会取其默认值来解析
*/
EnumTest password() default EnumTest.Hello;
/*
1.注解可使用的元素类型是有限的
2.只有原生数据类型、String、Class、annotation、enumeration以及这些类别的一维数组才可以
*/
//Date date(); //非法
}
Target
java.lang.anntation.Target 注解可以用来限定自定义注解的使用对象(若未指定,则自定义注解可以使用在任何位置)
- ElementType.TYPE : 适用 calss、interface、enum
- ElementType.FIELD :适用 field
- ElementType.METHOD:适用method
- ElementType.PARAMETER :适用method上之parameter
- ElementType.CONSTRUCTOR :适用constructor
- ElementType.LOCAL_VARIABLE :适用局部变量
- ElementType.ANNOTATION_TYPE :适用annotation型态
- ElementType.PACKAGE :适用package
@Target(ElementType.METHOD)
public @interface JadyAnnotation{
String value();
}
Documented
使用者想要在制作JavaDoc的同时,也一并将注解信息加入的话 这时就需要使用java.lang.annotation.Documented注解标注
@Documented
public @interface JadyAnnotation{
String hello();
}
Retention
java.lang.annotation.Retention 注解可以在自定义注解时,告知编译程序如何处理自定义注解
- RetentionPolicy.CLASS : 默认值,注解储存于class档案中,但不被虚拟机读取,仅用于编译程序或工具程序运行时提供信息
- RetentionPolicy.SOURCE : 编译程序处理完注解信息后就完成任务,不会被记录在类文件中,而只是存在于
*.java
文件中 - RetentionPolicy.RUNTIME : 编译程序将注解储存于class档案,且可由虚拟机读入,故可反射读取注解信息
@Retention(RetentionPolicy.RUNTIME)
public @interface JadyerAnnotation{
String hello() default "hello";
String world();
}
Inherited
默认的父类中的注解并不会被继承至子类中,若想让子类也继承父类中的注解,可以在自定义注解时配置java.lang.anntation.Inherited 注解
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @Interface JadyerAnnotation{
String value();
}