为方便项目日志查询,可在日志配置文件中加入自定义标识,在日志头添加uuid,以达到为同一次接口请求标识添加唯一标识的目的。

下面介绍一种简单的方式:
1、通过查看slf4j源码注释,org.slf4j包中MDC类为log4j和logback提供了MDC【MDC ( Mapped Diagnostic Contexts ),它是一个线程安全的存放诊断日志的容器。)】功能,MDC类中静态方法put(String key, String val)可将自定义标识key放入MDCAdapter中,最后通过反射机制将key与xml配置中的标识key对应上,将key标识的value添加进日志内容。

2、logback-spring.xml配置文件中添加自定义标识。将[%X{trace_uuid}]加入配置中。

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!-- 控制台输出日志 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%X{trace_uuid}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%c] %L - %msg%n</pattern>
        </encoder>
    </appender>
    <!--每天生成一个日志文件,保存30天的日志文件。-->
    <appender name="DayFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>logs/log.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/log.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>[%X{trace_uuid}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%level] [%thread] [%c] %L - %msg%n</pattern>
        </encoder>
    </appender>
    <!--指定logger name为包名或类全名 指定级别 additivity设置是否传递到root logger -->
    <logger name="slf4j" level="INFO" additivity="false">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DayFile"/>
    </logger>
    <!--slf4j2包下的类在ERROR级别时候传递到root logger中-->
    <logger name="slf4j2" level="ERROR"/>
    <!--根logger控制-->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="DayFile"/>
    </root>
</configuration>

3、根据项目实际情况而定,找到项目接口请求入口,可以是拦截器、Controller层的AOP、token验证等位置,添加以下一行代码即可:

MDC.put("trace_uuid", UUID.randomUUID().toString());

4、以下为简单演示:

@GetMapping(path = "testLog")
public String testLog(@RequestParam String traceId) {
    MDC.put("trace_uuid", traceId);
    log.info("invoking this api==> {}", traceId);
    return traceId;
}

请求接口,控制台打印:

[abcd1234554321] 2019-08-21 14:06:56.656 [INFO] [http-nio-8383-exec-4] [com.TestController] 66 - invoking this api==> abcd1234554321
Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐