SpringBoot - 如何实现自定义注解

@Target、@Retention、@Documented 注解的简介

• @Target注解

  功能：指明了修饰的这个注解的使用范围，即被描述的注解可以用在哪里。

  ElementType的取值包含以下几种：

  TYPE:类，接口或者枚举
  FIELD:域，包含枚举常量
  METHOD:方法
  PARAMETER:参数
  CONSTRUCTOR:构造方法
  LOCAL_VARIABLE:局部变量
  ANNOTATION_TYPE:注解类型
  PACKAGE:包
             

• @Retention注解

  功能：指明修饰的注解的生存周期，即会保留到哪个阶段。

  RetentionPolicy的取值包含以下三种：

  SOURCE：源码级别保留，编译后即丢弃
  CLASS:编译级别保留，编译后的class文件中存在，在jvm运行时丢弃，这是默认值
  RUNTIME： 运行级别保留，编译后的class文件中存在，在jvm运行时保留，可以被反射调用
             

• @Documented注解

  功能：指明修饰的注解，可以被例如javadoc此类的工具文档化，只负责标记，没有成员取值。

自己实现一个注解

1、创建一个SpringBoot项目，并导入aop依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
           

2、创建一个@annotation

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {
    String value() default "";
}
           

3、利用aop实现注解功能

package com.gyy.common.aspect;

import com.gyy.common.annotation.SysLog;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

/**
 * @author GYY
 * @version 1.0
 * @date 2020/6/29 20:01
 */
@Aspect
@Component
public class SysLogAspect {

    @Pointcut("@annotation(com.gyy.common.annotation.SysLog)")
    public void logPointCut(){

    }

    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        long beginTime = System.currentTimeMillis();
        //方法返回结果
        Object result = joinPoint.proceed();
        //执行时长
        long time = System.currentTimeMillis() - beginTime;
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        //获取自定义注解上的值
        SysLog sysLog = method.getAnnotation(SysLog.class);
        //获取调用的类名方法名
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        //方法入参
        Object[] args = joinPoint.getArgs();
        System.out.println("注解上的值: "+ sysLog.value());
        System.out.println("执行时间: " + time);
        System.out.println("执行的类和方法: " + className + "." + methodName + "()");
        return result;
    }
}
           

4、编写测试类

@RestController
@RequestMapping("/api/sys")
public class TestController {

    @SysLog("测试注解")
    @GetMapping("/testAnnotation")
    public String testAnnotation(String name){
        return "你好" + name;
    }
}
           

5、结果

（ps：这里我有一个不懂的地方，自定义注解中的方法是用来干啥的，知道的大佬告诉我下）