【注解汇总】操作日志记录注解

深碍√TFBOYSˉ_ 2024-04-03 10:59 192阅读 0赞

操作日志记录注解

package com.egao.common.core.annotation;
    
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * 操作日志记录注解
     * 
     */
    @Target({ElementType.TYPE, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface OperLog {
    
        /**
         * 模块
         */
        String value();
    
        /**
         * 功能
         */
        String desc();
    
        /**
         * 是否记录请求参数
         */
        boolean param() default true;
    
        /**
         * 是否记录返回结果
         */
        boolean result() default false;
    
    }

package com.egao.common.core.aspect;
    
    import cn.hutool.core.util.StrUtil;
    import com.alibaba.fastjson.JSON;
    import com.egao.common.core.annotation.OperLog;
    import com.egao.common.core.utils.UserAgentGetter;
    import com.egao.common.system.entity.OperRecord;
    import com.egao.common.system.entity.User;
    import com.egao.common.system.service.OperRecordService;
    import org.apache.shiro.SecurityUtils;
    import org.apache.shiro.subject.Subject;
    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.stereotype.Component;
    import org.springframework.web.context.request.RequestContextHolder;
    import org.springframework.web.context.request.ServletRequestAttributes;
    
    import javax.servlet.http.HttpServletRequest;
    import java.lang.reflect.Method;
    
    /**
     * 操作日志记录
     * 
     */
    @Aspect
    @Component
    public class OperLogAspect {
        private ThreadLocal<Long> startTime = new ThreadLocal<>();
        @Autowired
        private OperRecordService operRecordService;
    
        @Pointcut("@annotation(com.egao.common.core.annotation.OperLog)")
        public void operLog() {
        }
    
        @Before("operLog()")
        public void doBefore(JoinPoint joinPoint) throws Throwable {
            startTime.set(System.currentTimeMillis());
        }
    
        @AfterReturning(pointcut = "operLog()", returning = "result")
        public void doAfterReturning(JoinPoint joinPoint, Object result) {
            saveLog(joinPoint, result, null);
        }
    
        @AfterThrowing(value = "operLog()", throwing = "e")
        public void doAfterThrowing(JoinPoint joinPoint, Exception e) {
            saveLog(joinPoint, null, e);
        }
    
        private void saveLog(JoinPoint joinPoint, Object result, Exception e) {
            // 获取reques对象
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = (attributes == null ? null : attributes.getRequest());
            // 构建操作日志
            OperRecord operRecord = new OperRecord();
            operRecord.setUserId(getLoginUserId());
            if (startTime.get() != null) operRecord.setSpendTime(System.currentTimeMillis() - startTime.get());
            if (request != null) {
                operRecord.setRequestMethod(request.getMethod());
                operRecord.setUrl(request.getRequestURI());
                operRecord.setIp(UserAgentGetter.getIp(request));
            }
            // 记录异常信息
            if (e != null) {
                operRecord.setState(1);
                operRecord.setComments(StrUtil.sub(e.toString(), 0, 2000));
            }
            // 记录模块名、操作功能、请求方法、请求参数、返回结果
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            operRecord.setOperMethod(joinPoint.getTarget().getClass().getName() + "." + signature.getName());
            Method method = signature.getMethod();
            if (method != null) {
                OperLog operLog = method.getAnnotation(OperLog.class);
                if (operLog != null) {
                    operRecord.setModel(operLog.value());
                    operRecord.setDescription(operLog.desc());
                    if (operLog.param() && request != null) {
                        operRecord.setParam(StrUtil.sub(JSON.toJSONString(request.getParameterMap()), 0, 2000));
                    }
                    if (operLog.result() && result != null) {
                        operRecord.setResult(StrUtil.sub(JSON.toJSONString(result), 0, 2000));
                    }
                }
            }
            operRecordService.saveAsync(operRecord);
        }
    
        /**
         * 获取当前登录的userId
         */
        private Integer getLoginUserId() {
            Subject subject = SecurityUtils.getSubject();
            if (subject == null) return null;
            Object object = subject.getPrincipal();
            if (object instanceof User) return ((User) object).getUserId();
            return null;
        }
    
    }

使用：

在方法上加

@OperLog(value = "菜单管理", desc = "修改", param = false, result = true)