【aop】使用SpringBoot AOP 记录操作日志、异常日志【转载】

秒速五厘米 2023-01-19 11:58 11阅读 0赞

> `前言`

文章转载自：[https://www.cnblogs.com/wm-dv/p/11735828.html][https_www.cnblogs.com_wm-dv_p_11735828.html]

> `原本内容(实现步骤)`

使用SpringBoot AOP 记录操作日志、异常日志  
　　平时我们在做项目时经常需要对一些重要功能操作记录日志，方便以后跟踪是谁在操作此功能；我们在操作某些功能时也有可能会发生异常，但是每次发生异常要定位原因我们都要到服务器去查询日志才能找到，而且也不能对发生的异常进行统计，从而改进我们的项目，要是能做个功能专门来记录操作日志和异常日志那就好了， 当然我们肯定有方法来做这件事情，而且也不会很难，我们可以在需要的方法中增加记录日志的代码，和在每个方法中增加记录异常的代码，最终把记录的日志存到数据库中。听起来好像很容易，但是我们做起来会发现，做这项工作很繁琐，而且都是在做一些重复性工作，还增加大量冗余代码，这种方式记录日志肯定是不可行的。　　  
　　我们以前学过Spring 三大特性，IOC（控制反转），DI（依赖注入），AOP（面向切面），那其中AOP的主要功能就是将日志记录，性能统计，安全控制，事务处理，异常处理等代码从业务逻辑代码中划分出来。今天我们就来用springBoot Aop 来做日志记录，好了，废话说了一大堆还是上货吧。

*  创建数据库  
    操作日志表  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70]  
    异常日志表  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 1]
 *  添加maven依赖

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

*  创建自定义注解：@OperLog

import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /** * 自定义操作日志注解 * @author wu */
    @Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上
    @Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行
    @Documented
    public @interface OperLog { 
        String operModul() default ""; // 操作模块
        String operType() default "";  // 操作类型
        String operDesc() default "";  // 操作说明
    }

*  创建切面类记录操作日志

import java.lang.reflect.Method;
    import java.util.Date;
    import java.util.HashMap;
    import java.util.Map;
    
    import javax.servlet.http.HttpServletRequest;
    
    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.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    import org.springframework.web.context.request.RequestAttributes;
    import org.springframework.web.context.request.RequestContextHolder;
    
    import com.gexin.fastjson.JSON;
    import com.hyd.zcar.cms.common.utils.IPUtil;
    import com.hyd.zcar.cms.common.utils.annotation.OperLog;
    import com.hyd.zcar.cms.common.utils.base.UuidUtil;
    import com.hyd.zcar.cms.common.utils.security.UserShiroUtil;
    import com.hyd.zcar.cms.entity.system.log.ExceptionLog;
    import com.hyd.zcar.cms.entity.system.log.OperationLog;
    import com.hyd.zcar.cms.service.system.log.ExceptionLogService;
    import com.hyd.zcar.cms.service.system.log.OperationLogService;
    
    /** * 切面处理类，操作日志异常日志记录处理 * * @author wu * @date 2019/03/21 */
    @Aspect
    @Component
    public class OperLogAspect { 
    
        /** * 操作版本号 * <p> * 项目启动时从命令行传入，例如：java -jar xxx.war --version=201902 * </p> */
        @Value("${version}")
        private String operVer;
    
        @Autowired
        private OperationLogService operationLogService;
    
        @Autowired
        private ExceptionLogService exceptionLogService;
    
        /** * 设置操作日志切入点 记录操作日志 在注解的位置切入代码 */
        @Pointcut("@annotation(com.hyd.zcar.cms.common.utils.annotation.OperLog)")
        public void operLogPoinCut() { 
        }
    
        /** * 设置操作异常切入点记录异常日志 扫描所有controller包下操作 */
        @Pointcut("execution(* com.hyd.zcar.cms.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();
            // 从获取RequestAttributes中获取HttpServletRequest的信息
            HttpServletRequest request = (HttpServletRequest) requestAttributes
                    .resolveReference(RequestAttributes.REFERENCE_REQUEST);
    
            OperationLog operlog = new OperationLog();
            try { 
                operlog.setOperId(UuidUtil.get32UUID()); // 主键ID
    
                // 从切面织入点处通过反射机制获取织入点处的方法
                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());
                // 将参数所在的数组转换成json
                String params = JSON.toJSONString(rtnMap);
    
                operlog.setOperRequParam(params); // 请求参数
                operlog.setOperRespParam(JSON.toJSONString(keys)); // 返回结果
                operlog.setOperUserId(UserShiroUtil.getCurrentUserLoginName()); // 请求用户ID
                operlog.setOperUserName(UserShiroUtil.getCurrentUserName()); // 请求用户名称
                operlog.setOperIp(IPUtil.getRemortIP(request)); // 请求IP
                operlog.setOperUri(request.getRequestURI()); // 请求URI
                operlog.setOperCreateTime(new Date()); // 创建时间
                operlog.setOperVer(operVer); // 操作版本
                operationLogService.insert(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();
                excepLog.setExcId(UuidUtil.get32UUID());
                // 获取请求的类名
                String className = joinPoint.getTarget().getClass().getName();
                // 获取请求的方法名
                String methodName = method.getName();
                methodName = className + "." + methodName;
                // 请求的参数
                Map<String, String> rtnMap = converMap(request.getParameterMap());
                // 将参数所在的数组转换成json
                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())); // 异常信息
                excepLog.setOperUserId(UserShiroUtil.getCurrentUserLoginName()); // 操作员ID
                excepLog.setOperUserName(UserShiroUtil.getCurrentUserName()); // 操作员名称
                excepLog.setOperUri(request.getRequestURI()); // 操作URI
                excepLog.setOperIp(IPUtil.getRemortIP(request)); // 操作员IP
                excepLog.setOperVer(operVer); // 操作版本号
                excepLog.setOperCreateTime(new Date()); // 发生异常时间
    
                exceptionLogService.insert(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;
        }
    }

*  在Controller层方法添加@OperLog注解  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 2]
 *  操作日志、异常日志查询功能  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 3]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 4]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 5]  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 6]

> `附件sql`

因为我们的需求没有异常记录，有异常会发邮件的，所以我这边只添加了日志记录表（且里面没有`操作员名称`）。

DROP TABLE IF EXISTS `md_operation_log`;
    CREATE TABLE `md_operation_log` (
      `oper_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键id',
      `oper_modul` varchar(64) DEFAULT NULL COMMENT '功能模块',
      `oper_type` varchar(64) DEFAULT NULL COMMENT '操作类型',
      `oper_desc` varchar(500) DEFAULT NULL COMMENT '操作描述',
      `oper_requ_param` text COMMENT '请求参数',
      `oper_resp_param` text COMMENT '返回参数',
      `oper_user_id` int(11) DEFAULT NULL COMMENT '操作员id',
      `oper_method` varchar(255) DEFAULT NULL COMMENT '操作方法',
      `oper_uri` varchar(255) DEFAULT NULL COMMENT '请求uri',
      `oper_ip` varchar(255) DEFAULT NULL COMMENT '请求ip',
      `oper_create_time` datetime DEFAULT NULL COMMENT '请求时间',
      `oper_ver` varchar(255) DEFAULT NULL COMMENT '请求版本号',
      PRIMARY KEY (`oper_id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=252 DEFAULT CHARSET=utf8mb4 COMMENT='操作日志表';

> `改动`

我这里把他这个操作类型类根据自己的需求改成了枚举，原先是常量。  
原因：  
首先，依然有常量的功能；  
其次，在回显的时候，在枚举里面通过方法，可以根据value值获取到名称；  
最后，可以再加一个接口，把整个枚举类转map返回到前端，让前端方便根据类型来查询。  
示例如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 7]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 8]  
![在这里插入图片描述][20210510141403294.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 9]  
枚举类代码

public enum OperLogTypeEnum { 
        LIST("列表","list"),
        ADD("添加","add"),
        EDIT("编辑","edit"),
        DELETE("删除","delete"),
        DISABLE("禁用","disable"),
        CANCEL("取消","cancel"),
        DOWNLOAD("下载","download");
    
        private String typeName;
        private String typeValue;
    
        /** * 获取类型名称 * * @param typeValue * @return */
        public static String getTypeName(String typeValue){ 
            for (OperLogTypeEnum operLogTypeEnum : OperLogTypeEnum.values()) { 
                if(operLogTypeEnum.getTypeValue().equals(typeValue)){ 
                    return operLogTypeEnum.typeName;
                }
            }
            return null;
        }
    
        OperLogTypeEnum(String typeName, String typeValue) { 
            this.typeName = typeName;
            this.typeValue = typeValue;
        }
    
        public String getTypeName() { 
            return typeName;
        }
    
        public void setTypeName(String typeName) { 
            this.typeName = typeName;
        }
    
        public String getTypeValue() { 
            return typeValue;
        }
    
        public void setTypeValue(String typeValue) { 
            this.typeValue = typeValue;
        }
    }

[https_www.cnblogs.com_wm-dv_p_11735828.html]: https://www.cnblogs.com/wm-dv/p/11735828.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70]: /images/20221021/ba10595854e548d3bb169dbff0ff7e6e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 1]: /images/20221021/cc86288be2e440f4aecb9ce78e777e6e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 2]: /images/20221021/ab2da9fd98174c19baceb708eb074c67.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 3]: /images/20221021/97221dd033484eaba752e93892206c14.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 4]: /images/20221021/bdb034fd3ade4a28a7424a8ecf50d02a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 5]: /images/20221021/8de0a4fbcec4461f8049c84179b19b0d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 6]: /images/20221021/5e73e84601e04cf6bb75d0e8472dbf63.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 7]: /images/20221021/f4af57e21e5449b8a432006976edac2f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 8]: /images/20221021/7296eb7f92a34086b723c46a721bc563.png
[20210510141403294.png]: /images/20221021/f177b7cc8f434c03b76358d711758cd1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3MxNDQxMTAxMjY1_size_16_color_FFFFFF_t_70 9]: /images/20221021/9e03d302995d4b32b120d07262fb2912.png