Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。
注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。
1、元注解
元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。
1.1、@Retention: 定义注解的保留策略
@Retention(RetentionPolicy.SOURCE)
//注解仅存在于源码中,在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS)
// 默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
@Retention(RetentionPolicy.RUNTIME)
// 注解会在class字节码文件中存在,在运行时可以通过反射获取到
1.2、@Target:定义注解的作用目标
其定义的源码为:
1 @Documented 2 @Retention(RetentionPolicy.RUNTIME) 3 @Target(ElementType.ANNOTATION_TYPE) 4 public @interface Target { 5 ElementType[] value(); 6 }
@Target(ElementType.TYPE) //接口、类、枚举、注解
@Target(ElementType.FIELD)
//
字段、枚举的常量
@Target(ElementType.METHOD)
//
方法
@Target(ElementType.PARAMETER)
//
方法参数
@Target(ElementType.CONSTRUCTOR)
//
构造函数
@Target(ElementType.LOCAL_VARIABLE)
//
局部变量
@Target(ElementType.ANNOTATION_TYPE)
//
注解
@Target(ElementType.PACKAGE) /
//
包
由以上的源码可以知道,他的elementType 可以有多个,一个注解可以为类的,方法的,字段的等等
1.3、@Document:说明该注解将被包含在javadoc中
1.4、@Inherited:说明子类可以继承父类中的该注解
2、java 注解的自定义
下面是自定义注解的一个例子
@Retention(RetentionPolicy.RUNTIME)
定义的这个注解是注解会在class字节码文件中存在,在运行时可以通过反射获取到。
@Target({ElementType.TYPE,ElementType.METHOD})
因此这个注解可以是类注解,也可以是方法的注解
这样一个注解就自定义好了,当然注解里面的成员可以为基本的数据类型,也可以为数据,Object等等
使用案例:
自定义注解:
@Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation { String[] value1() default "abc"; }
使用自定义注解:
public class AnnotationTest2 { @MyAnnotation(value1={"a","b"}) @Deprecated public void execute(){ System.out.println("method"); } }
读取注解中的信息:
public static void main(String[] args) throws SecurityException, NoSuchMethodException, IllegalArgumentException, IllegalAccessException, InvocationTargetException { AnnotationTest2 annotationTest2 = new AnnotationTest2(); //获取AnnotationTest2的Class实例 Class<AnnotationTest2> c = AnnotationTest2.class; //获取需要处理的方法Method实例 Method method = c.getMethod("execute", new Class[]{}); //判断该方法是否包含MyAnnotation注解 if(method.isAnnotationPresent(MyAnnotation.class)){ //获取该方法的MyAnnotation注解实例 MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class); //执行该方法 method.invoke(annotationTest2, new Object[]{}); //获取myAnnotation String[] value1 = myAnnotation.value1(); System.out.println(value1[0]); } //获取方法上的所有注解 Annotation[] annotations = method.getAnnotations(); for(Annotation annotation : annotations){ System.out.println(annotation); } }