springBoot 框架中自定义注解的原理和使用

今天药忘吃喽~ 2022-09-06 00:16 188阅读 0赞

项目中有些特定的功能需要使用的自定义注解：比如一下AOP使用的时候，可以扫描有注解的接口方法，进而进行切面处理。首先注解可以加在方法、类、参数上。现在看一下注解的类：

1、自定义注解

import java.lang.annotation.*;
    
    /**
     * @author wanghuainan
     * @date 2021/8/19
     */
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    public @interface TestAnnotation {
        /**
         * 是否生效
         * @return
         */
        boolean required() default true;
    
        /**
         * 描述
         * @return
         */
        String desc();
    
        /**
         * 名称
         * @return
         */
        String name() default "";
        
    }

2、**@Target：** 说明了Annotation被修饰的范围，可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标

例：@Target(ElementType.TYPE)

1.ElementType.CONSTRUCTOR:用于描述构造器
    2.ElementType.FIELD:用于描述域（类的成员变量）
    3.ElementType.LOCAL_VARIABLE:用于描述局部变量（方法内部变量）
    4.ElementType.METHOD:用于描述方法
    5.ElementType.PACKAGE:用于描述包
    6.ElementType.PARAMETER:用于描述参数
    7.ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明

3、**@Retention：** 定义了该Annotation被保留的时间长短，有些只在源码中保留，有时需要编译成的class中保留，有些需要程序运行时候保留。即描述注解的生命周期

例：@Retention(RetentionPolicy.RUNTIME)

1.RetentionPoicy.SOURCE:在源文件中有效（即源文件保留）
    2.RetentionPoicy.CLASS:在class文件中有效（即class保留）
    3.RetentionPoicy.RUNTIME:在运行时有效（即运行时保留）

**4.@Documented：** 它是一个标记注解，即没有成员的注解，用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化

**5.@Inherited：** 它也是一个标记注解，它的作用是，被它标注的类型是可被继承的，比如一个class被@Inherited标记，那么一个子类继承该class后，则这个annotation将被用于该class的子类。

6、使用@interface定义一个注解，自动继承了java.lang.annotation.Annotation接口，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

注解参数的可支持数据类型：  
1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)  
2.String类型  
3.Class类型  
4.enum类型  
5.Annotation类型  
6.以上所有类型的数组

到此自定义注解分享完毕，下篇分析自定义注解在切面中的使用，敬请期待！