AOP/Filter+MDC实现traceId日志追踪

我就是我 2023-01-06 11:47 335阅读 0赞

# AOP/Filter+MDC实现traceId日志追踪 #

在应用日志查询时，我们常常希望可以有个关键字可以查询某个业务的整生命周期，log4j 和 logback提供了MDC（Mapped Diagnostic Context，映射调试上下文）功能，可以在多线程条件下记录日志。

在微服务、分布式中更是希望可以进行链路追踪。

--------------------

一、AOP+MDC简单实现

/**
     * ************************************************************
     * Copyright © 2021 cnzz Inc.All rights reserved.  *    **
     * ************************************************************
     *
     * @program: Unknown
     * @description: 业务日志追踪
     * @author: cnzz
     * @create: 2021-01-12 13:49
     **/
    @Slf4j
    @Component
    @Aspect
    public class TraceIdHandler {
        private static final String TRACE_ID = "traceId";
    
    
       /* 参数部分允许使用通配符：
                *  匹配任意字符，但只能匹配一个元素
                .. 匹配任意字符，可以匹配任意多个元素，表示类时，必须和*联合使用
                +  必须跟在类名后面，如Horseman+，表示类本身和继承或扩展指定类的所有类
      */
        @Before(value = "execution(* com.ytkj.feec..*(..))")
        public void excuteBefore() {
            if (StringUtils.isBlank(MDC.get(TRACE_ID))) {
                String traceId = UUID.randomUUID().toString().replace("-", "");
                MDC.put(TRACE_ID, traceId);
            }
        }
    }

log日志文件xml配置  输出格式Pattern      添加

%X{traceId}

<?xml version="1.0" encoding="UTF-8" ?>
    <configuration>
    
        
        <springProperty scope="context" name="logging.path" source="logging.path"/>
    
        
        <contextName>rcbcloud-settle</contextName>
        <property name="LOG_PATH" value="/data/logs/paycentre" />
        <property name="project_name" value="zuul" />
        <property name="LOG_HOME" value="${LOG_PATH}/%d{yyyyMMdd}/${project_name}/${project_name}"/>
    
        <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                
                <pattern>%yellow(%d{yyyy-MM-dd HH:mm:ss.SSS }) %magenta([%thread]) - %red([%-5level]) %cyan(%c [%L]) - %blue([%X{corrId}-%X{traceId}]) - %highlight(%msg) %n
    
                </pattern>
                <charset class="java.nio.charset.Charset">UTF-8</charset>
            </encoder>
        </appender>
    
        
        <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
    
                <level>INFO</level>
    
              
            </filter>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>
                    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
                </pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_HOME}.info.%d{yyyy-MM-dd}.log</fileNamePattern>
                
                <MaxHistory>90</MaxHistory>
                <cleanHistoryOnStart>true</cleanHistoryOnStart>
                
                <totalSizeCap>1GB</totalSizeCap>
    
            </rollingPolicy>
        </appender>
    
        <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>ERROR</level>
            </filter>
            <encoder>
                <pattern>
                    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
                </pattern>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_HOME}.error.%d{yyyy-MM-dd}.log</fileNamePattern>
                <MaxHistory>90</MaxHistory>
            </rollingPolicy>
        </appender>
        <root level="debug">
            <appender-ref ref="consoleLog"/>
            <appender-ref ref="fileInfoLog"/>
            <appender-ref ref="fileErrorLog"/>
        </root>
    </configuration>

二、使用filter+MDC实现

/**
     * ************************************************************
     * Copyright © 2020 cnzz Inc.All rights reserved.  *    **
     * ************************************************************
     *
     * @program: demo
     * @description: 重新请求对象
     * @author: cnzz
     * @create: 2020-12-17 14:03
     * <p>
     * 整理请求参数
     **/
    @Slf4j
    public class BodyRequestWrapper2 extends HttpServletRequestWrapper {
        private byte[] body;
        private static final String TRACE_ID = "traceId";
        public BodyRequestWrapper2(HttpServletRequest request){
            super(request);
    
    //        StreamUtil.readBytes(request.getReader(), "utf-8");
    //        //由于request并没有提供现成的获取json字符串的方法，所以我们需要将body中的流转为字符串
    //        String json = new String(StreamUtil.readBytes(request.getReader(), "utf-8"));
            String data = HttpUtil.getDataFromRequest2(request);
            body = data.getBytes();
    
            //1、获取请求头
            SysHeader header = getSysHeader(request, data);
    
            //2、MDC + trace_id添加
            String traceId = StringUtils.isNotBlank(header.getCorrId()) ? header.getCorrId() : UUID.randomUUID().toString().replace("-", "");
            MDC.put(TRACE_ID, traceId);
    
            //3、servletPath+userInfo+ipAddr+userAgent
            String ipAddr = IpUtils.getIpAddr(request);
            String servletPath = request.getServletPath();
            String userAgent = request.getHeader("User-Agent");
            log.info("【请求filter】servletPath={},ipAddr={},userAgent={}", servletPath, ipAddr,userAgent);
            if (!ApiRouter.isApiRouter(servletPath)) {
    
                log.info("【需要验签】{}", servletPath);
                //校验
                ValidSysReqUtil2.validSysHeader(header);
            }
    
        }
    
        @Override
        public BufferedReader getReader() throws IOException {
            return new BufferedReader(new InputStreamReader(getInputStream()));
        }
    
        /**
         * 在使用@RequestBody注解的时候，其实框架是调用了getInputStream()方法，所以我们要重写这个方法
         *
         * @return
         * @throws IOException
         */
        @Override
        public ServletInputStream getInputStream() throws IOException {
            final ByteArrayInputStream bais = new ByteArrayInputStream(body);
    
            return new ServletInputStream() {
                @Override
                public boolean isFinished() {
                    return false;
                }
    
                @Override
                public boolean isReady() {
                    return false;
                }
    
                @Override
                public void setReadListener(ReadListener readListener) {
    
                }
    
                @Override
                public int read() throws IOException {
                    return bais.read();
                }
            };
        }
    
    
        private SysHeader getSysHeader(HttpServletRequest request, String data) {
            return new SysHeader()
                    .setTimestamp(request.getHeader("timestamp"))
                    .setSign(request.getHeader("sign"))
                    .setSignType(request.getHeader("signType"))
                    .setCorrId(request.getHeader("corrId"))
                    .setData(data);
        }
    
    }

效果展示

![2021011416285142.png][]

[2021011416285142.png]: /images/20221119/7aba1a91472a440483296e090779ccb3.png