logback配置与使用

logback

参考资料:https://www.jianshu.com/p/63c034dedc7b

一、logback+slf4j简单使用示例

①获取logback的jar包,最新jar包从官网https://logback.qos.ch/download.html下载,将其放在lib包目录下,并引入项目中;如果是maven项目,在pom文件中引入如下:

<dependency>      
	<groupId>ch.qos.logback</groupId>      
	<artifactId>logback-core</artifactId>      
	<version>1.1.7</version> 
</dependency> 
<dependency>      
	<groupId>ch.qos.logback</groupId>      
	<artifactId>logback-access</artifactId>   
    <version>1.1.7</version> 
</dependency> 
<dependency>      
	<groupId>ch.qos.logback</groupId>     
    <artifactId>logback-classic</artifactId>      
    <version>1.1.7</version> 
</dependency>

②获取slf4j的jar包,因为logback完整实现了slf4j的接口,所以需要依赖于slf4j实现功能。最新jar包从官网https://www.slf4j.org/download.html下载,如果是maven项目,在pom文件中引入如下:

<dependency>    
	<groupId>org.slf4j</groupId>    
	<artifactId>slf4j-api</artifactId>   
    <version>1.7.7</version> 
</dependency>

③代码编写

package SimpleTest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory; 

/** * 简单日志获取 */
public class SimpleTest {    
    public static void main(String[] args) {   
        //获取logger对象        
        Logger logger = LoggerFactory.getLogger(SimpleTest.class);   
        
        logger.info("info.....");    
        logger.debug("debug...");   
        logger.error("error...");       
        logger.warn("warn...");     
    } 
}

④执行结果

22:14:47.606 [main] INFO SimpleTest.SimpleTest - info..... 
22:14:47.611 [main] DEBUG SimpleTest.SimpleTest - debug... 
22:14:47.611 [main] ERROR SimpleTest.SimpleTest - error...
22:14:47.611 [main] WARN SimpleTest.SimpleTest - warn...

二、logback加载过程

当我们使用logback-classic.jar时,应用启动,logback会按照如下顺序进行扫描:

  • 在系统配置文件System Properties中寻找是否有logback.configurationFile对应的value
  • 在classpath下寻找是否有logback.groovy(即logback支持groovy与xml两种配置方式)
  • 在classpath下寻找是否有logback-test.xml
  • 在classpath下寻找是否有logback.xml

以上任何一项找到之后都会停止,如果全部都不满足,则默认使用ch.qos.logback.classic.BasicConfigurator的configure方法,构造一个ConsoleAppender用于向控制台输出日志,默认日志输出格式为”%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} – %msg%n”。

三、logback配置文件讲解

分析logbac配置文件节点如下:

<configuration>(总配置)
    |----------------<jmxConfigurator>(动态日志级别)
    |----------------<property>(定义变量值)
    |----------------<timestamp>(获取时间戳字符串)
    |----------------<contextName>(设置上下文名称,每个logger都关联到logger上下文,默认上下文名称为default)
    |----------------<appender>(负责写日志的组件)
            |------------------<encoder>(对日志进行格式化)
                    |----------------<pattern>(指定日志格式化格式)           
            |------------------<target>(输出为System.out或System.err)
            |------------------<file>(被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。)
            |------------------<append>(是否增加到文件末尾)
            |------------------<prudent>(如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false)
            |------------------<filter>(日志输出过滤器)
                |-----------------<level> (目标日志级别)
                |-----------------<onMatch>(符合输出条件的的日志行为)
                |-----------------<onMismatch>(不符合日志级别的日志输出行为)
            |------------------<rollingPolicy>(当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名)
                |-----------------<fileNamePattern>(被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。)
                |-----------------<maxHistory>(控制保留的归档文件的最大数量,超出数量就删除旧文件)
                |-----------------<maxFileSize>(活动文件的大小,默认值是10MB)
                |-----------------<prudent>(当为true时,不支持FixedWindowRollingPolicy)
                |-----------------<triggeringPolicy >(告知 RollingFileAppender 何时激活滚动)
                |-----------------<encorder>(对记录事件进行格式化)
    |----------------<root>(所有<loger>(的上级)
            |-------------<appender-ref>(标识这个appender将会添加到这个loger)
    |----------------<logger>(用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>)
            |-------------<appender-ref>(标识这个appender将会添加到这个loger)

1. 属性讲解

scan=“true” //当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true
scanPeriod=“60 seconds” //设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug=“false” //当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
...........
</configuration>
  1. 属性讲解
    name=“变量名” //定义变量的名称,引用处可以使用"{变量名}"引用
    value=“变量值” //定义变量的值
<configuration  scan="true" scanPeriod="60 seconds" debug="false">
     <property name="log_dir" value="./Logback-Modle/src/main/logs" />
</configuration>

3.属性及其子节点属性讲解

name=“appender名称” //定义appender的名称
class=“ch.qos.logback.core.ConsoleAppender” //logback的默认appender实现类

稍微讲解logback的集中appender类所具备的子节点及属性
①ch.qos.logback.core.ConsoleAppender 将日志输出到控制台

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
<!-- ConsoleAppender 控制台输出日志 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>
                <!-- 设置日志输出格式 -->
                %d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n
            </pattern>
        </encoder>
        <!--日志输出方式,默认为System.out-->
        <target>System.err</target>
    </appender>
</configuration>

②ch.qos.logback.core.FileAppender 将日志输出到日志文件

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
   <appender name="FILE" class="ch.qos.logback.core.FileAppender">
            <!--指定日志输出文件-->
            <file>testFile.log</file> 
            <!--指定是否追尾-->
            <append>true</append> 
             <!--指定日志输出格式-->
            <encoder> 
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>                                 
            </encoder> 
   </appender> 
</configuration>

③ch.qos.logback.core.RollingFileAppender 将日志滚动输出到日志文件中

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>${log_dir}/warn/%d{yyyy-MM-dd}/warn-log.log</fileNamePattern>
            <!--日志留存天数-->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 这是活动文件的大小,默认值是10MB -->
                <maxFileSize>1KB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>
</configuration>

④及其子节点和属性讲解

name=“com.data.test” 用来指定受此loger约束的某一个包或者具体的某一个类

level=“debug” 用来设置打印级别,大小写无关

addtivity=true 是否向上级loger传递打印信息。默认是true

子节点 指定受logger约定的appender

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
   <!--如无限定level,将自动继承父级logger,即rootLogger-->
    <logger name="java" additivity="false" />
    <logger name="java.lang" level="warn">
        <appender-ref ref="STDOUT" />
    </logger>
</configuration>

⑤ 讲解

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
   <!-- root级别 DEBUG -->
    <root>
        <!-- 打印debug级别日志及以上级别日志 -->
        <level value="debug" />
        <!--指定使用的appender-->
        <appender-ref ref="console" />
        <appender-ref ref="haha" />
        <appender-ref ref="test" />
    </root>
</configuration>

四、Filter 等级过滤器

是的一个子节点,表示在当前给到的日志级别下再进行一次过滤,最基本的Filter有ch.qos.logback.classic.filter.LevelFilter和ch.qos.logback.classic.filter.ThresholdFilter

我们看一下LevelFilter,其过滤策略是针对指定级别的日志是否显示,有三个子节点,

指定当前过滤的目标级别

指定当日志级别符合当前目标级别时的行为,有值ACCEPT接收,和DENY拒绝输出

指定当日志级别不符合当前目标级别时的行为,值同上

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器,只记录ERROR级别的日志 -->
        <!-- 如果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置过滤级别 -->
            <level>ERROR</level>
            <!-- 用于配置符合过滤条件的操作 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用于配置不符合过滤条件的操作 -->
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            .....
        </rollingPolicy>
    </appender>
</configuration>

我们再看一下 ThresholdFilter ,其过滤策略为针对指定级别以下的日志全部不显示,配置如下:

<configuration  scan="true" scanPeriod="60 seconds" debug="false">
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- 设置过滤级别 -->
            <level>ERROR</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            .....
        </rollingPolicy>
    </appender>
</configuration>

五、进阶Demo

综合案例如下:
使用网上现成可用的配置logback-test.xml如下:

<?xml version="1.0" encoding="UTF-8"?>
<!-- 级别从高到低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志输出规则 根据当前ROOT 级别,日志输出时,级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面,会出现高级别文件,依然出现低级别的日志信息,通过filter 过滤只记录本级别的日志 -->
<!-- scan 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。 -->
<!-- scanPeriod 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!-- 动态日志级别 -->
    <jmxConfigurator />
    <!-- 定义日志文件 输出位置 -->
    <property name="log_dir" value="./Logback-Modle/src/main/logs" />
    <!-- 日志最大的历史 30天 -->
    <property name="maxHistory" value="30" />

    <!-- ConsoleAppender 控制台输出日志 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>
                <!-- 设置日志输出格式 -->
                %d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n
            </pattern>
        </encoder>
        <target>System.err</target>
    </appender>

    <!-- ERROR级别日志 -->
    <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 RollingFileAppender -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器,只记录ERROR级别的日志 -->
        <!-- 如果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置过滤级别 -->
            <level>ERROR</level>
            <!-- 用于配置符合过滤条件的操作 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用于配置不符合过滤条件的操作 -->
            <onMismatch>DENY</onMismatch>
        </filter>
        <file>${log_dir}/error/error-log.log</file>
        <!-- 最常用的滚动策略,它根据时间来制定滚动策略.既负责滚动也负责出发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>
                ${log_dir}/error/error-log.%d.%i.log
            </fileNamePattern>
            <!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件假设设置每个月滚动,且<maxHistory>是6, 则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小,默认值是10MB,本篇设置为1KB,只是为了演示 -->
                <maxFileSize>1KB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>
                <!-- 设置日志输出格式 -->
                %d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n
            </pattern>
        </encoder>
    </appender>

    <!-- WARN级别日志 appender -->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器,只记录WARN级别的日志 -->
        <!-- 果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置过滤级别 -->
            <level>WARN</level>
            <!-- 用于配置符合过滤条件的操作 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用于配置不符合过滤条件的操作 -->
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>${log_dir}/warn/%d{yyyy-MM-dd}/warn-log.log</fileNamePattern>
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- INFO级别日志 appender -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log_dir}/info/%d{yyyy-MM-dd}/info-log.log</fileNamePattern>
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- DEBUG级别日志 appender -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log_dir}/debug/%d{yyyy-MM-dd}/debug-log.log</fileNamePattern>
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- TRACE级别日志 appender -->
    <appender name="TRACE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>TRACE</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log_dir}/trace/%d{yyyy-MM-dd}/trace-log.log</fileNamePattern>
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- root级别 DEBUG -->
    <root>
        <!-- 打印debug级别日志及以上级别日志 -->
        <level value="debug" />
        <!-- 控制台输出 -->
        <appender-ref ref="console" />
        <!-- 文件输出 -->
        <appender-ref ref="ERROR" />
        <appender-ref ref="INFO" />
        <appender-ref ref="WARN" />
        <appender-ref ref="DEBUG" />
        <appender-ref ref="TRACE" />
    </root>
</configuration>

程序代码:

package SimpleTest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 简单日志获取
 */
public class SimpleTest {

    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(SimpleTest.class);

        logger.info("info.....");
        logger.debug("debug...");
        logger.error("error...");
        logger.warn("warn...");
    }
}

输出结果如下:

控制台输出

2019-02-04 16:48:43.703 INFO  SimpleTest.SimpleTest - info.....
2019-02-04 16:48:43.703 DEBUG SimpleTest.SimpleTest - debug...
2019-02-04 16:48:43.703 ERROR SimpleTest.SimpleTest - error...
2019-02-04 16:48:43.703 WARN  SimpleTest.SimpleTest - warn...

日志文件输出
2019-02-04 14:39:04.496 DEBUG SimpleTest.SimpleTest - debug...

输出日志目录:

img

​ log目录结构

总结

1.logback完整实现了slf4j的接口,所以依赖于slf4j实现功能

2.logback的配置需要配置输出源appender,输出日志的logger和根logger root

3.logback通过filter实现对特定日志级别的过滤输出

参考文档

【1】logback官方文档

【2】http://www.importnew.com/28541.html

【3】https://www.cnblogs.com/warking/p/5710303.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值