自定义注解

原文地址：自定义注解详细介绍_cherry的博客-CSDN博客_自定义注解

一.什么是注解

1.注解是一种能被听啊加到Java代码中的元数据，类，方法，变量，参数和包都可以用注解来写实

注解对于他所修饰的代码没有直接影响

2.注解作用

        1.为编译器提供信息-注解能被编译器检测到错误或抑制警告

2.编译是和部署时的处理-软件工具能处理注解信息生成代码XML文件等

3.运行时处理 有些注解能在运行时被检测到

3.如何自定义注解

1.自定义注解相当于自定义标记

2.使用注解，在代码中标记

3.解析注解，在编译或运行期间，检测到标记执行操作

二.注解基本语法

在Java中，注解声明部分与类，接口，枚举相似，@interface

在底层实现上都会自动继承java.lang.annotation.Annotation接口

public @interface CherryAnnotation
{

}

注解实现部分：

根据我们自定义类的经验，在类实现部分无非就是书写构造、属性或方法。

但是在自定义注解中，其实现部分只能定义一个东西：注解类型元素（annotation type element）：

//自定义注解类型元素
public @interface CherryAnnotation
{
//其中每个都是类型元素
    public String name;
    int age() default 18;
    int[] array();
}

和抽象接口定义类似，default 18;默认初始值

***************************

1. 注解修饰必须为public，也可以不写默认public

2.该元素类型只能是基本数据类型,String,Class，枚举，注解类型（可以嵌套注解）

3.该元素名称一般定义为名词，如果注解中只有一个元素，请把名字起为value（方便）

4.（）没有实际意义，只是一个特殊用法

5.default代表默认值，值须与定义的类型一致

6.如果没有值代表使用注解时必须给该类型元素赋值

***************************

三.常用元注解

1.@Target

        用来限定某个自定义注解能被用在那些Java元素上面

        枚举类

public enum ElementType {
    /** 类，接口（包括注解类型）或枚举的声明 */
    TYPE,

    /** 属性的声明 */
    FIELD,

    /** 方法的声明 */
    METHOD,

    /** 方法形式参数声明 */
    PARAMETER,

    /** 构造方法的声明 */
    CONSTRUCTOR,

    /** 局部变量声明 */
    LOCAL_VARIABLE,

    /** 注解类型声明 */
    ANNOTATION_TYPE,

    /** 包的声明 */
    PACKAGE
}

@Target注解枚举类使用

//自定义注解类型元素
@Target(value = {ElementType.TYPE,ElementType.METHOD})//@Target定义了自定义注解的使用范围只能                    
                                                     //在类和方法
public @interface CherryAnnotation
{
//其中每个都是类型元素
    public String name;
    int age() default 18;
    int[] array();
}

2.@Retention

用来定义注解生效的阶段（1.SOURCE原文件阶段2.CLASS编译阶段3.RUNTIME运行时阶段）

SOURCE不会在编译和运行期间起到任何作用，和注释一个效果，只能呗阅读JAVA文件的人看到

CLASS会被编译到CLASS文件中去，会根据注解做一些处理动作但是JVM虚拟机在JAVA过程中会忽略

RUNTIME是我们开发中自定义注解最经常使用的，在运行期间，我们可以通过反射得到这个注解，判断是否有这个注解和这个注解中属性的值（注解类型元素？）

3.@Documented

用来指定自定义注解是否能锁着被定义的JAVA文件生成到文档中？？？

4.@Inherited

指的是莫格自定义注解写在了父类的声明部分，那么子类的生命部分也能自动拥有该注解

只有@Target定义了ElementType.TYPE的自定义注解起作用

四.特殊用法

1.如果注解本身没有注解类型元素，那么在使用注解时可以忽略（），如@Service

2.如果注解本身只有一个注解类型元素，且命名为value 在使用注解时可以直接使用

        @注解名（注解类型元素值）

3.如果注解中某注解类型元素是一个数组类型，在使用时又出现只需要填入一个值的情况，可以直接写为：@注解名（类型名 = 类型值）和@注解名（类型名 = {类型值}）同效

4.如果@Target定义为PACKAGE时，这个注解配置在package-info.java中，而不能直接卸载package代码上

五.注解灵魂——反射

public class TestAnnotation
{
    public static void main(String[] args)
    {
        //获取Class对象
        Class stuClass = Class.forName("pojo.Student");

        Method stuMethod = stuClass.getMethod("study",int.class);
    
        if(stuMethod.isAnnotationPresent(CherryAnnotation.class))
        {
            sout("Students类上配置了CherryAnnotation注解");
            //获取注解的值
            //1、获得该注解
         
        CherryAnnotation cherryAnnotation=stuMethod.getAnnotation(CherryAnnotation.class);
           //2.取值
            String name = cherryAnnotation.name();
        }
    }
}

isAnnotationPresent(Class<? extends Annotation> annotationClass)方法是专门判断该元素上是否配置有某个指定的注解；

getAnnotation(Class<A> annotationClass)方法是获取该元素上指定的注解。之后再调用该注解的注解类型元素方法就可以获得配置时的值数据；

反射对象上还有一个方法getAnnotations()，该方法可以获得该对象身上配置的所有的注解。它会返回给我们一个注解数组，需要注意的是该数组的类型是Annotation类型，这个Annotation是一个来自于java.lang.annotation包的接口。