如何自定义注解

news2024/12/24 10:17:29

在 Spring Boot 应用中，使用自定义注解时需要用到 AOP，因此引入 AOP 相关依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.7</version>
</dependency>

什么是注解

官方对注解的描述如下：注解是一种能被添加到 Java 代码中的元数据，类、方法、变量、参数和包都可以用注解来修饰。注解对于它所修饰的代码并没有直接的影响。

换句话说，注解是 Java 的一种数据类型，可以用来修饰类、方法、变量、参数和包，它对代码不会有直接的影响。注解的功能和 XML 文件类似。

如何使用自定义注解

注解的使用一共分为以下四步：
声明一个注解

比如我现在想要自定义一个名为 LogAnnotation 的注解，其注解类型元素是 String 为返回值的 key()，实现代码如下所示：

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface LogAnnotation {
    String key() default "";
}

在 JDK 7 以前，Java 语言一共定义了 7 个注解，其中三个注解作用在代码上：

@Override ：检查该方法是否是重写方法。
@Deprecated ：标记过时方法。
@SuppressWarnings ：指示编译器去忽略注解中声明的警告。

有四个注解作用在注解之上，分别是 @Target、@Retention、@Documented、@Inherited 。作用在注解之上的注解又被称之为元注解。

@Target：Target 说明了注解所修饰的对象范围，取值(ElementType)有：

CONSTRUCTOR:用于描述构造器
FIELD:用于描述符
LOCAL_VARIABLE:用于描述局部变量
METHOD:用于描述方法
PACKAGE:用于描述包
PARAMETER: 用于描述参数
TYPE: 用于描述类、接口（包括注解类型）或者 enum 声明

@Retention：Retention 定义了注解的保留范围，取值（RetentionPoicy）有：

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

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

@Inherited: Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了 @Inherited 修饰的 annotation 类型被用于一个 class，则这个 annotation 将被用于该 class 的子类。

在 JDK 7 之后，Java 中新增了三个注解：

@SafeVarargs ：忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
@FunctionalInterface ：标识一个匿名函数或函数式接口。
@Repeatable ：标识某注解可以在同一个声明上使用多次。

编写自己的切面实现类，也就是想要注解实现的功能

import com.lanqiaoyun.springbootdemo.annotation.LogAnnotation;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.context.annotation.Configuration;

//定义这个类为切面，并扫描成bean实例
@Configuration
@Aspect
public class AnnotationAspect {
    //定义切点，切点指向我们的自定义注解
    @Pointcut("@annotation(com.lanqiaoyun.springbootdemo.annotation.LogAnnotation)")
    public void getPointCut(){}
    //使用环绕通知，获取方法名和写在注解中的参数
    @Around("getPointCut()&&@annotation(logAnnotation)")
    public void around(ProceedingJoinPoint jp,LogAnnotation logAnnotation){
        String note=logAnnotation.key();
        String name=jp.getSignature().getName();
        System.out.println("this method name is "+name);
        try {
            jp.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        System.out.println("note is " + note);
    }
    //方法执行结束后输出的内容
    @AfterReturning("getPointCut()")
    public void afterRunning(){
        System.out.println("the method ending");
    }
}