SpringBoot——AOP面向切面编程-swagger操作日志

- 日理万妓 2021-10-18 14:48 317阅读 0赞

在spring中的AOP是一个重要的部分，但是在工作中需要去自定义一个切面和切面的时候并不多（至少本人是这样的），以至于以前学的一些东西到现在都已经记不清了，所以现在来做一下记录。以便于以后再用到的时提个醒。

**需求**：在系统中我们要加入按钮级别的操作日志，实际上就是借口级别的操作日志，记录的信息为：xx调用了xx接口。

**解决方案**：我的策略是获取所调用接口的类注释 和 方法注释，然后将两个注释的内容拼在一下保存到数据库中。

步骤如下：

1.引入依赖

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

2.编写切点和切面

package com.youyou.address.aop;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.springframework.stereotype.Component;
    
    /**
     * 添加操作日志
     *
     * @author 刘朋
     * <br/>date 2019-04-22
     */
    @Aspect
    @Component
    public class Testaop {
    
        @Pointcut("execution(public * com.youyou.*.controller.*.*(..)) " +
                "|| execution( public * com.youyou.common.base.BaseController.*(..))" +
                "&&@annotation(io.swagger.annotations.ApiOperation)" )
        public void log() {}
    
        @Around("log()&&@annotation(apiOperation)")
        public Object around(ProceedingJoinPoint pjp, ApiOperation apiOperation) {
            Object result = null;
            try {
                //获取类对象
                Class<?> controller = pjp.getThis().getClass();
                //获取swagger接口对象
                Api annotation = controller.getAnnotation(Api.class);
                //获取类接口的内容
                String description = annotation.description();
                System.out.println("调用接口为："+description +"-"+ apiOperation.value());
                //执行方法
                result = pjp.proceed();
            } catch (Throwable throwable) {
                throwable.printStackTrace();
            }
    
            return result;
        }
    
    
    }

这里做一下解释下面的代码

@Pointcut("execution(public * com.youyou.*.controller.*.*(..)) " +
                "|| execution( public * com.youyou.common.base.BaseController.*(..))" +
                "&&@annotation(io.swagger.annotations.ApiOperation)" )

execution(public * com.youyou.*.controller.*.*(..)) 为一个独立的匹配表达式，注解中只需要有一个即可

写三个是为了增加一些匹配规则而一些

第一个 \* 表示方法的返回值为任意类型，如果有需要我们 可以定义自己的类型

第二个 \* 表示通配符

第三个 \* 表示类名

第四个 \* 表示方法名

（…）表示参数为任意数量