SpringBoot项目优雅日志打印请求参数及返回参数

小咪咪 2023-07-18 02:30 7阅读 0赞

SpringBoot项目优雅日志打印请求参数及返回参数:

需求:1:请求参数及响应内容日志打印交给切面进行管理,避免手动创建log对象进行日志记录打印  
        2:基于注解的Controller的Method,添加注解进行打印,不添加注解不打印日志,便于根据实际情况日志的输出.

步骤:

添加依赖:

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.41</version>
    </dependency>

创建自定义注解:

import java.lang.annotation.*;
    
    @Retention(RetentionPolicy.RUNTIME)//注解不仅被保存到class文件中，jvm加载class文件之后，仍存在
    @Target(ElementType.METHOD) //注解添加的位置
    @Documented
    public @interface LogPrint {
         String description() default "";
    
    }

写一个切面类进行日志输出管理:

package com.group.**.config.aspect;
    
    import com.alibaba.fastjson.JSONObject;
    import com.techsun.industry.config.annotation.LogPrint;
    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 org.springframework.web.multipart.MultipartFile;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.lang.reflect.Method;
    
    @Aspect
    @Component
    @Profile({"dev","test"}) //一般生产环境不允许日志打印参数
    @Slf4j
    public class LogPrintAspect {
        /** 换行符 */
        private static final String LINE_SEPARATOR = System.lineSeparator();
    
        /** 以自定义 @LogPrint 注解为切点 */
        @Pointcut("@annotation(com.*.*.config.annotation.LogPrint)")
        public void logPrint() {}
    
        /**
         * 在切点之前织入
         * @param joinPoint
         * @throws Throwable
         */
        @Before("logPrint()")
        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   : {}", getParams(joinPoint));
        }
    
        /**
         * 在切点之后织入
         * @throws Throwable
         */
        @After("logPrint()")
        public void doAfter() throws Throwable {
            // 接口结束后换行，方便分割查看
            log.info("=========================================== End ===========================================" + LINE_SEPARATOR);
        }
    
        /**
         * 环绕
         * @param proceedingJoinPoint
         * @return
         * @throws Throwable
         */
        @Around("logPrint()")
        public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
            long startTime = System.currentTimeMillis();
            Object result = proceedingJoinPoint.proceed();
            // 打印出参
            log.info("Response Args  : {}",  JSONObject.toJSONString(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(LogPrint.class).description());
                        break;
                    }
                }
            }
            return description.toString();
        }
    
        private String getParams(JoinPoint joinPoint) {
            String params = "";
            if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
                for (int i = 0; i < joinPoint.getArgs().length; i++) {
                    Object arg = joinPoint.getArgs()[i];
                    if ((arg instanceof HttpServletResponse) || (arg instanceof HttpServletRequest)
                            || (arg instanceof MultipartFile) || (arg instanceof MultipartFile[])) {
                        continue;
                    }
                    try {
                        params +=JSONObject.toJSONString(joinPoint.getArgs()[i]);
                    } catch (Exception e1) {
                        log.error(e1.getMessage());
                    }
                }
            }
            return params;
        }
    
    }

现在看看效果吧:

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0h1SGFvX0NTRE4_size_16_color_FFFFFF_t_70][]

完!!!

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0h1SGFvX0NTRE4_size_16_color_FFFFFF_t_70]: /images/20230528/92a90a572bd5429b8155bc58792112b5.png