spring boot AOP 记录系统操作日志和异常日志到数据库

1、加入pom.xml坐标

2、日志设计数据库

CREATE TABLE IF NOT EXISTS `exception_log` (
  `excId` int NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `excRequParam` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci COMMENT '请求参数',
  `excName` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '异常名称',
  `excMessage` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci COMMENT '异常信息',
  `operUserId` int DEFAULT NULL COMMENT '操作员ID',
  `operUserName` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '操作员姓名',
  `operMethod` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '请求方法',
  `operUrl` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '请求URL',
  `operIp` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '请求IP',
  `operVer` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '请求版本号',
  `operCreateTime` datetime DEFAULT NULL COMMENT '创建时间',
  PRIMARY KEY (`excId`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=latin1 COMMENT='异常日志表';

CREATE TABLE IF NOT EXISTS `operation_log` (
  `operId` int NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `operModul` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '功能模块',
  `operType` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '操作类型',
  `operDesc` varchar(500) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '操作描述',
  `operRequParam` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci COMMENT '请求参数',
  `operRespParam` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci COMMENT '返回参数',
  `operUserId` int DEFAULT NULL COMMENT '操作员ID',
  `operUserName` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '操作员名称',
  `operMethod` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '操作方法',
  `operUrl` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '请求Url',
  `operIp` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '请求IP',
  `operVer` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '操作版本号',
  `operCreateTime` datetime DEFAULT NULL COMMENT '操作时间',
  PRIMARY KEY (`operId`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=latin1 COMMENT='操作日志表';

3、数据实体类

package com.lw.entity;

import lombok.Data;

import java.util.Date;

/**
 * @Auther:LW
 * @Date:2022年1月8日 21:08
 */
@Data
public class ExceptionLog extends Page{

    private Integer excId;
    private String excRequParam;
    private String excName;
    private String excMessage;
    private Integer operUserId;
    private String operUserName;
    private String operMethod;
    private String operUrl;
    private String operIp;
    private String operVer;
    private Date operCreateTime;

}

package com.lw.entity;

import lombok.Data;
import java.util.Date;


/**
 * @Auther:LW
 * @Date:2022年1月8日 20:21
 */
@Data
public class OperationLog extends Page{

    private Integer operId;
    private String operModul;
    private String operType;
    private String operDesc;
    private String operRequParam;
    private String operRespParam;
    private Integer operUserId;
    private String operUserName;
    private String operMethod;
    private String operUrl;
    private String operIp;
    private String operVer;
    private Date operCreateTime;

}

 4、进行AOP日志切入配置Bean

package com.lw.config;

import java.lang.annotation.*;

/**
 * @Auther:LW
 * @Date:2022年1月8日 19:58
 * AOP日志切入
 */
@Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上
@Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行
@Documented
public @interface  OperLog {
    String operModul() default ""; // 操作模块
    String operType() default "";  // 操作类型
    String operDesc() default "";  // 操作说明
}

  5、进行日志切入操作

package com.lw.config;


import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import com.alibaba.fastjson.JSON;
import com.lw.entity.ExceptionLog;
import com.lw.entity.OperationLog;
import com.lw.entity.SystemUser;
import com.lw.service.SystemLogService;
import com.lw.utils.HttpUtils;
import com.lw.utils.SesionUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;


/**
 * @Auther:LW
 * @Date:2022年1月8日 20:04
 * 登录自定义表单其他参数
 */
@Aspect
@Component
public class OperLogAspect {

    @Autowired
    private Environment env;

    @Autowired
    private SystemLogService systemLogService;

    /**
     * 设置操作日志切入点 记录操作日志 在注解的位置切入代码
     */
    @Pointcut("@annotation(com.lw.config.OperLog)")
    public void operLogPoinCut() {
    }

    /**
    * 设置操作异常切入点记录异常日志 扫描所有controller包下操作
    */
    @Pointcut("execution(* com.lw.controller..*.*(..))")
    public void operExceptionLogPoinCut() {
    }

    /**
     * 正常返回通知，拦截用户操作日志，连接点正常执行完成后执行， 如果连接点抛出异常，则不会执行
     *
     * @param joinPoint 切入点
     * @param keys      返回结果
     */
    @AfterReturning(value = "operLogPoinCut()", returning = "keys")
    public void saveOperLog(JoinPoint joinPoint, Object keys) {
        // 获取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = (HttpServletRequest) requestAttributes
                           .resolveReference(RequestAttributes.REFERENCE_REQUEST);
        OperationLog operlog = new OperationLog();
        try {
            // 从切面织入点处通过反射机制获取织入点处的方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();// 获取切入点所在的方法
            OperLog opLog = method.getAnnotation(OperLog.class);//获取操作
            if (opLog !=null){
                String operModul = opLog.operModul();
                String operType = opLog.operType();
                String operDesc = opLog.operDesc();
                operlog.setOperModul(operModul); // 操作模块
                operlog.setOperType(operType); // 操作类型
                operlog.setOperDesc(operDesc); // 操作描述
            }
            // 获取请求的类名
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = method.getName();// 获取请求的方法名
            methodName = className + "." + methodName;
            operlog.setOperMethod(methodName); // 请求方法
            Map<String, String> rtnMap = converMap(request.getParameterMap());// 请求的参数
            String params = JSON.toJSONString(rtnMap);
            operlog.setOperRequParam(params);
            operlog.setOperRespParam(JSON.toJSONString(keys));
            SystemUser user = SesionUtils.getSysUserSession();
            operlog.setOperUserId(user.getSysId());
            operlog.setOperUserName(user.getUsername());
            operlog.setOperIp(HttpUtils.getIpAddress(request));
            operlog.setOperUrl(request.getRequestURI());
            operlog.setOperVer(env.getProperty("platform.operVer"));
            systemLogService.operationLogAdd(operlog);
        }catch (Exception e){
          e.printStackTrace();
        }
    }


   /**
    * 异常返回通知，用于拦截异常日志信息 连接点抛出异常后执行
    *
    * @param joinPoint 切入点
    * @param e         异常信息
    */
    @AfterThrowing(pointcut = "operExceptionLogPoinCut()", throwing = "e")
    public void saveExceptionLog(JoinPoint joinPoint, Throwable e) {
        // 获取RequestAttributes
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        // 从获取RequestAttributes中获取HttpServletRequest的信息
        HttpServletRequest request = (HttpServletRequest) requestAttributes
                          .resolveReference(RequestAttributes.REFERENCE_REQUEST);

        ExceptionLog excepLog = new ExceptionLog();
        try {
            // 从切面织入点处通过反射机制获取织入点处的方法
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            // 获取切入点所在的方法
            Method method = signature.getMethod();
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = method.getName();
            methodName = className + "." + methodName;
            Map<String, String> rtnMap = converMap(request.getParameterMap());
            String params = JSON.toJSONString(rtnMap);
            excepLog.setExcRequParam(params);
            excepLog.setOperMethod(methodName);
            excepLog.setExcName(e.getClass().getName());
            excepLog.setExcMessage(stackTraceToString(e.getClass().getName(), e.getMessage(), e.getStackTrace()));
            SystemUser user = SesionUtils.getSysUserSession();
            excepLog.setOperUserId(user.getSysId());
            excepLog.setOperUserName(user.getUsername());
            excepLog.setOperUrl(request.getRequestURI());
            excepLog.setOperIp(HttpUtils.getIpAddress(request));
            excepLog.setOperVer(env.getProperty("platform.operVer"));
            systemLogService.exceptionLogAdd(excepLog);
        } catch (Exception e2) {
            e2.printStackTrace();
            }
    }

    /**
     * 转换request 请求参数
     *
     * @param paramMap request获取的参数数组
     */
     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;
     }

    /**
     * 转换异常信息为字符串
     *
     * @param exceptionName    异常名称
     * @param exceptionMessage 异常信息
     * @param elements         堆栈信息
     */
     public String stackTraceToString(String exceptionName, String exceptionMessage, StackTraceElement[] elements) {
        StringBuffer strbuff = new StringBuffer();
        for (StackTraceElement stet : elements) {
            strbuff.append(stet + "\n");
            }
        String message = exceptionName + ":" + exceptionMessage + "\n\t" + strbuff.toString();
        return message;
     }
}

  6、获取IP地址

package com.lw.utils;
import org.apache.commons.lang3.StringUtils;

import javax.servlet.http.HttpServletRequest;

/**
 * @Auther:LW
 * @Date:2022年1月8日 20:58
 */
public class HttpUtils {
/**
 * 获取用户真实IP地址，不使用request.getRemoteAddr();的原因是有可能用户使用了代理软件方式避免真实IP地址,
 *
 * 可是，如果通过了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP值，究竟哪个才是真正的用户端的真实IP呢？
 * 答案是取X-Forwarded-For中第一个非unknown的有效IP字符串。
 *
 * 如：X-Forwarded-For：192.168.1.110, 192.168.1.120, 192.168.1.130,
 * 192.168.1.100
 *
 * 用户真实IP为： 192.168.1.110
 *
 * @param request
 * @return
 */
 public static String getIpAddress(HttpServletRequest request) {
         String Xip = request.getHeader("X-Real-IP");
         String XFor = request.getHeader("X-Forwarded-For");

         //多次反向代理后会有多个ip值，第一个ip才是真实ip
         if (StringUtils.isNotEmpty(XFor) && !"unKnown".equalsIgnoreCase(XFor)) {
             int index = XFor.indexOf(",");
             if (index != -1) {
                 return "0:0:0:0:0:0:0:1".equals(XFor.substring(0, index)) ? "127.0.0.1" : XFor.substring(0, index);
             } else {
                 return "0:0:0:0:0:0:0:1".equals(XFor) ? "127.0.0.1" : XFor;
             }
         }
         XFor = Xip;
         if (StringUtils.isNotEmpty(XFor) && !"unKnown".equalsIgnoreCase(XFor))
             return "0:0:0:0:0:0:0:1".equals(XFor) ? "127.0.0.1" : XFor;

         if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor))
             XFor = request.getHeader("Proxy-Client-IP");

         if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor))
             XFor = request.getHeader("WL-Proxy-Client-IP");

         if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor))
             XFor = request.getHeader("HTTP_CLIENT_IP");

         if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor))
             XFor = request.getHeader("HTTP_X_FORWARDED_FOR");

         if (StringUtils.isBlank(XFor) || "unknown".equalsIgnoreCase(XFor))
             XFor = request.getRemoteAddr();

         return "0:0:0:0:0:0:0:1".equals(XFor) ? "127.0.0.1" : XFor;
     }
}

  6、进行需要记录日志操作加入切入目标

7、后端展示