在Spring Boot 项目中使用Spring AOP实现切面日志

刺骨的言语ヽ痛彻心扉 2022-09-02 14:57 165阅读 0赞

> **导语**  
>   大数据时代，数据来源是比较重要的。而日志作为用户操作、系统监控、业务分析等都比较重要的一个环节。能更好的使用日志显得尤为重要。那么在Spring Boot的项目中如何能更加高效的记录Controller层的日志呢？这个就是今天需要讨论的问题。

直接上代码，不过在实现之前，为了让项目支持AOP的操作这里首先需要引入一个maven依赖，这里对于AOP的原理就先不做说明了，是一个比较大的内容。

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

这里需要我们基于注解来实现，这样，在有需要的Controller中直接标注相应的注解就可以了。这里我们就可以将整个注解称为是一个切点。

@Target({  ElementType.PARAMETER, ElementType.METHOD })
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface LogAs { 
    
        /** * 模块 */
        public String title() default "";
    
        /** * 小程序端 */
        public int client() default 2;
    
        /** * 业务类型 */
        public int businessType() default 0;
    }

@Aspect
    @Component
    public class LogAspect { 
    
        private static final Logger log = LoggerFactory.getLogger(LogAspect.class);
    
        // 配置织入点
        @Pointcut("@annotation(com.ziicoo.ksxt.core.annotation.LogAs)")
        public void logPointCut()
        { 
        }
    
    
        @Before("logPointCut()")
        public void doBefore(JoinPoint joinPoint){ 
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
    
            try { 
                LogAs controllerLogAs = getAnnotationLog(joinPoint);
                log.info("URL : " + request.getRequestURL().toString());
                log.info("HTTP_METHOD : " + request.getMethod());
                log.info("IP : " + request.getRemoteAddr());
                log.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
                log.info("ARGS : " + Arrays.toString(joinPoint.getArgs()));
                log.info("ARGS : " + JSONObject.toJSONString(joinPoint.getArgs()));
    
            } catch (Exception e) { 
                e.printStackTrace();
            }
    
    
        }
    
    // @Around("logPointCut()")
    // public void around(JoinPoint joinPoint){ 
    //
    // log.info("环绕");
    // }
    
        @After("logPointCut()")
        public void doAfter(JoinPoint joinPoint){ 
            log.info("操作内容");
        }
    
        /** * 处理完请求后执行 * * @param joinPoint 切点 */
        @AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
        public void doAfterReturning(JoinPoint joinPoint, Object jsonResult)
        { 
    
            handleLog(joinPoint, null, jsonResult);
        }
    
        protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult)
        { 
            try
            { 
                // 获得注解
                LogAs controllerLogAs = getAnnotationLog(joinPoint);
                if (controllerLogAs == null)
                { 
                    return;
                }
    
                log.info(JSONObject.toJSONString(jsonResult));
                log.info(jsonResult.toString());
    
            }
            catch (Exception exp)
            { 
                // 记录本地异常日志
                log.error("==前置通知异常==");
                log.error("异常信息:{}", exp.getMessage());
                exp.printStackTrace();
            }
        }
    
        /** * 是否存在注解，如果存在就获取 */
        private LogAs getAnnotationLog(JoinPoint joinPoint) throws Exception
        { 
            Signature signature = joinPoint.getSignature();
            MethodSignature methodSignature = (MethodSignature) signature;
            Method method = methodSignature.getMethod();
            if (method != null)
            { 
                return method.getAnnotation(LogAs.class);
            }
            return null;
        }
    
    
    }

完成以上的两个操作，就可以实现一个简单的日志AOP操作。简单方便，在使用的时候直接在对应的Controller方法上加上注解就可以实现对该方法的日志记录了！