AOP实现日志记录

向右看齐 2024-03-30 15:32 9阅读 0赞

需要通过日志记录接口调用信息。便于后期调试排查。并且可能有很多接口都需要进行日志的记录。

接口被调用时日志打印格式如下：

![fe457502eac148888097b0f7af992f1e.png][]

日志打印格式:

log.info("=======Start=======");
            // 打印请求 URL
            log.info("URL            : {}",);
            // 打印描述信息
            log.info("BusinessName   : {}", );
            // 打印 Http method
            log.info("HTTP Method    : {}", );
            // 打印调用 controller 的全路径以及执行方法
            log.info("Class Method   : {}.{}", );
            // 打印请求的 IP
            log.info("IP             : {}",);
            // 打印请求入参
            log.info("Request Args   : {}",);
            // 打印出参
            log.info("Response       : {}", );
            // 结束后换行
            log.info("=======End=======" + System.lineSeparator());

定义自定义注解：

package com.wang.annotation;
    
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * @author 
     */
    @Target({ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface SystemLog {
        String BusinessName();//属性
    }

切面类：

package com.wang.aspect;
    
    import com.alibaba.fastjson.JSON;
    import com.wang.annotation.SystemLog;
    import lombok.extern.slf4j.Slf4j;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Pointcut;
    import org.aspectj.lang.reflect.MethodSignature;
    import org.springframework.stereotype.Component;
    import org.springframework.web.context.request.RequestContextHolder;
    import org.springframework.web.context.request.ServletRequestAttributes;
    
    import javax.servlet.http.HttpServletRequest;
    
    /**
     * 切面类
     * @author 
     */
    @Component
    @Aspect
    @Slf4j
    public class LogAspect {
    
        /**
         * 切点
         */
        @Pointcut("@annotation(com.wang.annotation.SystemLog)")
        public  void  pt(){
    
        }
    
    
        /**
         * 环绕日志
         * @return
         */
        @Around("pt()")
        public Object printLog(ProceedingJoinPoint joinPoint) throws Throwable {
            Object ret;
            try {
                handleBefore(joinPoint);
                ret = joinPoint.proceed();
                handleAfter(ret);
            } finally {
                // 结束后换行
                log.info("=======End=======" + System.lineSeparator());
            }
            return ret;
        }
    
        private void handleAfter(Object ret) {
            // 打印出参
            log.info("Response       : {}", JSON.toJSONString(ret));
        }
    
        private void handleBefore(ProceedingJoinPoint joinPoint) {
            ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = requestAttributes.getRequest();
    
            //获取被增强方法的注解对象
            SystemLog systemLog= getSystemLog(joinPoint);
    
            log.info("=======Start=======");
            // 打印请求 URL
            log.info("URL            : {}",request.getRequestURI());
            // 打印描述信息
            log.info("BusinessName   : {}", systemLog.BusinessName());
            // 打印 Http method
            log.info("HTTP Method    : {}", request.getMethod());
            // 打印调用 controller 的全路径以及执行方法
            log.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringType(),((MethodSignature)joinPoint.getSignature()).getName());
            // 打印请求的 IP
            log.info("IP             : {}",request.getRemoteHost());
            // 打印请求入参
            log.info("Request Args   : {}", JSON.toJSONString(joinPoint.getArgs()));
        }
    
        private SystemLog getSystemLog(ProceedingJoinPoint joinPoint) {
            MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
            SystemLog systemLog = methodSignature.getMethod().getAnnotation(SystemLog.class);
            return systemLog;
        }
    
    }

结果：

![598985ebb6d74cd3b863fc9805ff32bf.png][]

[fe457502eac148888097b0f7af992f1e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/d8f9d55d81dc49b4a1b660fcc384aadd.png
[598985ebb6d74cd3b863fc9805ff32bf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/555d4ed76de24e2fb542666a3dcf1de3.png