AOP实现web日志处理

ゝ一纸荒年。 2023-07-06 13:19 59阅读 0赞

### 文章目录 ###

在项目pom.xml中添加依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.8.5</version>
    </dependency>

编写WebLog注解类：

package com.lixiang.hitravel.util;
    
    import java.lang.annotation.*;
    
    // 什么时候使用该注解，我们定义为运行时
    @Retention(RetentionPolicy.RUNTIME)
    // 注解用于什么地方，我们定义为作用与方法上
    @Target({ ElementType.METHOD})
    // 注解是否将包含在JavaDoc中
    @Documented
    // 注解名为WebLog
    public @interface WebLog { 
        /** * 日志描述信息 * * @return */
        String description() default "";
    
    }

编写切面类WebLogAspect：

package com.lixiang.hitravel.util;
    
    import com.google.gson.Gson;
    import lombok.extern.slf4j.Slf4j;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.*;
    import org.springframework.context.annotation.Profile;
    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
    //@Profile({"dev", "test"})
    @Slf4j
    public class WebLogAspect { 
    
        /** * 换行符 */
        private static final String LINE_SEPARATOR = System.lineSeparator();
    
        /** * 以自定义 @WebLog 注解为切点 */
        @Pointcut("@annotation(com.lixiang.hitravel.util.WebLog)")
        public void webLog() { 
        }
    
        /** * 在切点之前织入 * * @param joinPoint * @throws Throwable */
        @Before("webLog()")
        public void doBefore(JoinPoint joinPoint) throws Throwable { 
            // 开始打印请求日志
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
    
            // 获取 @WebLog 注解的描述信息
            String methodDescription = getAspectLogDescription(joinPoint);
    
            // 打印请求相关参数
            log.info("========================================== Start ==========================================");
            // 打印请求 url
            log.info("URL : {}", request.getRequestURL().toString());
            // 打印描述信息
            log.info("Description : {}", methodDescription);
            // 打印 Http method
            log.info("HTTP Method : {}", request.getMethod());
            // 打印调用 controller 的全路径以及执行方法
            log.info("Class Method : {}.{}", joinPoint.getSignature().getDeclaringTypeName(),
                    joinPoint.getSignature().getName());
            // 打印请求的 IP
            log.info("IP : {}", request.getRemoteAddr());
            // 打印请求入参
            log.info("Request Args : {}", new Gson().toJson(joinPoint.getArgs()));
        }
    
        /** * 在切点之后织入 * * @throws Throwable */
        @After("webLog()")
        public void doAfter() throws Throwable { 
            // 接口结束后换行，方便分割查看
            log.info("=========================================== End ===========================================" + LINE_SEPARATOR);
        }
    
        /** * 环绕 * * @param proceedingJoinPoint * @return * @throws Throwable */
        @Around("webLog()")
        public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { 
            long startTime = System.currentTimeMillis();
            Object result = proceedingJoinPoint.proceed();
            // 打印出参
            log.info("Response Args : {}", new Gson().toJson(result));
            // 执行耗时
            log.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
            return result;
        }
    
    
        /** * 获取切面注解的描述 * * @param joinPoint 切点 * @return 描述信息 * @throws Exception */
        public String getAspectLogDescription(JoinPoint joinPoint)
                throws Exception { 
            String targetName = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            Object[] arguments = joinPoint.getArgs();
            Class targetClass = Class.forName(targetName);
            Method[] methods = targetClass.getMethods();
            StringBuilder description = new StringBuilder("");
            for (Method method : methods) { 
                if (method.getName().equals(methodName)) { 
                    Class[] clazzs = method.getParameterTypes();
                    if (clazzs.length == arguments.length) { 
                        description.append(method.getAnnotation(WebLog.class).description());
                        break;
                    }
                }
            }
            return description.toString();
        }
    
    }

在目标方法上加上WebLog注解，并请求，可以发现相关日志已打印。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200219121143367.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0MDk1MDU1,size_16,color_FFFFFF,t_70