什么是注解

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

注解的作用

对Java中类、方法、成员变量做标记,然后进行特殊处理。
例如:JUnit框架中,标记了注解@Test的方法就可以被当成测试方法执行,而没有标记的就不能当成测试方法执行

我们可以自定义注解

我们可以简单理解注解是一个打上的标签,所以我们可以自定义注解。自定义注解就是自己做一个注解来使用。
格式如下:

特殊属性:

  • value属性,如果只有一个value属性的情况下,使用value属性的时候可以省略value名称不写!!
  • 但是如果有多个属性, 且多个属性没有默认值,那么value名称是不能省略的。

参考示例:
我们自定义了一个Book和MyBook注解如下

public @interface Book {
    String value(); // 特殊属性
    double price() ;
    double price() default 9.9;
}

public @interface MyBook {
    String name();
    String[] authors();
    double price();
}

在测试类中使用MyBook注解如下

/**
   目标:学会自定义注解。掌握其定义格式和语法。
 */
@MyBook(name="《精通JavaSE》",authors = {"黑马", "dlei"} , price = 199.5)
@Book("/delete")
@Book(value = "/delete", price = 23.5)
public class AnnotationDemo1 {

    @MyBook(name="《精通JavaSE2》",authors = {"黑马", "dlei"} , price = 199.5)
    private AnnotationDemo1(){

    }

    @MyBook(name="《精通JavaSE1》",authors = {"黑马", "dlei"} , price = 199.5)
    public static void main(String[] args) {
        @MyBook(name="《精通JavaSE2》",authors = {"黑马", "dlei"} , price = 199.5)
        int age = 21;
    }
}

可以看到,类、构造器、方法、成员变量、参数等都可以被注解所注释,且注解必须要有实参,有默认值的可不写

有一种注解叫元注解

元注解:就是注解注解的注解。 即给注解标注的注解
常用的元注解(两个):

  • @Target: 约束自定义注解只能在哪些地方使用,可使用的值定义在ElementType枚举类中常用值如下
    • TYPE,类,接口
    • FIELD, 成员变量
    • METHOD, 成员方法
    • PARAMETER, 方法参数
    • CONSTRUCTOR, 构造器
    • LOCAL_VARIABLE, 局部变量
  • @Retention:申明注解的生命周期,可使用的值定义在RetentionPolicy枚举类中,常用值如下
    • SOURCE: 注解只作用在源码阶段,生成的字节码文件中不存在
    • CLASS: 注解作用在源码阶段,字节码文件阶段,运行阶段不存在,默认值.
    • RUNTIME:注解作用在源码阶段,字节码文件阶段,运行阶段(开发常用)【希望注解能永久存在】

参考示例:
首先我们对自定义的MyTest注解进行注解

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

在测试类中使用自定义的MyTest注解

/**
   目标:认识元注解
 */
//@MyTest // 只能注解方法和成员变量
public class AnnotationDemo2 {

    @MyTest
    private String name;

    @MyTest
    public void test(){

    }

    public static void main(String[] args) {

    }
}

注解是如何解析的呢

  1. 首先什么是注解的解析:注解的操作中经常需要进行解析,注解的解析就是判断是否存在注解,存在注解就解析出内容。

  2. 了解注解的接口和继承体系

    • Annotation: 注解的顶级接口,注解都是Annotation类型的对象

    • AnnotatedElement:该接口定义了与注解解析相关的解析方法

      方法 说明
      Annotation[] getDeclaredAnnotations() 获得当前对象上使用的所有注解,返回注解数组。
      T getDeclaredAnnotation(Class<T> annotationClass) 根据注解类型获得对应注解对象
      boolean isAnnotationPresent(Class<Annotation> annotationClass) 判断当前对象是否使用了指定的注解,如果使用了则返回true,否则false
    • 所有的类成分Class, Method , Field , Constructor,都实现了AnnotatedElement接口他们都拥有解析注解的能力

  3. 解析注解的技巧

    • 注解在哪个成分上,我们就先拿哪个成分对象。
    • 比如注解作用成员方法,则要获得该成员方法对应的Method对象,再来拿上面的注解
    • 比如注解作用在类上,则要该类的Class对象,再来拿上面的注解
    • 比如注解作用在成员变量上,则要获得该成员变量对应的Field对象,再来拿上面的注解

参考示例:

  1. 定义注解Book,要求如下:
    • 包含属性:String value() 书名
    • 包含属性:double price() 价格,默认值为 100
    • 包含属性:String[] authors() 多位作者
    • 限制注解使用的位置:类和成员方法上
    • 指定注解的有效范围:RUNTIME
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Bookk {
    String value();
    double price() default 100;
    String[] author();
}
  1. 定义BookStore类,在类和成员方法上使用Book注解
@Bookk(value = "《情深深雨濛濛》", price = 99.9, author = {"琼瑶", "dlei"})
class BookStore{

    @Bookk(value = "《三少爷的剑》", price = 399.9, author = {"古龙", "熊耀华"})
    public void test(){
    }
}
  1. 定义AnnotationDemo01测试类获取Book注解上的数据
/**
   目标:完成注解的解析
 */
public class AnnotationDemo3 {
    @Test
    public void parseClass(){
        // 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()));
        }
    }

    @Test
    public void parseMethod() throws NoSuchMethodException {
        // 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()));
        }
    }
}

再来看一下注解的应用场景

模拟Junit测试框架

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

  1. 定义一个自定义注解MyTest,只能注解方法,存活范围是一直都在。

  2. 定义若干个方法,只要有@MyTest注解的方法就能在启动时被触发执行,没有这个注解的方法不能执行

因为Junnit框架是集成到IDEA中的有相应的右键菜单,当然我们可以制作插件来达成,但现在我们用main方法来模拟

MyTest注解:

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

使用MyTest注解和main方法实现框架效果:

public class AnnotationDemo4 {
    public void test1(){
        System.out.println("===test1===");
    }

    @MyTest
    public void test2(){
        System.out.println("===test2===");
    }

    @MyTest
    public void test3(){
        System.out.println("===test3===");
    }

    /**
      启动菜单:有注解的才被调用。
     */
    public static void main(String[] args) throws Exception {
        AnnotationDemo4 t = new AnnotationDemo4();
        // a.获取类对象
        Class c = AnnotationDemo4.class;
        // b.提取全部方法
        Method[] methods = c.getDeclaredMethods();
        // c.遍历方法,看是否有MyTest注解,有就跑它
        for (Method method : methods) {
            if(method.isAnnotationPresent(MyTest.class)){
                // 跑它
                method.invoke(t);
            }
        }
    }
}