SpringBoot 元注解

了解元注解

元注解就是定义注解的注解，是 Java 提供的用于定义注解的基本注解

元注解

注解	说明
@Retention	是注解类，实现声明类 Class，声明类别 Category，声明扩展 Extension
@Taget	放在自定义注解的上边，表明该注解可以使用的范围
@Inherited	允许子类继承父类的注解，在子类中可以获取使用父类注解
@Documented	表明这个注释是由 Javadoc 记录的
@intertface	用来自定义注释类型

@Taget

该注解的作用是告诉 Java 将自定义的注解放在什么地方，比如类、方法、构造器、变量上等，它的值是一个枚举类型，有如下属性值。

• ElementType.CONSTRUCTOR：用于描述构造器。
• ElementType.FIELD：用于描述成员变量、对象、属性（ 包括enum实例 ）。
• ElementType.LOCAL_VARIABLE：用于描述局部变量。
• ElementType.METHOD：用于描述方法。
• ElementType.PACKAGE：用于描述包。
• ElementType.PARAMETER：用于描述参数。
• ElementType.TYPE：用于描述类、接口（ 包括注解类型 ）或 enum 声明。

@Retention

该注解用于说明自定义注解的生命周期，在注解中有三个生命周期。

• RetentionPolicy.RUNTIME：始终不会丢弃， 运行期也保留读注解，可以使用反射机制读取该注解的信息。 自定义的注解通常使用这种方式。
• RetentionPolicy.CLASS：类加载时丢弃，默认使用这种方式。
• RetentionPolicy.SOURCE：编译阶段丢弃，自定义注解在编译结束之后就不再有意义，所以它们不会写入字节码。@Overide、@SuppressWarnings 都属于这类注解。

@Inherited

该注解是一个标记注解，表明被标注的类型是可以被继承的。如果一个使用了 @Inherited 修饰的 Annotation 类型被用于一个Class，则这个 Annotation 将被用于该 Class 的子类。

@Documented

该注解表示是否将注解信息添加在 Java 文档中。

@intertface

该注解用来声明一个注解， 其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（ 返回值类型只能是基本类型、Class、String、enum ）。可以通过 default 来声明参数的默认值。

定义注解格式的代码：

public @interface 注解名 {定义体}

自定义注解

创建自定义注解类

代码解释如下。

• 使用 @Target 注解标注作用范围。
• 使用 @Retention 注解标注生命周期。
• 使用 @Documented 将注解信息添加在 Java 文档中。

import org.springframework.stereotype.Component;
import java.lang.annotation.*;

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface MyTestAnnotation {
    String value();
}

实现业务逻辑

以  AOP 的方式实现业务逻辑

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

@Aspect
@Component
public class TestAnnotationAspect {
    //拦截被TestAnnotation注解的方法；如果需要拦截指定package指定规则名称的方法，可以使用表达式execution(...)
    @Pointcut("@annotation(com.jia.annotationDemo.MyTestAnnotation)")
    public void myAnnotationPointCut() {
    }

    @Before("myAnnotationPointCut()")
    public void before(JoinPoint joinPoint) {
        MethodSignature sign = (MethodSignature) joinPoint.getSignature();
        Method method = sign.getMethod();
        MyTestAnnotation annotation = method.getAnnotation(MyTestAnnotation.class);
        //获取注解参数
        System.out.print("打印TestAnnotation 参数：" + annotation.value());

    }
}

使用自定义注解

在需要使用的地方使用自定义注解，直接添加注解名即可：

import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
//开启切面编程功能
@EnableAspectJAutoProxy
public class TestController {
    @RequestMapping("/")
    @MyTestAnnotation("测试Annotation")
    public void testAnnotation() {
        System.out.println("测试自定义注解");
    }
}

运行上面代码，输出如下结果