@Target
@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
类型 | 描述 |
---|---|
CONSTRUCTOR | 用于描述构造器 |
FIELD | 用于描述域 |
LOCAL_VARIABLE | 用于描述局部变量 |
METHOD | 用于描述方法 |
PACKAGE | 用于描述包 |
PARAMETER | 用于描述参数 |
TYPE: | 用于描述类、接口(包括注解类型) 或enum声明 |
@Retention:
@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
取值(RetentionPoicy)有:
类型 | 描述 |
---|---|
SOURCE | 在源文件中有效(即源文件保留) |
CLASS | 在class文件中有效(即class保留) |
RUNTIME | 在运行时有效(即运行时保留) |
@Documented:
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
@Inherited:
@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。
自定义注解
package com.pratise.study.annotation;
import java.lang.annotation.*;
/**
* @author cpgroup_lxw
* @version V1.0
* @Title: studyAnnotation
* @Package com.pratise.study.annotaiton
* @Description: 学习自定义注解
* @date 2019-2-1 15:17
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface StudyAnnotation {
String hello() default "hello";
String world();
}
package annotation;
import com.pratise.study.annotation.StudyAnnotation;
/**
* @author cpgroup_lxw
* @version V1.0
* @Title: StudyAnnotationTest
* @Package annotation
* @Description: 自定义注解使用
* @date 2019-2-1 15:29
*/
public class StudyAnnotationTest {
@StudyAnnotation(world = "veryGood")
public void say(){
System.out.println("StudyAnnotationTest is Running!");
}
}
package annotation;
import com.pratise.study.annotation.StudyAnnotation;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
/**
* @author cpgroup_lxw
* @version V1.0
* @Title: StudyReflectionTest
* @Package annotation
* @Description: 使用反射来调用注解内容
* @date 2019-2-1 15:31
*/
public class StudyReflectionTest {
public static void main(String[] args) throws NoSuchMethodException {
Class<StudyAnnotationTest> studyAnnotationTestClass = StudyAnnotationTest.class;
Method say = studyAnnotationTestClass.getMethod("say", new Class[]{});
if (say.isAnnotationPresent(StudyAnnotation.class)){
StudyAnnotation annotation = say.getAnnotation(StudyAnnotation.class);
System.out.println(annotation.world());
System.out.println(annotation.hello());
}
System.out.println("anntation is runned");
Annotation[] annotations = say.getAnnotations();
for (Annotation annotation : annotations) {
System.out.println(annotation.annotationType().getName());
}
}
}