SpringBoot AOP 記錄操作日志、異常日志

使用SpringBoot AOP 記錄操作日志、異常日志

我們在做項目時經常需要對一些重要功能操作記錄日志，方便以后跟蹤是誰在操作此功能。在操作某些功能時也有可能會發生異常，但是每次發生異常要定位原因都要到服務器去查詢日志才能找到，這樣也不能對發生的異常進行統計。我們可以在需要的方法中增加記錄日志的代碼，和在每個方法中增加記錄異常的代碼，最終把記錄的日志存到數據庫中。

Spring AOP 的主要功能就是將日志記錄，性能統計，安全控制，事務處理，異常處理等代碼從業務邏輯代碼中划分出來。今天我們就來用springBoot Aop 來做日志記錄

一、表結構

使用的數據庫為 PostgreSql，不同數據庫SQL存在差異，自行修改即可。

-- 操作日志表
CREATE TABLE "public"."log_info" (
  "id" varchar(64) COLLATE "pg_catalog"."default" NOT NULL DEFAULT NULL::character varying,
  "module" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "type" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "message" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "req_param" text COLLATE "pg_catalog"."default",
  "res_param" text COLLATE "pg_catalog"."default",
  "take_up_time" int8,
  "user_id" varchar(64) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "user_name" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "method" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "uri" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "ip" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "version" varchar(64) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "create_time" timestamp(6) DEFAULT NULL::timestamp without time zone
);
COMMENT ON COLUMN "public"."log_info"."id" IS '主鍵id';
COMMENT ON COLUMN "public"."log_info"."module" IS '功能模塊';
COMMENT ON COLUMN "public"."log_info"."type" IS '操作類型';
COMMENT ON COLUMN "public"."log_info"."message" IS '操作描述';
COMMENT ON COLUMN "public"."log_info"."req_param" IS '請求參數';
COMMENT ON COLUMN "public"."log_info"."res_param" IS '響應參數';
COMMENT ON COLUMN "public"."log_info"."take_up_time" IS '耗時';
COMMENT ON COLUMN "public"."log_info"."user_id" IS '操作用戶id';
COMMENT ON COLUMN "public"."log_info"."user_name" IS '操作用戶名稱';
COMMENT ON COLUMN "public"."log_info"."method" IS '操作方面';
COMMENT ON COLUMN "public"."log_info"."uri" IS '請求url';
COMMENT ON COLUMN "public"."log_info"."ip" IS '請求IP';
COMMENT ON COLUMN "public"."log_info"."version" IS '版本號';
COMMENT ON COLUMN "public"."log_info"."create_time" IS '創建時間';
COMMENT ON TABLE "public"."log_info" IS '操作日志';

ALTER TABLE "public"."log_info" ADD CONSTRAINT "log_info_pkey" PRIMARY KEY ("id");


-- 異常信息表
CREATE TABLE "public"."log_error_info" (
  "id" varchar(64) COLLATE "pg_catalog"."default" NOT NULL DEFAULT NULL::character varying,
  "req_param" text COLLATE "pg_catalog"."default",
  "name" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "message" text COLLATE "pg_catalog"."default",
  "user_id" varchar(64) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "user_name" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "method" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "uri" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "ip" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "version" varchar(255) COLLATE "pg_catalog"."default" DEFAULT NULL::character varying,
  "create_time" timestamp(6) DEFAULT NULL::timestamp without time zone
)
;
COMMENT ON COLUMN "public"."log_error_info"."id" IS '主鍵id';
COMMENT ON COLUMN "public"."log_error_info"."req_param" IS '請求參數';
COMMENT ON COLUMN "public"."log_error_info"."name" IS '異常名稱';
COMMENT ON COLUMN "public"."log_error_info"."message" IS '異常信息';
COMMENT ON COLUMN "public"."log_error_info"."user_id" IS '操作用戶id';
COMMENT ON COLUMN "public"."log_error_info"."user_name" IS '操作用戶名稱';
COMMENT ON COLUMN "public"."log_error_info"."method" IS '請求方法';
COMMENT ON COLUMN "public"."log_error_info"."uri" IS '請求url';
COMMENT ON COLUMN "public"."log_error_info"."ip" IS '請求IP';
COMMENT ON COLUMN "public"."log_error_info"."version" IS '版本號';
COMMENT ON COLUMN "public"."log_error_info"."create_time" IS '創建時間';
COMMENT ON TABLE "public"."log_error_info" IS '操作日志異常信息';

ALTER TABLE "public"."log_error_info" ADD CONSTRAINT "log_error_info_pkey" PRIMARY KEY ("id");

二、實現

1、添加依賴

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

2、操作日志注解類 Log.java

package com.demo.utils.annotation;

import java.lang.annotation.*;

/**
 * @path：com.demo.utils.annotation.Log.java
 * @className：Log.java
 * @description：自定義操作日志注解
 * @author：tanyp
 * @dateTime：2021/11/18 13:53 
 * @editNote：
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {

    /**
     * 操作模塊
     * @return
     */
    String modul() default "";

    /**
     * 操作類型
     * @return
     */
    String type() default "";

    /**
     * 操作說明
     * @return
     */
    String desc() default "";

}

3、切面類記錄操作日志 LogAspect.java

package com.demo.utils.aop;

import com.alibaba.fastjson.JSON;
import com.demo.domain.LogErrorInfo;
import com.demo.domain.LogInfo;
import com.demo.service.LogErrorInfoService;
import com.demo.service.LogInfoService;
import com.demo.utils.IPUtils;
import com.demo.utils.SecurityUserUtils;
import com.demo.utils.annotation.Log;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.time.LocalDateTime;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.UUID;

/**
 * @path：com.demo.utils.aop.LogAspect.java
 * @className：LogAspect.java
 * @description：切面處理類，操作日志異常日志記錄處理
 * @author：tanyp
 * @dateTime：2021/11/18 13:57 
 * @editNote：
 */
@Aspect
@Component
public class LogAspect {

    /**
     * 操作版本號
     * 項目啟動時從命令行傳入，例如：java -jar xxx.war --version=201902
     */
    @Value("${version}")
    private String version;

    /**
     * 統計請求的處理時間
     */
    ThreadLocal<Long> startTime = new ThreadLocal<>();

    @Autowired
    private LogInfoService logInfoService;

    @Autowired
    private LogErrorInfoService logErrorInfoService;

    /**
     * @methodName：logPoinCut
     * @description：設置操作日志切入點 記錄操作日志 在注解的位置切入代碼
     * @author：tanyp
     * @dateTime：2021/11/18 14:22
     * @Params： []
     * @Return： void
     * @editNote：
     */
    @Pointcut("@annotation(com.demo.utils.annotation.Log)")
    public void logPoinCut() {
    }

    /**
     * @methodName：exceptionLogPoinCut
     * @description：設置操作異常切入點記錄異常日志 掃描所有controller包下操作
     * @author：tanyp
     * @dateTime：2021/11/18 14:22
     * @Params： []
     * @Return： void
     * @editNote：
     */
    @Pointcut("execution(* com.demo.controller..*.*(..))")
    public void exceptionLogPoinCut() {
    }

    @Before("logPoinCut()")
    public void doBefore() {
        // 接收到請求，記錄請求開始時間
        startTime.set(System.currentTimeMillis());
    }

    /**
     * @methodName：doAfterReturning
     * @description：正常返回通知，攔截用戶操作日志，連接點正常執行完成后執行， 如果連接點拋出異常，則不會執行
     * @author：tanyp
     * @dateTime：2021/11/18 14:21
     * @Params： [joinPoint, keys]
     * @Return： void
     * @editNote：
     */
    @AfterReturning(value = "logPoinCut()", returning = "keys")
    public void doAfterReturning(JoinPoint joinPoint, Object keys) {
        // 獲取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();

        // 從獲取RequestAttributes中獲取HttpServletRequest的信息
        HttpServletRequest request = (HttpServletRequest) requestAttributes.resolveReference(RequestAttributes.REFERENCE_REQUEST);

        LogInfo logInfo = LogInfo.builder().build();
        try {
            // 從切面織入點處通過反射機制獲取織入點處的方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();

            // 獲取切入點所在的方法
            Method method = signature.getMethod();

            // 獲取請求的類名
            String className = joinPoint.getTarget().getClass().getName();

            // 獲取操作
            Log log = method.getAnnotation(Log.class);
            if (Objects.nonNull(log)) {
                logInfo.setModule(log.modul());
                logInfo.setType(log.type());
                logInfo.setMessage(log.desc());
            }

            logInfo.setId(UUID.randomUUID().toString());
            logInfo.setMethod(className + "." + method.getName()); // 請求的方法名
            logInfo.setReqParam(JSON.toJSONString(converMap(request.getParameterMap()))); // 請求參數
            logInfo.setResParam(JSON.toJSONString(keys)); // 返回結果
            logInfo.setUserId(SecurityUserUtils.getUser().getId()); // 請求用戶ID
            logInfo.setUserName(SecurityUserUtils.getUser().getUsername()); // 請求用戶名稱
            logInfo.setIp(IPUtils.getIpAddress(request)); // 請求IP
            logInfo.setUri(request.getRequestURI()); // 請求URI
            logInfo.setCreateTime(LocalDateTime.now()); // 創建時間
            logInfo.setVersion(version); // 操作版本
            logInfo.setTakeUpTime(System.currentTimeMillis() - startTime.get()); // 耗時
            logInfoService.save(logInfo);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * @methodName：doAfterThrowing
     * @description：異常返回通知，用於攔截異常日志信息 連接點拋出異常后執行
     * @author：tanyp
     * @dateTime：2021/11/18 14:23
     * @Params： [joinPoint, e]
     * @Return： void
     * @editNote：
     */
    @AfterThrowing(pointcut = "exceptionLogPoinCut()", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
        // 獲取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();

        // 從獲取RequestAttributes中獲取HttpServletRequest的信息
        HttpServletRequest request = (HttpServletRequest) requestAttributes.resolveReference(RequestAttributes.REFERENCE_REQUEST);

        try {
            // 從切面織入點處通過反射機制獲取織入點處的方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();

            // 獲取切入點所在的方法
            Method method = signature.getMethod();

            // 獲取請求的類名
            String className = joinPoint.getTarget().getClass().getName();

            logErrorInfoService.save(
                    LogErrorInfo.builder()
                            .id(UUID.randomUUID().toString())
                            .reqParam(JSON.toJSONString(converMap(request.getParameterMap()))) // 請求參數
                            .method(className + "." + method.getName()) // 請求方法名
                            .name(e.getClass().getName()) // 異常名稱
                            .message(stackTraceToString(e.getClass().getName(), e.getMessage(), e.getStackTrace())) // 異常信息
                            .userId(SecurityUserUtils.getUser().getId()) // 操作員ID
                            .userName(SecurityUserUtils.getUser().getUsername()) // 操作員名稱
                            .uri(request.getRequestURI()) // 操作URI
                            .ip(IPUtils.getIpAddress(request)) // 操作員IP
                            .version(version) // 版本號
                            .createTime(LocalDateTime.now()) // 發生異常時間
                            .build()
            );
        } catch (Exception e2) {
            e2.printStackTrace();
        }
    }

    /**
     * @methodName：converMap
     * @description：轉換request 請求參數
     * @author：tanyp
     * @dateTime：2021/11/18 14:12
     * @Params： [paramMap]
     * @Return： java.util.Map<java.lang.String, java.lang.String>
     * @editNote：
     */
    public Map<String, String> converMap(Map<String, String[]> paramMap) {
        Map<String, String> rtnMap = new HashMap<String, String>();
        for (String key : paramMap.keySet()) {
            rtnMap.put(key, paramMap.get(key)[0]);
        }
        return rtnMap;
    }

    /**
     * @methodName：stackTraceToString
     * @description：轉換異常信息為字符串
     * @author：tanyp
     * @dateTime：2021/11/18 14:12
     * @Params： [exceptionName, exceptionMessage, elements]
     * @Return： java.lang.String
     * @editNote：
     */
    public String stackTraceToString(String exceptionName, String exceptionMessage, StackTraceElement[] elements) {
        StringBuffer strbuff = new StringBuffer();
        for (StackTraceElement stet : elements) {
            strbuff.append(stet + "<br/>");
        }
        String message = exceptionName + ":" + exceptionMessage + "<br/>" + strbuff.toString();
        return message;
    }
}

4、實體類

4.1、LogInfo.java

package com.demo.domain;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.time.LocalDateTime;

/**
 * @path：com.demo.domain.LogInfo.java
 * @className：LogInfo.java
 * @description：操作日志信息
 * @author：tanyp
 * @dateTime：2021/11/18 11:33 
 * @editNote：
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@TableName(value = "log_info")
public class LogInfo {

    // 主鍵id
    @TableId(type = IdType.ASSIGN_UUID)
    private String id;

    // 功能模塊
    private String module;

    // 操作類型
    private String type;

    // 操作描述
    private String message;

    // 請求參數
    private String reqParam;

    // 響應參數
    private String resParam;

    // 耗時
    private Long takeUpTime;

    // 操作用戶id
    private String userId;

    // 操作用戶名稱
    private String userName;

    // 操作方法
    private String method;

    // 請求url
    private String uri;

    // 請求IP
    private String ip;

    // 版本號
    private String version;

    // 創建時間
    private LocalDateTime createTime;

}

4.2、LogErrorInfo.java

package com.demo.domain;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.time.LocalDateTime;

/**
 * @path：com.demo.domain.LogErrorInfo.java
 * @className：LogErrorInfo.java
 * @description：操作日志異常信息
 * @author：tanyp
 * @dateTime：2021/11/18 11:33 
 * @editNote：
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@TableName(value = "log_error_info")
public class LogErrorInfo {

    // 主鍵id
    @TableId(type = IdType.ASSIGN_UUID)
    private String id;

    // 請求參數
    private String reqParam;

    // 異常名稱
    private String name;

    // 異常信息
    private String message;

    // 操作用戶id
    private String userId;

    // 操作用戶名稱
    private String userName;

    // 請求方法
    private String method;

    // 請求url
    private String uri;

    // 請求IP
    private String ip;

    // 版本號
    private String version;

    // 創建時間
    private LocalDateTime createTime;

}

5、在Controller層方法添加@Log注解

@Log(modul = "日志-操作日志分頁", type = Constants.SELECT, desc = "操作日志分頁")
@GetMapping("/logInfoPage")
public Wrapper<IPage<LogInfo>> logInfoPage(Page page) {
    return WrapMapper.wrap(Wrapper.SUCCESS_CODE, Wrapper.SUCCESS_MESSAGE, logInfoService.page(page,Wrappers.<LogInfo>lambdaQuery().orderByDesc(LogInfo::getCreateTime)));
}

三、操作日志、異常日志查詢功能