Spring Boot AOP + 自定义注解Service层实现系统日志记录

项目业务需求，需要对现系统进行用户操作行为审计，并记录每次操作响应时间，帮助快速定位系统瓶颈，相关代码如下：

一、依赖引入

implementation 'org.springframework.boot:spring-boot-starter-aop'

二、自定义系统日志记录监控器注解

package cn.gotham.spring_security_01.common.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 系统日志记录监控器
 * @author tanchong
 * Create Date: 2020/3/9
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SystemLogRecordMonitor {

    /**
     * 模块信息
     */
    String value();
}

三、系统日志拦截器

package cn.gotham.spring_security_01.common.aspect;

import cn.gotham.spring_security_01.common.annotation.SystemLogRecordMonitor;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Component;

import java.sql.Date;
import java.sql.Time;
import java.sql.Timestamp;
import java.text.SimpleDateFormat;
import java.time.LocalDateTime;

/**
 * @author tanchong
 * Create Date: 2020/3/9
 */
@Component
@Aspect
public class SystemLogAspect {
    private final Logger LOGGER = LoggerFactory.getLogger(this.getClass());

//    @Pointcut("execution(* cn.gotham.spring_security_01.user.controller.*Controller.*(..))")
    @Pointcut("@annotation(cn.gotham.spring_security_01.common.annotation.SystemLogRecordMonitor)")
    public void pointCut() {

    }
    
    @Around(value = "pointCut()  && @annotation(systemLogRecordMonitor)")
    public Object recordSystemLog(ProceedingJoinPoint joinPoint, SystemLogRecordMonitor systemLogRecordMonitor ) throws Throwable {
        var startTime = System.currentTimeMillis();
        var format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(startTime));

        var result = joinPoint.proceed(joinPoint.getArgs());
        long endTime = System.currentTimeMillis();
        var value = systemLogRecordMonitor.value();
        // 权限框架使用的是SpringSecurity 
        var authentication = SecurityContextHolder.getContext().getAuthentication();
        var username = authentication.getName();
        LOGGER.info("用户 [ {} ] 于 [ {} ]  访问了 [{}] 模块 耗时 {}/MS.",username,format,value,(endTime-startTime));
        return result;
    }

}

通知类型  

前置通知 Before advice：在连接点前面执行，前置通知不会影响连接点的执行，除非此处抛出异常
正常返回通知 After returning advice ：在连接点正常执行完成后执行，如果连接点抛出异常，则不会执行
异常返回通知 After throwing advice ： 在连接点抛出异常后执行
返回通知 After (finally) advice：在连接点执行完成后执行，不管是正常执行完成，还是抛出异常，都会执行返回通知中的内容
环绕通知 Around advice：环绕着在切入点选择的连接点处的方法所执行的通知，环绕通知可以在方法调用之前和之后自定义任何行为，并且可以决定是否执行连接点处的方法、替换返回值、抛出异常等等

四、Service层使用

package cn.gotham.spring_security_01.user.service;

import cn.gotham.spring_security_01.common.annotation.SystemLogRecordMonitor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;

/**
 * @author tanchong
 * Create Date: 2020/3/9
 */
@Service
public class UserServiceImpl implements UserService {

    private final Logger LOGGER = LoggerFactory.getLogger(this.getClass());

    @SystemLogRecordMonitor("删除")
    @Override
    public void delete() {
        LOGGER.info("一级 delete");
    }

    @SystemLogRecordMonitor("创建")
    @Override
    public void create() {
        LOGGER.info("一级 create");
    }

    @SystemLogRecordMonitor("更新")
    @Override
    public void update() {
        LOGGER.info("一级 update");
    }

    @SystemLogRecordMonitor("获取全部")
    @Override
    public void getAll() {
        LOGGER.info("一级 getAll");
    }
}

五、运行程序

示例程序将获取到的结果直接打印到了控制台，并未对其进行存储