Java 自定义注解+AOP 实现日志打印

咱是这么一个场景,通过注解能接口的请求参数拿到,这样每个方法在执行的时候,都能比较统一简单的方式的去获取。

首先引入aop切面的依赖包


      org.springframework.boot
     spring-boot-starter-aop

定义注解

在定义这个注解之前,咱们先了解一下注解的生命周期。通过@Retention定义注解的生命周期,举个例子

@Retention(RetentionPolicy.RUNTIME)

他有三种生命周期的定义,如下,其中RetentionPolicy的不同策略,对应不同的生命周期。

  • RetentionPolicy.SOURCE : 仅存在于源代码中,编译阶段会被丢弃,不会包含于class字节码文件中。@Override, @SuppressWarnings都属于这类注解。
  • RetentionPolicy.CLASS : 默认策略,在class字节码文件中存在,在类加载的时被丢弃,运行时无法获取到。
  • RetentionPolicy.RUNTIME : 始终不会丢弃,可以使用反射获得该注解的信息。自定义的注解最常用的使用方式。

第二个就是注解的作用目标

通过@Target 定义注解的作用目标,比如作用于类、属性或方法等。

@Target(ElementType.TYPE)

对应ElementType参数值适用范围如下

  • ElementType.TYPE: 类、接口、注解、enum
  • ElementType.CONSTRUCTOR: 构造函数
  • ElementType.FIELD: 成员变量、对象、属性、枚举的常量
  • ElementType.LOCAL_VARIABLE: 局部变量
  • ElementType.METHOD: 方法
  • ElementType.PACKAGE: 包
  • ElementType.PARAMETER: 参数
  • ElementType.ANNOTATION_TYPE): 注解
  • ElementType.TYPE_PARAMETER:类型参数,表示这个注解可以用在 Type的声明式前,jdk1.8引入。
  • ElementType.TYPE_USE:类型的注解,表示这个注解可以用在所有使用Type的地方(如:泛型,类型转换等),jdk1.8引入。


还一个注解,框架自带的注解 Inherited。

@Inherited 注解 是定义注解和字类之间的关系。在使用此类的注解,子类会自动继承此注解,否则,子类不会继承此注解。


用实例验证一下

1) 定义一个注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PrintLog {
}


2)在定义一个切面类

@Aspect
@Component
public class PrintLogAspect {

    @Pointcut("@annotation(org.example.myannotion.PrintLog)")
    public void logPoint(){

    }

    @Around("logPoint()")
    public void logAround(ProceedingJoinPoint joinPoint){
 
        String methodName = joinPoint.getSignature().getName();

  
        Object[] param = joinPoint.getArgs();

        StringBuilder sb = new StringBuilder();
        for(Object o: param){
            sb.append(o+";");
        }

        System.out.println("方法:"+methodName+",请求参数是:"+sb.toString());

        try {
            joinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }

        System.out.println("方法执行结束!");
    }

说明:

@Pointcut("@annotation(org.example.myannotion.PrintLog)")

代表定义了一个切点,@annotation表示这个切点切到一个注解上,后面带该注解的全类名。

切面最重要的就是切点,所有的动作都是围绕切点发生。

logPoint() 这个是切点名称,在环绕通知使用的时候,通过 @Around("logPoint()") 使用。

上边介绍完了。下边通过实例去验证一下。

   @PrintLog
    @GetMapping("/t3/{p1}/{p2}")
    public String t3(@PathVariable("p1") String p1, @PathVariable("p2") String p2){
        return "visit t3";
    }

    @PrintLog
    @PostMapping("/t4")
    public String t4(@RequestBody Map param ){
        return "visit t3";
    }

分别请求两个接口后,显示如下。


t3方法:请求参数是:123;bac;
t4方法:   请求参数是:{k1=11, k2=22};

OK 自定义注解,通过切面监听切点的方式,实现方法的参数的打印。

大家有什么想法或问题,欢迎指正。

原文链接:,转发请注明来源!