logback 自定义PatternLayout

系统中，将日志分为系统日志和访问日志，由于两种内容不同，所以需要自定义一些内容，然后在logback.xml 中进行拼接即可。

需要实现的效果：

1. 继承 ch.qos.logback.classic.pattern.ClassicConverter 类，并重写convert (ILoggingEvent  event)方法

import ch.qos.logback.classic.pattern.ClassicConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;
import com.tongtech.esb.lilac.utils.LogUtil;
import org.slf4j.MDC;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.util.UUID;

/**
 * Head部分
 * @author lin
 */
public class HeadConverter extends ClassicConverter {

    /**
     * 主机标识
     */
    public String hostId=null;

    /**
     * 日志序号
     */
    public String logNum=null;

    @Override
    public String convert(ILoggingEvent iLoggingEvent) {
      
        return "Head:";//根据业务需要进行拼接
    }  

}

 

2. 继承 ch.qos.logback.classic.PatternLayout，添加标签到样式中。key代表在logback.xml 中的引用名字

import ch.qos.logback.classic.PatternLayout;

public class MyPatternLayout extends PatternLayout {
    static {
        defaultConverterMap.put("Base", BaseConverter.class.getName());
        defaultConverterMap.put("Head", HeadConverter.class.getName());
        defaultConverterMap.put("SysContent", SystemConverter.class.getName());
        defaultConverterMap.put("AccContent", AccessConverter.class.getName());
    }
}

3.在logback.xml 中引用

    <!-- 配置systemContent -->
    <conversionRule conversionWord="SysContent" converterClass="com.tongtech.esb.lilac.log.SystemConverter" />
    

<!--系统日志控制台打印-->
    <property name="CONSOLE_SYS_LOG_PATTERN"
              value="[%d]  %-5level  Line:%-3L  %SysContent %logger %n"/>

4.打印的效果如下，因为有部分没有粘贴出来。

Base:1,8,11,,497ms,, | Head:,83eadee7-d88e-4d05-b4aa-be4e15082e2f | SysContent:{status:'OK', HostName:'DESKTOP-69Q292C', Data:'start testing webservice'} 

5.使用自定义样式的logger,需要在logback.xml 中添加 <logger name="ACCESS"></logger> 标签，java代码中的loggerFactory.getLogger("logger标签的属性名")。

    private Logger loggerAcc= LoggerFactory.getLogger("ACCESS");

  <Logger name="ACCESS" additivity="false">
        <level value="debug"/>
        <appender-ref ref="ACCESS" />
        <appender-ref ref="ACC_STDOUT" />
    </Logger>

 

6.logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <contextName>RestTrans</contextName>
    <property name="LOG_PATH" value="../log" />


    <!-- 配置Base  -->
    <conversionRule conversionWord="Base" converterClass="com.tongtech.esb.lilac.log.BaseConverter" />
    <!-- 配置Head  -->
    <conversionRule conversionWord="Head" converterClass="com.tongtech.esb.lilac.log.HeadConverter" />
    <!-- 配置systemContent -->
    <conversionRule conversionWord="SysContent" converterClass="com.tongtech.esb.lilac.log.SystemConverter" />
    <!-- 配置AccessContent -->
    <conversionRule conversionWord="AccContent" converterClass="com.tongtech.esb.lilac.log.AccessConverter" />
    <!-- Console 输出格式 %boldGreen(%logger) %highlight(%-5level) -->
<!--    <property name="CONSOLE_LOG_PATTERN"-->
<!--              value="[%date{yyyy-MM-dd HH:mm:ss}] |-%-5level   %logger -  %msg%n"/>
%d{yyyy-MM-dd HH:mm:ss}  %-5level | %Base | %Head | %logger Line:%-3L - %msg%n
-->



<!--系统日志控制台打印-->
    <property name="CONSOLE_SYS_LOG_PATTERN"
              value="[%d]  %-5level  Line:%-3L  %SysContent %logger %n"/>
<!--访问日志控制台打印-->
    <property name="CONSOLE_ACC_LOG_PATTERN"
          value="[%d]  %-5level Line:%-3L  %AccContent  %n"/>


    <!--系统文件输出-->
    <property name="FILE_SYS_LOG_PATTERN"
              value="%Base | %Head | %SysContent %n"/>

    <!-- 访问输出格式 -->
    <property name="FILE_ACC_LOG_PATTERN"
              value=" %Base | %Head | %AccContent %n"/>




    <!-- Console 输出设置 -->
    <appender name="SYS_STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>
                ${CONSOLE_SYS_LOG_PATTERN}
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>
    <!-- Console 输出设置 -->
    <appender name="ACC_STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>
                ${CONSOLE_ACC_LOG_PATTERN}
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>

    <!-- SYSTEM -->
    <appender name="SYSTEM" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${LOG_PATH}/log_system.log</file>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- %i指定索引 -->
            <fileNamePattern>${LOG_PATH}/logs/log-system-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日志记录之外，还配置了日志文件不能超过200M，若超过200M，日志文件会以索引0开始，-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式记录日志 -->
        <append>true</append>
        <!-- 日志文件的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_SYS_LOG_PATTERN}</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日志文件只记录debug级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
           <!-- <onMatch>ACCEPT</onMatch>
            <onMismatch>ACCEPT</onMismatch>-->
        </filter>
    </appender>

    <!-- ACCESS -->
    <appender name="ACCESS" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${LOG_PATH}/log_access.log</file>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- %i指定索引 -->
            <fileNamePattern>${LOG_PATH}/logs/log-access-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日志记录之外，还配置了日志文件不能超过2M，若超过2M，日志文件会以索引0开始，-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式记录日志 -->
        <append>true</append>
        <!-- 日志文件的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${FILE_ACC_LOG_PATTERN}</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日志文件只记录debug级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <!-- <onMatch>ACCEPT</onMatch>
             <onMismatch>ACCEPT</onMismatch>-->
        </filter>
    </appender>

    <root level="DEBUG">
        <appender-ref ref="SYSTEM" />
        <appender-ref ref="SYS_STDOUT" />
    </root>

    <Logger name="ACCESS" additivity="false">
        <level value="debug"/>
        <appender-ref ref="ACCESS" />
        <appender-ref ref="ACC_STDOUT" />
    </Logger>
    <Logger name="io.helidon.webserver" level="debug" />
    <Logger name="io.helidon.config" level="info" />
    <Logger name="io.helidon.security" level="info" />
    <Logger name="io.helidon.common" level="debug" />
    <Logger name="io.netty" level="warn" />


</configuration>