1. Mapped Diagnostic Context (MDC)

logback的设计目前之一就是可以很好的在分布式系统中使用。在一个服务系统中,一般都会有多个线程,不同的客户端请求由不同的系统处理。MDC类似一个缓存,当收到客户端的请求时,可以将一些信息放在MDC中,在记录日志的时候可以从MDC中直接获取。

统一记录用户ID和请求ID

在游戏服务器开发中,平时打印日志的时候,都需要打印用户的ID和请求ID,这样才能方便的找到是哪个用户的操作日志。一般情况下是这样做的:

Log.system.debug("userId:{},requestId:{} xxxxxx",userId,requestId);

这种方式就需要开发得每次记录日志的时候,都需要将userId和requestId参数传进来,有时候仅仅是为了打印一条日志,就需要多这两个参数,而业务中却用不到这两个参数。
那么有没有一种方式,可以让开发者在记录日志的时候,只关心业务就可以了,而不需要再手动记录userId和requestId了呢?可以借助于MDC实现。
正常情况下,同一个用户的请求都应该在同个线程中执行,这样可以保证用户请求的顺序性执行,不会出现多线程竞争的情况。所在,在统一接收客户端请求的时候,就把userId和requestId添加到MDC之中,MDC在每一个线程中都是自己的实例,所以是线程安全的。在请求处理结束之后,再将userId和requestId从MDC中移除,防止内存泄漏。

//在接收到请求时添加到MDC
MDC.put("userId", userId);
MDC.put("requestId", String.valueOf(requestId));
//省略业务处理

//在业务处理完之后,清理
MDC.remove("userId");
MDC.remove("requestId");

在配置中添加读取 userId和requestId

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are by default assigned the messageType ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%file:%line] : %X{userId} %X{requestId} %msg%n</pattern>
        </encoder>
    </appender>

这样在日志输出的时候,就会自动从MDC中获取userId和requestId,而开发者在记录日志的时候,就不需要再添加userId和requestId参数了,在输入到日志文件时,会自动添加userId和requestId的值。