場景
一般情況下，日志打印的內容都是根據配置文件中配置的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