Logback自定义日志输出内容

场景

一般情况下，日志打印的内容都是根据配置文件中配置的pattern格式指定好的。在我们调用logger.info(), logger.debug()等日志打印方法时，打印的内容格式与配置文件中的pattern格式一致。

例如，在logback.xml配置文件中指定了日志打印格式：

%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}-%L] %msg%n"。

这些格式的意义在官网的文档上都有说明。其中%msg就是我们调用日志打印方法时输入的内容。

当官方指定的这些格式不能满足我们的需求，或者是我们需要在打印日志的时候，需要加上一些比较有规律的内容，例如打印本机的hostname/ip等logback本身没有提供的格式的时候，我们就可以自定义日志输出的内容与格式。

一、实现自定义Converter

import java.io.PrintWriter;
import java.io.StringWriter;

import com.alibaba.dubbo.rpc.RpcContext;
import com.alibaba.fastjson.JSONObject;

import ch.qos.logback.classic.pattern.MessageConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;

public class LogMessageConverter extends MessageConverter{
    @Override
    public String convert(ILoggingEvent event){
    //可以在里面增加其他处理，此处return的字符串就是日志输出的最终内容
        return super.convert(event);
    }
|

创建一个类LogMessageConverter继承MessageConverter，MessageConverter中就只有一个方法convert，代码如下：

package ch.qos.logback.classic.pattern;

import ch.qos.logback.classic.spi.ILoggingEvent;

/**
 * Return the event's formatted message.
 *
 * @author Ceki Gülcü
 */
public class MessageConverter extends ClassicConverter {
    public String convert(ILoggingEvent event) {
        return event.getFormattedMessage();
    }
}

这个类的作用在它的注释中解释了：返回格式化之后的message。它继承ClassicConverter，而ClassicConverter是所有Converter的父类。因此，如果我们需要在原有日志打印内容的基础上加上一些内容，就可以在自定义Converter中的convert中实现自己的逻辑处理即可。

二、修改配置文件

完成了自定义的Converter之后，就是将这个Converter配置到配置文件中。在logback配置文件中的根节点<configuration>下增加节点<conversionRule>，例如：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<conversionRule conversionWord="msg" converterClass="com.xxx.xxx.log.LogMessageConverter" />
        //....
</configuration>

在<conversionRule>节点中的conversionWord="msg"属性，就是表示在pattern中指定%msg时，调用的就是converterClass属性中指定的Converter