问题定位切面和日志上打印请求唯一log标识

Love The Way You Lie 2022-12-24 00:45 104阅读 0赞

# 前言 #

这篇博客主要是针对我们前期部分接口不稳定和有部分接口需要大量业务沟通接口，针对请求参数和返回参数进行打印。部分接口调用逻辑链过长，不易分析添加同一个请求的参数添加唯一标识，防止并发比较大情况，找不到同一请求接口的上下文信息。

# 日志打印 #

1、构建一个注解用于放置在需要打印接口上面

@Documented
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    public @interface LogAnnotation { 
        boolean printParam() default true;
    }

2、设置针对打印注解的controller类进行切面

@Component
    @Aspect
    @Log4j2
    public class RequestLogAspect { 
    
        @Pointcut(value = "execution(* com.yin.databaseproject.controller..*(..)) && @annotation(logAnnotation)")
        public void request(LogAnnotation logAnnotation) { 
    
        }
    
        @Around("request(logAnnotation)")
        public Object doAround(ProceedingJoinPoint proceedingJoinPoint,LogAnnotation logAnnotation) throws Throwable { 
            long start = System.currentTimeMillis();
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            Object result = proceedingJoinPoint.proceed();
    
            RequestInfo requestInfo = new RequestInfo();
            requestInfo.setIp(IpUtil.getClientIp(request));
            requestInfo.setUrl(request.getRequestURL().toString());
            requestInfo.setHttpMethod(request.getMethod());
            requestInfo.setClassMethod(String.format("%s.%s", proceedingJoinPoint.getSignature().getDeclaringTypeName()
                    , proceedingJoinPoint.getSignature().getName()));
            requestInfo.setRequestParams(getRequestParamsByProceedingJoinPoint(proceedingJoinPoint));
            requestInfo.setResult(result);
            requestInfo.setTimeCost(System.currentTimeMillis() - start);
            String paramResult = JSON.toJSONString(requestInfo);
            log.info("request info is {}",paramResult);
    
            return result;
    
        }
    
        @AfterThrowing(pointcut = "request(logAnnotation)", throwing = "e")
        public void doAfterThrow(JoinPoint joinPoint,LogAnnotation logAnnotation, RuntimeException e) { 
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            RequestErrorInfo requestErrorInfo = new RequestErrorInfo();
            requestErrorInfo.setIp(request.getRemoteAddr());
            requestErrorInfo.setUrl(request.getRequestURL().toString());
            requestErrorInfo.setHttpMethod(request.getMethod());
            requestErrorInfo.setClassMethod(String.format("%s.%s", joinPoint.getSignature().getDeclaringTypeName(),
                    joinPoint.getSignature().getName()));
            requestErrorInfo.setRequestParams(getRequestParamsByJoinPoint(joinPoint));
            requestErrorInfo.setException(e);
            log.info("Error Request Info : {}", JSON.toJSONString(requestErrorInfo));
        }
    
    
             /*获取入参
         *
        @param
        proceedingJoinPoint
         *
         *@return
         **/
    
        private Map<String, Object> getRequestParamsByProceedingJoinPoint(ProceedingJoinPoint proceedingJoinPoint) { 
            //参数名
            String[] paramNames = ((MethodSignature) proceedingJoinPoint.getSignature()).getParameterNames();
            //参数值
            Object[] paramValues = proceedingJoinPoint.getArgs();
    
            return buildRequestParam(paramNames, paramValues);
        }
    
        private Map<String, Object> getRequestParamsByJoinPoint(JoinPoint joinPoint) { 
            //参数名
            String[] paramNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
            //参数值
            Object[] paramValues = joinPoint.getArgs();
    
            return buildRequestParam(paramNames, paramValues);
        }
    
        private Map<String, Object> buildRequestParam(String[] paramNames, Object[] paramValues) { 
            Map<String, Object> requestParams = new HashMap<>();
            for (int i = 0; i < paramNames.length; i++) { 
                Object value = paramValues[i];
    
                //如果是文件对象
                if (value instanceof MultipartFile) { 
                    MultipartFile file = (MultipartFile) value;
                    //获取文件名
                    value = file.getOriginalFilename();
                }
                requestParams.put(paramNames[i], value);
            }
    
            return requestParams;
        }
    }

4、构建需要打印出来参数说明

@Data
    public class RequestErrorInfo { 
        private String ip;
        private String url;
        private String httpMethod;
        private String classMethod;
        private Object requestParams;
        private RuntimeException exception;
    }
    
    
    @Data
    public class RequestInfo { 
        private String ip;
        private String url;
        private String httpMethod;
        private String classMethod;
        private Object requestParams;
        private Object result;
        private Long timeCost;
    }

# 同一请求设置唯一标识 #

1、构建拦截器，设置id

@Log4j2
    public class LogInterceptor implements HandlerInterceptor { 
        private final static String TRACE_ID = "traceId";
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
            String traceId = UUID.randomUUID().toString().replace("-", "");
            ThreadContext.put(TRACE_ID, traceId);
            log.info("-------------start---------"+traceId);
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { 
    
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { 
            log.info("-------------end---------");
            ThreadContext.remove(TRACE_ID);
        }
    }

2、将拦截器放置到每一个请求进行请求

@Configuration
    public class AdminCommonConfig implements WebMvcConfigurer { 
    
        /**
         * 自定义拦截器地址
         * @return 构建日志拦截器
         */
        @Bean
        public HandlerInterceptor logInterceptor(){ 
            return new LogInterceptor();
        }
        @Override
        public void addInterceptors(InterceptorRegistry registry) { 
            registry.addInterceptor(logInterceptor());
        }
    
    }

3、修改log4j2.xml文件  
在打印格式中添加\[\{TRACEID:%X\{traceId\}\}\]  
![在这里插入图片描述][20201125234846784.png_pic_center]

4、查看打印结果  
![在这里插入图片描述][2020112523495521.png_pic_center]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70_pic_center]

[20201125234846784.png_pic_center]: /images/20221120/7bfb06ebd25a4e74aeaa281a65705f4c.png
[2020112523495521.png_pic_center]: /images/20221120/55b6192ddf444323ab5e92480be12094.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZhamluZ19mZWl5dWU_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/42ddcd4bdb244fb686d159c4db9c1455.png