Logback自定义Pattern参数解析

需求

要在打印的日志中都带上登录的用户名。

• 最笨的办法：每一次日志打印的时候，手动添加上用户名
• 可行的办法：拦截请求，把用户名写入到MDC，然后在Pattern中通过%X{username}进行打印
• 装X的办法：拦截请求，把用户名写入到ThreadLocal，然后在Pattern中通过%u这中自定义的Pattern进行打印

自定义Pattern

append的配置

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="com.example.demo.log.UserLogbackLayout">
                <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-10u] [%thread] %-5level %logger{36} -%msg%n</Pattern>
            </layout>
        </encoder>
    </appender>

注意Pattern里面的[%-10u], 我们就是想使用%u来输出用户名

UserLogbackLayout

public class UserLogbackLayout extends PatternLayout {
    
	// 啥也没干，就是注册了一个对参数u进行解析的converter
    static {
    
        DEFAULT_CONVERTER_MAP.put("u", LogbackUserPatternConverter.class.getName());
    }
}

LogbackUserPatternConverter

public class LogbackUserPatternConverter extends ClassicConverter {
    

    @Override
    public String convert(ILoggingEvent iLoggingEvent) {
    
    	// 啥也没干，只是从ThreadLocal中去取用户
        return UserHolder.get();
    }
}

测试一下

so easy！