Java注解

一、注解描述

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

二、注解作用

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

三、自定义注解

格式：

格式中：default 默认值 可不写。

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

特殊属性

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

示例：

• 只有一个属性且为value属性
  
• 只有一个属性不为value属性
  
• 有多个属性且其余属性没有默认值

• 有多个属性其余属性皆有默认值
  

四、元注解

元注解：注解中的注解

元注解主要有三个：

• @Target：约束自定义注解只能在哪些地方使用。
• @Retention：申明注解的生命周期。
• @Documented：生成文档时是否显示该注解。(详情查看)

4.1、@Target

@Target 中可使用的值定义在ElementType枚举中。

常用值如下：

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

4.2、@Retention

@Retention 中可使用的值定义在RetentionPolicy枚举类中。

常用值如下：

枚举值	描述
SOURCE	注解只作用在源码阶段，生成的字节码文件中不存在
CLASS	注解作用在源码阶段，字节码文件阶段，运行阶段不存在，这是jvm的默认行为。
RUNTIME	注解作用于源码阶段，字节码文件阶段，运行阶段（开发常用）

五、注解解析

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

与注解解析相关的接口：

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

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

• 所有类成分Class, method, Field, Constructor, 都实现了AnnotatedElement接口他们都拥有解析注解的能力。
  示例：
  
  注解解析示例：

注解类：Book.java

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @program: collectstu
 * @interfaceName Book
 * @description:
 * @author: 太白
 * @create: 2023-01-30 19:34
 **/

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Book {

    String value();
    double price() default 100.0;
    String[] authors();
}

测试类：AnnotationDemo.java

package nj.zb.annotation;

import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;
import java.util.Arrays;

/**
 * @program: collectstu
 * @interfaceName AnnoationDemo
 * @description:
 * @author: 太白
 * @create: 2023-01-30 19:36
 **/
public class AnnotationDemo {

    public static void main(String[] args) throws NoSuchMethodException {
//        先得到类对象
        Class<BookStore> bookStore = BookStore.class;
//        判断这个类是否存在这个注解
        if (bookStore.isAnnotationPresent(Book.class)) {
//            获取该注解对象
            Book book = bookStore.getDeclaredAnnotation(Book.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString( book.authors()));
        }

        Method test = bookStore.getDeclaredMethod("test");
        if (test.isAnnotationPresent(Book.class)) {
            Book book = test.getDeclaredAnnotation(Book.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString( book.authors()));
        }
    }
}

@Book(value = "大唐李白",price = 90,authors = {"张大春"})
class BookStore{

    @Book(value = "余光中散文",price = 25,authors = {"余光中"})
    public void test(){

    }
}