日志组件-logback入门

什么是logback?

logback是一款性能优良的日志组件，它继承自log4j日志组件，目前java的主流web开发框架springboot就是选用的logback日志组件。

logback组成

它由三个模块组成：logback-core，logback-classic，logback-access模块。

logback-core 是其它两个模块的基础。logback-classic 模块可以看作是 log4j 的一个优化版本，它天然的支持 SLF4J，所以你可以随意的从其它日志框架（例如：log4j 或者 java.util.logging）切回到 logack。

logback-access 可以与 Servlet 容器进行整合，例如：Tomcat、Jetty。它提供了 http 访问日志的功能。

logback配置介绍

这里博主列举了常用logback的xml配置，并且为了方便测试，将最大文件大小设置成了5KB，具体xml内容如下。

<?xml version="1.0" encoding="UTF-8"?>
<!--scan：当配置发生变化时，会重新加载-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!--配置变量-->
    <!--文件路径前缀-->
    <property name="LOG_HOME_PATH" value="logs"/>
	<!--日志打印格式-->
    <property name="encoder_pattern" value="%d{yyyy/MM/dd HH:mm:ss.SSS} %cyan(%-5level) [%thread] [%c{0}:%L] %magenta(%logger{36}): %msg%n"/>
    <property name="maxHistory" value="60"/>
    <property name="maxFileSize" value="5KB"/>

   <!--标准输出，输出到控制台-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
		   <!--日志打印格式-->
            <pattern>${encoder_pattern}</pattern>
            <!--<charset>UTF-8</charset>-->
        </encoder>
    </appender>
	
    <!--记录全部日志级别信息到文件-->
    <appender name="FILE_All" class="ch.qos.logback.core.rolling.RollingFileAppender">
		 <!--基于时间切分策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           <fileNamePattern>${LOG_HOME_PATH}/level_all.%d.%i.log</fileNamePattern>
			 <!--最长保留时间-->
            <maxHistory>${maxHistory}</maxHistory>
			<!--基于文件大小切分策略-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>${encoder_pattern}</pattern>
            <!--<charset>UTF-8</charset>-->
        </encoder>
    </appender>

    <!-- 控制台输出日志级别 -->
	<!--root是根loggger，默认debug级别-->
	<!--appender-ref，指定了这个logger有哪几个appender。默认debug级别-->
    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </root>
	
 <!--用来设置某一个包或者某一个类的具体日志打印级别-->
 <!--addtivity是否向上级logger传递日志信息，如a.b.c的上级logger是a.b。-->
  <logger name="org.springframework" level="ERROR" />
 
</configuration>

日志级别

<!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE  -->

过滤器

过滤器可以实现对appender的日志级别，日志内容等进行过滤。decide方法的返回值决定了该过滤器是否处理，向下传递信息的行为。

public abstract class Filter<E> extends ContextAwareBase implements LifeCycle {
    private String name;
    boolean start = false;

    public Filter() {
    }

    public void start() {
        this.start = true;
    }

    public boolean isStarted() {
        return this.start;
    }

    public void stop() {
        this.start = false;
    }

    public abstract FilterReply decide(E var1);

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

举个例子，博主使用了LevelFilter，实现error级别日志的过滤。

  <appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME_PATH}/level_error.%d.%i.log</fileNamePattern>
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>${encoder_pattern}</pattern>
            <!--<charset>UTF-8</charset>-->
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

日志切分策略

按时间切分，TimeBasedRollingPolicy

按大小和时间切分，TimeBasedRollingPolicy

使用logback

导入依赖

  <properties>
    <logback.version>1.1.7</logback.version>
</properties>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>${logback.version}</version>
</dependency>

查看日志输出

中文文档推荐

logback中文文档

博主微信公众号