Java自定义注解

文章目录

概述

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。Java 语言中的类、构造器、方法、成员变量、参数等都可以被注解进行标注。

注解的作用
对Java中类、方法、成员变量做标记，然后进行特殊处理，至于到底做何种处理由业务需求来决定。

例如：JUnit框架中，标记了注解@Test的方法就可以被当成测试方法执行，而没有标记的就不能当成测试方法执行。

自定义注解

使用方法

自定义注解就是自己做一个注解来使用。

格式

注意
value属性，如果只有一个value属性的情况下，使用value属性的时候可以省略value名称不写，但是如果有多个属性, 那么没有默认值的属性必须写明。

代码示例

public@interfaceMyBook{Stringname();String[]authors();doubleprice();}

@MyBook(name="《精通JavaSE》",authors ={"黑马","dlei"}, price =199.5)publicclassAnnotationDemo1{@MyBook(name="《精通JavaSE2》",authors ={"黑马","dlei"}, price =199.5)privateAnnotationDemo1(){}@MyBook(name="《精通JavaSE1》",authors ={"黑马","dlei"}, price =199.5)publicstaticvoidmain(String[] args){@MyBook(name="《精通JavaSE2》",authors ={"黑马","dlei"}, price =199.5)int age =21;}}

元注解

就是注解的注解。

元注解有两个

@Target

: 约束自定义注解只能在哪些地方使用；

@Retention

：申明注解的生命周期；

代码示例

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)public@interfaceBookk{Stringvalue();doubleprice()default100;String[]author();}

注解解析

方法

注解的操作中经常需要进行解析，注解的解析就是判断是否存在注解，存在注解就解析出内容。

与注解解析相关的接口
Annotation: 注解的顶级接口，注解都是Annotation类型的对象；
AnnotatedElement:该接口定义了与注解解析相关的解析方法；
方法说明

Annotation[] getDeclaredAnnotations()

获得当前对象上使用的所有注解，返回注解数组

T getDeclaredAnnotation(Class<T> annotationClass)

根据注解类型获得对应注解对象

boolean isAnnotationPresent(Class<Annotation> annotationClass)

判断当前对象是否使用了指定的注解，如果使用了则返回true，否则false
所有的类成分Class, Method , Field , Constructor，都实现了AnnotatedElement接口他们都拥有解析注解的能力

解析注解的技巧

注解在哪个成分上，我们就先拿哪个成分对象。

1. 注解作用成员方法，则要获得该成员方法对应的Method对象，再来拿上面的注解；
2. 注解作用在类上，则要该类的Class对象，再来拿上面的注解；
3. 注解作用在成员变量上，则要获得该成员变量对应的Field对象，再来拿上面的注解；

代码示例

Bookk.java

@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)public@interfaceBookk{Stringvalue();doubleprice()default100;String[]author();}

AnnotationDemo3.java

publicclassAnnotationDemo3{@TestpublicvoidparseClass(){// a.先得到类对象Class c =BookStore.class;// b.判断这个类上面是否存在这个注解if(c.isAnnotationPresent(Bookk.class)){//c.直接获取该注解对象Bookk book =(Bookk) c.getDeclaredAnnotation(Bookk.class);System.out.println(book.value());System.out.println(book.price());System.out.println(Arrays.toString(book.author()));}}@TestpublicvoidparseMethod()throwsNoSuchMethodException{// a.先得到类对象Class c =BookStore.class;Method m = c.getDeclaredMethod("test");// b.判断这个类上面是否存在这个注解if(m.isAnnotationPresent(Bookk.class)){//c.直接获取该注解对象Bookk book =(Bookk) m.getDeclaredAnnotation(Bookk.class);System.out.println(book.value());System.out.println(book.price());System.out.println(Arrays.toString(book.author()));}}}@Bookk(value ="《情深深雨濛濛》", price =99.9, author ={"琼瑶","dlei"})classBookStore{@Bookk(value ="《三少爷的剑》", price =399.9, author ={"古龙","熊耀华"})publicvoidtest(){}}

注解应用：模拟junit

Junit单元测试框架详解

需求
定义若干个方法，只要加了MyTest注解，就可以在启动时被触发执行。

分析

1. 定义一个自定义注解MyTest，只能注解方法，存活范围是一直都在；
2. 定义若干个方法，只要有@MyTest注解的方法就能在启动时被触发执行，没有这个注解的方法不执行；

MyTest.java

@Target({ElementType.METHOD,ElementType.FIELD})// 元注解@Retention(RetentionPolicy.RUNTIME)// 一直活着，在运行阶段这个注解也不消失public@interfaceMyTest{}

AnnotationDemo4.java

publicclassAnnotationDemo4{publicvoidtest1(){System.out.println("===test1===");}@MyTestpublicvoidtest2(){System.out.println("===test2===");}@MyTestpublicvoidtest3(){System.out.println("===test3===");}/**
      启动菜单：有注解的才被调用。
     */publicstaticvoidmain(String[] args)throwsException{AnnotationDemo4 t =newAnnotationDemo4();// a.获取类对象Class c =AnnotationDemo4.class;// b.提取全部方法Method[] methods = c.getDeclaredMethods();// c.遍历方法，看是否有MyTest注解，有就跑它for(Method method : methods){if(method.isAnnotationPresent(MyTest.class)){// 跑它
                method.invoke(t);}}}}