logback的简单使用

时间 2019-11-09

标签 logback 简单使用繁體版

原文原文链接

1、logback的介绍

Logback是由log4j创始人设计的又一个开源日志组件，官方网站： http://logback.qos.ch。java

logback当前分红三个模块：logback-core,logback- classic和logback-access。web

logback-core：其它两个模块的基础模块。
logback-classic：log4j的一个改良版本。此外logback-classic完整实现SLF4J API使你能够很方便地更换成其它日志系统如log4j或JDK14 Logging。
logback-access访问模块与Servlet容器集成提供经过Http来访问日志的功能

2、logback取代log4j的理由

Logback和log4j是很是类似的，若是你对log4j很熟悉，那对logback很快就会驾轻就熟。下面列了logback相对于log4j的一些优势：算法

更快的实现：Logback的内核重写了，在一些关键执行路径上性能提高10倍以上。并且logback不只性能提高了，初始化内存加载也更小了。
很是充分的测试：Logback通过了几年，数不清小时的测试。Logback的测试彻底不一样级别的。
Logback-classic很是天然实现了SLF4j：Logback-classic实现了SLF4j。在使用SLF4j中，你都感受不到logback-classic。并且由于logback-classic很是天然地实现了slf4j ，所以切换到log4j或者其余，很是容易，只须要提供成另外一个jar包就OK，根本不须要去动那些经过SLF4JAPI实现的代码。
很是充分的文档官方网站有两百多页的文档。
自动从新加载配置文件，当配置文件修改了，Logback-classic能自动从新加载配置文件。扫描过程快且安全，它并不须要另外建立一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。
Lilith是log事件的观察者，和log4j的chainsaw相似。而lilith还能处理大数量的log数据。
谨慎的模式和很是友好的恢复，在谨慎模式下，多个FileAppender实例跑在多个JVM下，能够安全地写道同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括 RollingFileAppender可以很是友好地从I/O异常中恢复。
配置文件能够处理不一样的状况，开发人员常常须要判断不一样的Logback配置文件在不一样的环境下（开发，测试，生产）。而这些配置文件仅仅只有一些很小的不一样，能够经过,和来实现，这样一个配置文件就能够适应多个环境。
Filters（过滤器）有些时候，须要诊断一个问题，须要打出日志。在log4j，只有下降日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你能够继续保持那个日志级别而除掉某种特殊状况，如alice这个用户登陆，她的日志将打在DEBUG级别而其余用户能够继续打在WARN级别。要实现这个功能只需加4行XML配置。能够参考MDCFIlter 。
SiftingAppender（一个很是多功能的Appender）：它能够用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender可以区别日志事件跟进用户的Session，而后每一个用户会有一个日志文件。
自动压缩已经打出来的log：RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，因此甚至对于大的日志文件，在压缩过程当中应用不会受任何影响。
堆栈树带有包版本：Logback在打出堆栈树日志时，会带上包的数据。
自动去除旧的日志文件：经过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你能够控制已经产生日志文件的最大数量。若是设置maxHistory 12，那那些log文件超过12个月的都会被自动移除。

3、logback的配置介绍

Logger、appender及layout
　　Logger做为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也能够定义日志类型、级别。
　　Appender主要用于指定日志输出的目的地，目的地能够是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其余数据库、 JMS和远程UNIX Syslog守护进程等。
　　Layout 负责把事件转换成字符串，格式化的日志信息的输出。数据库

logger context
　　各个logger 都被关联到一个 LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各logger。其余全部logger也经过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger名称为参数。用同一名字调用LoggerFactory.getLogger 方法所获得的永远都是同一个logger对象的引用。安全

有效级别及级别的继承
　　Logger 能够被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于ch.qos.logback.classic.Level类。若是 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。服务器

打印方法与基本的选择规则
　　打印方法决定记录请求的级别。例如，若是 L 是一个 logger 实例，那么，语句 L.info("..")是一条级别为 INFO的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用，不然，称为被禁用。记录请求级别为 p，其 logger的有效级别为 q，只有则当 p>=q时，该请求才会被执行。
该规则是 logback 的核心。级别排序为： TRACE < DEBUG < INFO < WARN < ERRORapp

4、logback的默认配置

若是配置文件 logback-test.xml 和 logback.xml 都不存在，那么 logback 默认地会调用BasicConfigurator ，建立一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。webapp

Logback的配置文件
　　Logback 配置文件的语法很是灵活。正由于灵活，因此没法用 DTD 或 XML schema 进行定义。尽管如此，能够这样描述配置文件的基本结构：以<configuration>开头，后面有零个或多个<appender>元素，有零个或多个<logger>元素，有最多一个<root>元素。异步

Logback默认配置的步骤性能

尝试在 classpath下查找文件logback-test.xml；
若是文件不存在，则查找文件logback.xml；
若是两个文件都不存在，logback用BasicConfigurator自动对本身进行配置，这会致使记录输出到控制台。

5、logback.xml经常使用配置详解

1.根节点<configuration>，包含下面三个属性：

scan: 当此属性设置为true时，配置文件若是发生改变，将会被从新加载，默认值为true。

scanPeriod: 设置监测配置文件是否有修改的时间间隔，若是没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。

debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

2.子节点<contextName>：用来设置上下文名称，每一个logger都关联到logger上下文，默认上下文名称为default。但可使用<contextName>设置成其余名字，用于区分不一样应用程序的记录。一旦设置，不能修改。

3.子节点<property> ：用来定义变量值，它有两个属性name和value，经过<property>定义的值会被插入到logger上下文中，可使“${}”来使用变量。

name: 变量的名称

value: 的值时变量定义的值

4.子节点<timestamp>：获取时间戳字符串，他有两个属性key和datePattern

key: 标识此<timestamp> 的名字；

datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。

5.子节点<appender>：负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。
5.1ConsoleAppender 把日志输出到控制台，有如下子节点：

<encoder>：对日志进行格式化。（具体参数稍后讲解 ）

<target>：字符串System.out(默认)或者System.err（区别很少说了）

5.2 FileAppender：把日志添加到文件，有如下子节点：

<file>：被写入的文件名，能够是相对目录，也能够是绝对目录，若是上级目录不存在会自动建立，没有默认值。

<append>：若是是 true，日志被追加到文件结尾，若是是 false，清空现存文件，默认是true。
    
<encoder>：对记录事件进行格式化。（具体参数稍后讲解 ）
    
<prudent>：若是是 true，日志会被安全的写入文件，即便其余的FileAppender也在向此文件作写入操做，效率低，默认是 false。

5.3. RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其余文件。有如下子节点：

<file>：被写入的文件名，能够是相对目录，也能够是绝对目录，若是上级目录不存在会自动建立，没有默认值。

<append>：若是是 true，日志被追加到文件结尾，若是是 false，清空现存文件，默认是true。    

<rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最经常使用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有如下子节点：

<fileNamePattern>：必要节点，包含文件名及“%d”转换符，“%d”能够包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。若是直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点无关紧要，经过设置file，能够为活动文件和归档文件指定不一样位置，当前日志老是记录到file指定的文件（活动文件），活动文件的名字不会改变；若是没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当作目录分隔符。    

<maxHistory>:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除以前的旧文件。注意，删除旧文件是，那些为了归档而建立的目录也会被删除。class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，若是超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
<maxFileSize>:这是活动文件的大小，默认值是10MB。

<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，可是有两个限制，1不支持也不容许文件压缩，2不能设置file属性，必须留空。    
    
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有如下子节点：
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。            <fileNamePattern>:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还能够指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip

6.子节点<loger>：用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。
能够包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger

name: 用来指定受此loger约束的某一个包或者具体的某一个类。

level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，表明强制执行上级的级别。 若是未设置此属性，那么当前loger将会继承上级的级别。

addtivity: 是否向上级loger传递打印信息。默认是true。同<loger>同样，能够包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger。

7.子节点<root>:它也是<loger>元素，可是它是根loger,是全部<loger>的上级。只有一个level属性，由于name已经被命名为"root",且已是最上级了。

level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。

6、Demo

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
    scan: 当此属性设置为true时，配置文件若是发生改变，将会被从新加载，默认值为true。 
    scanPeriod: 设置监测配置文件是否有修改的时间间隔，若是没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 
    debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!-- 定义参数常量 -->
    <!-- TRACE<DEBUG<INFO<WARN<ERROR -->
    <property name="log.level" value="debug" />
    <property name="log.maxHistory" value="30" />
    <property name="log.filePath" value="${catalina.base}/logs/webapps" />
    <property name="log.pattern"
        value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n" />
    <!-- 控制台设置 -->
    <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>
    <!-- DEBUG -->
    <appender name="debugAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 文件路径：先向这个文件里面写入日志，当达到必定数量或必定时间以后分裂成下面的滚动日志来存放 -->
        <file>${log.filePath}/debug.log</file>
        <!-- 滚动策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 文件名称 -->
            <fileNamePattern>${log.filePath}/debug/debug.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
            <!-- 文件最大保存历史数量 -->
            <maxHistory>${log.maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- INFO -->
    <appender name="infoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 文件路径 -->
        <file>${log.filePath}/info.log</file>
        <!-- 滚动策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 文件名称 -->
            <fileNamePattern>${log.filePath}/info/info.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
            <!-- 文件最大保存历史数量 -->
            <maxHistory>${log.maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- ERROR -->
    <appender name="errorAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 文件路径 -->
        <file>${log.filePath}/error.log</file>
        <!-- 滚动策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 文件名称 -->
            <fileNamePattern>${log.filePath}/error/error.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
            <!-- 文件最大保存历史数量 -->
            <maxHistory>${log.maxHistory}</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- 记录“com.panjingg.o2o”下“${log.level}”以上级别的日志 -->
    <!-- additivity="true":继承父类属性，子类有的属性不会被重写 -->
    <logger name="com.panjingg.o2o" level="${log.level}" additivity="true">
        <appender-ref ref="debugAppender"/>
        <appender-ref ref="infoAppender"/>
        <appender-ref ref="errorAppender"/>
    </logger>
    <!-- 若是上面没有指定level，将继承父类的level属性 -->
    <root level="info">
        <appender-ref ref="consoleAppender"/>
    </root>
</configuration>