注解知识学习
目录
- 概述、自定义注解
- 元注解
- @Target
- @Retention
- 注解的解析
- 应用场景
概述、自定义注解
注解(Annotation)
就是Java代码里的特殊标记、比如:@Overwrite
,作用:让其他程序根据注解信息来决定怎么执行该程序
注意:注解可以用在类上、构造器上、方法上、成员变量上、参数上等位置处
自定义注解
就是自己定义注解
public @interface 注解名称{public 属性类型 属性名() default 默认值;
}
注解本质是一个接口,Java中所有注解都是继承了Annotation
接口的
@注解(...)
其实就是一个实现类对象,实现了该注解以及Annotation接口
特殊属性名:value
如果注解中只有一个value
属性,使用注解时,value
名称可以不写
如果还有其他属性,其他属性都有默认值,value
名称也可不写
package annotation;public @interface MyTest5 {int value();String name() default "dd";}
package annotation;@MyTest5(100)
public class AnnotationTest3 {}
元注解
修饰注解的注解就是元注解
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Test{}
@Target
@Target(ElementType.TYPE)
1. TYPE,类,接口
2. FIELD,成员变量
3. METHOD,成员方法
4. PARAMETER,方法参数
5. CONSTRUCTOR,构造器
6. LOCAL_VARIABLE,局部变量
如下MyAnnotation
注解只能用在成员方法、类、接口上
package annotation;import java.lang.annotation.ElementType;
import java.lang.annotation.Target;@Target({ElementType.METHOD, ElementType.TYPE})
public @interface MyAnnotation {String aaa();String[] ccc();boolean bbb() default true;
}
package annotation;
@MyAnnotation(aaa = "hello", ccc = "java")
public class AnnotationTest {@MyAnnotation(aaa = "公主", ccc = "前端")public void test1() {}public static void main(String[] args) {}
}@MyAnnotation(aaa="",ccc="")
interface A{}
@Retention
@Retention
作用:声明注解的保留周期
SOURCE
只作用在源码阶段,字节码文件中不存在CLASS(默认值)
保留到字节码文件阶段,运行阶段不存在RUNTIME(开发常用)
一直保留到运行阶段
创建如下三个注解:
编译器并没有记录下 test2() 方法的注解信息;
编译器分别使用了 RuntimeInvisibleAnnotations 和 RuntimeVisibleAnnotations 属性去记录了test1()方法 和 test3()方法
的注解信息;
注解的解析
注解的解析就是判断类上、方法上、成员变量上是否存在注解,并把注解里的内容给解析出来
如何解析注解?
指导思想:要解析谁上面的注解,就应该先拿到谁
- 比如要解析类上面的注解,则应该先获取该类的Class对象,再通过Class对象解析其上面的注解
- 要解析成员方法上的注解,则应该获取到该成员方法大的Method对象,再通过Method对象解析其上面的注解
- Class、Method、Field、Constructor都实现了AnnotatedElement接口,它们都拥有解析注解的能力
AnnotatedElement接口提供了解析注解的方法 | 说明 |
---|---|
public Annotation[] getDeclaredAnnotations() | 获取当前对象上面的注解 |
public T getDeclaredAnnotation(Class annotationClass) | 获取指定的注解对象 |
public boolean isAnnotationPresent(Class annotationClass) | 判断当前对象上是否存在某个注解 |
解析类注解案例:
package annotation;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD,ElementType.TYPE})
public @interface MyTest4 {String value();double aaa() default 100;String[] bbb();}
package annotation;
@MyTest4(value = "孙悟空",bbb = {"齐天大圣"})
public class Demo2 {@MyTest4(value = "猪八戒",bbb = {"九齿钉耙"})public void test1(){}
}
package annotation;
import java.util.Arrays;public class AnnotationTest2 {public static void main(String[] args) {Class demo2Class = Demo2.class;System.out.println(demo2Class.isAnnotationPresent(MyTest4.class));MyTest4 declaredAnnotation = (MyTest4)demo2Class.getDeclaredAnnotation(MyTest4.class);System.out.println(Arrays.toString(declaredAnnotation.bbb()));System.out.println(declaredAnnotation.value());System.out.println(declaredAnnotation.aaa());}
}
解析方法上注解:
只需要修改如下代码,其他不变
package annotation;
import java.lang.reflect.Method;
import java.util.Arrays;public class AnnotationTest2 {public static void main(String[] args) throws Exception{Class demo2Class = Demo2.class;
// System.out.println(demo2Class.isAnnotationPresent(MyTest4.class));MyTest4 declaredAnnotation = (MyTest4)demo2Class.getDeclaredAnnotation(MyTest4.class);
// System.out.println(Arrays.toString(declaredAnnotation.bbb()));
// System.out.println(declaredAnnotation.value());
// System.out.println(declaredAnnotation.aaa());Method test1 = demo2Class.getDeclaredMethod("test1");if(test1.isAnnotationPresent(MyTest4.class)){MyTest4 declaredAnnotation1 = test1.getDeclaredAnnotation(MyTest4.class);System.out.println(declaredAnnotation1.aaa());System.out.println(declaredAnnotation1.value());System.out.println(Arrays.toString(declaredAnnotation1.bbb()));}}
}
应用场景
配合反射等技术做框架
如下是
模拟Junit框架
需求:
定义若干个方法,只要加了MyTest注解,就会触发该方法的执行
package annotation;
import java.lang.reflect.Method;
public class Demo3 {public static void main(String[] args) throws Exception{Class<Demo3> demo3Class = Demo3.class;Demo3 demo3 = new Demo3();Method[] declaredMethods = demo3Class.getDeclaredMethods();for (Method declaredMethod : declaredMethods) {if(declaredMethod.isAnnotationPresent(MyTest.class)){declaredMethod.invoke(demo3);}}}@MyTestpublic void test1() {System.out.println("方法一执行");}@MyTestpublic void test2() {System.out.println("方法二执行");}@MyTestpublic void test3() {System.out.println("方法三执行");}public void test4() {System.out.println("方法四执行");}}
package annotation;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyTest {}