注解的应用

1、简介

1.1 概念

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

1.2 作用

对Java中类、方法、成员变量做标记，然后进行特殊处理，至于到底做何种处理由业务需求来决定。
例如：JUnit框架中，标记了注解@Test的方法就可以被当成测试方法执行，而没有标记的就不能当成测试方法执行。

2、自定义注解

2.1 自定义注解格式

public @interface 注解名称 {
    public 属性类型 属性名() default 默认值 ;
}

2.2 特殊属性

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

package com.annotation;
public @interface Book {
    String value();
}

2.3 自定义注解格式示例

package com.annotation;
public @interface MyBook {

    public String name();
    String[] authors();
    double price();
}

package com.annotation;
public @interface Book {
    String value();
}

package com.annotation;
public @interface TestBook {
    String value();
    double price() default 12;
}

package com.annotation;
//有多个属性,  其他属性都有默认值，那么value名称可以省略
@TestBook("222")
//只有一个属性value的情况下，使用value属性的时候可以省略,名称不写
@Book("111")
//有多个属性,  且多个属性没有默认值，那么value名称是不能省略的
@MyBook(name = "精通java", authors = {"张三"}, price = 100)
public class AnnotationDemo {

    @MyBook(name = "精通java", authors = {"张三"}, price = 100)
    public AnnotationDemo() {
    }

    @MyBook(name = "精通java", authors = {"张三"}, price = 100)
    public static void main(String[] args) {

        @MyBook(name = "精通java", authors = {"张三"}, price = 100)
        int age = 10;
    }
}

3、元注解

3.1 元注解是什么

注解注解的注解。

3.1 常见的两个元注解

@Target: 约束自定义注解只能在哪些地方使用，可使用的值定义在ElementType枚举类中

枚举值	说明
ElementType.TYPE	类，接口
ElementType.FIELD	成员变量
ElementType.METHOD	成员方法
ElementType.PARAMETER	方法参数
ElementType.CONSTRUCTOR	构造器
ElementType.LOCAL_VARIABLE	局部变量

@Retention：申明注解的生命周期，可使用的值定义在RetentionPolicy枚举类中

枚举值	说明
RetentionPolicy.SOURCE	注解只作用在源码阶段，生成的字节码文件中不存在
RetentionPolicy.CLASS	注解作用在源码阶段，字节码文件阶段，运行阶段不存在，默认值.
RetentionPolicy.RUNTIME	注解作用在源码阶段，字节码文件阶段，运行阶段（开发常用）

package com.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Field;

//只能注解方法和成员变量
@Target({ElementType.METHOD, ElementType.FIELD})
//一直活着，在运行阶段这个注解也不消失
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTest {
}

package com.annotation;

//@MyTest  不能注解类
public class AnnotationDemo02 {
    @MyTest
    private String name;

    @MyTest
    public static void main(String[] args) {

    }
}

4、注解的解析

4.1 注解解析是什么

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

4.2 与注解解析相关的接口

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

方法	说明
Annotation[] getDeclaredAnnotations()	获得当前对象上使用的所有注解，返回注解数组
T getDeclaredAnnotation(Class annotationClass)	根据注解类型获得对应注解对象
boolean isAnnotationPresent(Class annotationClass)	判断当前对象是否使用了指定的注解，如果使用了则返回true，否则false

所有的类成分Class, Method , Field , Constructor，都实现了AnnotatedElement接口他们都拥有解析注解的能力

4.3 解析注解的技巧

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

package com.annotatedelement;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//设置注解的使用范围为类和方法
@Target({ElementType.TYPE,ElementType.METHOD})
//设置注解作用在源码阶段，字节码文件阶段，运行阶段
@Retention(RetentionPolicy.RUNTIME)
public @interface BookTest {
    String value();
    double price() default 100;
    String[] authors();

}

package com.annotatedelement;
@BookTest(value = "书名1",authors = {"琼瑶","金庸1"})
public class BookStore {

    @BookTest(value = "书名2",authors = {"古龙","金庸2"})
    public void test(){

    }
}

package com.annotatedelement;
import org.junit.Test;
import java.lang.reflect.Method;
import java.util.Arrays;

/*
注解的解析
 */
public class AnnotatedElement01 {
    @Test
    public  void paraseClass() throws NoSuchMethodException {

        //得到类对象
        Class c = BookStore.class;

        //判断这个类是否有这个注解
        if(c.isAnnotationPresent(BookTest.class)){
            //获取注解对象
            BookTest book = (BookTest) c.getDeclaredAnnotation(BookTest.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.authors()));
        }
        //判断这个类的方法是否有这个注解
		Method m = c.getDeclaredMethod("test");
        if(m.isAnnotationPresent(BookTest.class)){
            //获取注解对象
            BookTest book = (BookTest) m.getDeclaredAnnotation(BookTest.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.authors()));
        }

    }
}

5、注解的应用场景：Junit框架

模拟Junit

package com.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Field;
//下面这部分为什么这样设置可以看Junit的@Test源码
//只能注解方法
@Target({ElementType.METHOD})
//一直活着，在运行阶段这个注解也不消失
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTest {
}

package com.annotation;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

public class AnnotationDemo03 {
    @MyTest
    public void test1(){
        System.out.println("test1");
    }
    public void test2(){
        System.out.println("test2");
    }
    @MyTest
    public void test3(){
        System.out.println("test3");
    }

    /*
    启动菜单：执行有注解的
     */
    public static void main(String[] args) throws InvocationTargetException, IllegalAccessException {
        AnnotationDemo03 t = new AnnotationDemo03();
        //获取类对象
        Class c  = AnnotationDemo03.class;
        //提取全部方法
        Method[] methods = c.getDeclaredMethods();
        //遍历方法，有注解就执行
        for (Method method : methods) {
            if(method.isAnnotationPresent(MyTest.class)){
                //运行
                method.invoke(t);
            }
        }
    }
}

测试结果

test1
test3