Spring Boot 自定义注解创建与使用

简介

        注解是一种能被添加到java源代码中的元数据，方法、类、参数和包都可以用注解来修饰。注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。

创建

        基本元素

                1、修饰符必须为public

                2、关键字为@interface

                3、类名等同于注解名

                4、注解可能需要的value

        元注解

                1、@Target()：设置使用范围

          可选参数

ElementType.TYPE	应用于类、接口（包括注解类型）、枚举
ElementType.FIELD	应用于属性（包括枚举中的常量）
ElementType.METHOD	应用于方法
ElementType.PARAMETER	应用于方法的形参
ElementType.CONSTRUCTOR	应用于构造函数
ElementType.LOCAL_VARIABLE	应用于局部变量
ElementType.ANNOTATION_TYPE	应用于注解类型
ElementType.PACKAGE	应用于包

                2、@Retention()：设置生命周期

          可选参数

RetentionPolicy.SOURCE	编译时被丢弃，不包含在类文件中
RetentionPolicy.CLASS	JVM加载时被丢弃，包含在类文件中，默认值
RetentionPolicy.RUNTIME	JVM 加载，包含在类文件中，运行时可以被获取到

                3、@Inherited：父类使用的话，子类可以被继承

                4、@Deprecated：生成文档时，可以显示出注释

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Deprecated
public @interface AnnotationTest {

    String name();
    
}

使用

        自定义注解一般情况下是需要配合AOP来进行使用的，AOP拦截使用这个注解的地方，然后执行AOP的切片代码。

@Aspect
@Component
@Slf4j
public class AspectTest {


    /**
     * 切入点
     */
    @Pointcut("@annotation(com.***.***.***.annotation.AnnotationTest)")
    public void pushAspect() {

    }

    /**
     * 注解需执行的代码
     */
    @Before(value = "pushAspect()")
    public void recordLog(JoinPoint joinPoint) throws Throwable {

    }
}