Spring aop输出注解日志

694 阅读2分钟

场景

现在的接口开发,都会引用swagger作为接口文档,我们希望在controller被调用的使用,利用@ApiOperation注解的value值,输出接口开始被调用和调用结束的日志,方便在服务器中查看。

    @RequestMapping(value = "/testAop", method = RequestMethod.POST)
    @ApiOperation("测试Aop")
    public void testAop(){
        System.out.println("测试Aop");
    }

比如这样子输出日志:
在这里插入图片描述

聊聊spring aop中的概念

  • Aspect(切面): Aspect 声明类似于 Java 中的类声明,在 Aspect 中会包含着一些 Pointcut 以及相应的 Advice。

  • JoinPoint(连接点):表示在程序中明确定义的点,典型的包括方法调用,对类成员的访问以及异常处理程序块的执行等等,它自身还可以嵌套其它JoinPoint。

  • Pointcut(切点):表示一组 joint point,这些 joint point 或是通过逻辑关系组合起来,或是通过通配、正则表达式等方式集中起来,它定义了相应的 Advice 将要发生的地方。

  • Target(目标对象):织入 Advice 的目标对象.。

  • Weaving(织入):将 Aspect 和其他对象连接起来, 并创建 Adviced object 的过程

  • Advice(通知):在JointPoint的执行的时候做什么。

其中Advice的类型有很多种:

  • Before(前置通知):在JoinPoint前被执行的 advice. 虽然 before 是在JoinPoint前被执行, 但是它并不能够阻止 join point 的执行, 除非发生了异常。

  • AfterReturning(返回通知):在一个JoinPoint正常返回后执行的 advice。

  • AfterThrowing(异常通知):当一个JoinPoint抛出异常后执行的 advice。

  • After(后置通知) :无论一个JoinPoint是正常退出还是发生了异常,都会被执行的advice。

  • Around(环绕通知):在JoinPoint前和JoinPoint退出后都执行的advice,这个是最常用的advice。

代码实现:

引入aop的start:

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

aop配置类:

import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

/**
 * @author zj
 */
@Component
@Aspect
@Slf4j
public class LogAspectConfig {

    //输出controller日志,方便定位
    private final String executeExpr = "execution(* com.test.modules.*.controller.*Controller.*(..))";

    @Before(executeExpr)
    public void Before(JoinPoint joinPoint){
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();  //获取JoinPoint方法
        ApiOperation manageLogin = method.getAnnotation(ApiOperation.class);
        if ( manageLogin != null ){
            log.info("["+manageLogin.value()+"]- 接口执行开始------------------");
        }
    }

    @After(executeExpr)
    public void after(JoinPoint joinPoint){
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        ApiOperation manageLogin = method.getAnnotation(ApiOperation.class);
        if ( manageLogin != null ){
            log.info("["+manageLogin.value()+"]- 接口执行结束------------------\n");
        }
    }

}

效果:

在这里插入图片描述