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");
    }
}

五、運行程序

示例程序將獲取到的結果直接打印到了控制檯，並未對其進行存儲