日志框架logback学习记录

logback是什么

LogBack是一个日志框架，它是Log4j作者Ceki的又一个日志组件。LogBack是Log4j的改良版本，比Log4j拥有更多的特性，同时也带来很大性能提升。

logback 的结构

LogBack分为3个模块:

• logback-core

  logback-core提供了LogBack的核心功能，是另外两个组件的基础

• logback-classic

  logback-classic则实现了Slf4j的API，所以当想配合Slf4j使用时，则需要引入这个包。

• logback-access

  logback-access是为了集成Servlet环境而准备的，比如说 tomcat 或者 jetty，可提供HTTP-access的日志接口。

什么是Slf4j

Slf4j是The Simple Logging Facade for Java的简称，是一个简单日志门面抽象框架，它本身只提供了日志Facade API和一个简单的日志类实现，一般常配合Log4j，LogBack，java.util.logging使用。Slf4j作为应用层的Log接入时，程序可以根据实际应用场景动态调整底层的日志实现框架。使用 SLF4J ，在需要将日志框架切换为其它日志框架时，无需改动已有的代码。

logback例子

首先在maven中引入以下依赖

<dependency>    <groupId>org.slf4j</groupId>    <artifactId>slf4j-api</artifactId>    <version>1.7.7</version></dependency><dependency>    <groupId>ch.qos.logback</groupId>    <artifactId>logback-core</artifactId>    <version>1.1.7</version></dependency><dependency>    <groupId>ch.qos.logback</groupId>    <artifactId>logback-classic</artifactId>    <version>1.1.7</version></dependency>

然后在`src/main/resources/`下创建配置文件`logback.xml`

<?xml version="1.0" encoding="UTF-8"?><configuration debug="true"><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">    <!-- encoders are by default assigned the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->    <encoder>        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>    </encoder></appender><root level="debug">    <appender-ref ref="STDOUT" /></root></configuration>

package com.zhaodongxx.demo;import org.slf4j.Logger;import org.slf4j.LoggerFactory;/** * Created by zhaod on 2017/7/9 14:39 */public class LogBackSimpleTest {    public static final Logger log = LoggerFactory.getLogger(LogBackSimpleTest.class);    public static void main(String[] args) {        log.info("this is logback demo");    }}

代码运行的结果是

14:47:55.607 [main] INFO  c.zhaodongxx.demo.LogBackSimpleTest - this is logback demo

logback配置

根节点configuration有三个子节点：

• root :根logger
• logger :日志记录器，把它关联到应用对应的context上后，主要用于存放日志对象，定义日志类型，级别
• appender :指定日志输出的目的地，目的地可以是控制台，文件，或者数据库等

logger

可以设置某一个包或者具体的某一个类的日志打印级别、以及指定日志输出的目的地。logger仅有一个name属性，一个可选的level和一个可选的additivity属性。

name：用来指定受此logger约束的某一个包或者具体的某一个类。
level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特殊值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。
additivity：是否向上级logger传递打印信息。默认是true。
logger可以包含零个或多个元素，标识这个appender将会添加到这个logger

root

也是logger元素，但是它是根logger。只有一个level属性，应为已经被命名为”root”.

level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。
root可以包含零个或多个元素，标识这个appender将会添加到这个logger。

appender

appender是负责写日志的组件。appender有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。

可以实现以下的日志输出策略：

• 根据不同的包或者类，输出到不同的文件，目的地
• 根据不同的日志级别，输出到不同的文件，目的地
• 根据时间把日志记录在不同的日志文件，并可以指定删除一定时间以前的日志文件
• 根据日志文件的大小分割日志文件，并可以指定日志文件的最大数量

关于更多的配置信息大家可以参考这篇文章从零开始玩转logback和官方文档

下面是我在网上找的一篇较为全面的配置文件

"><!---scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true-scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。-           当scan为true时，此属性生效。默认的时间间隔为1分钟-debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。-- configuration 子节点为 appender、logger、root--><configuration scan="true" scanPeriod="60 second" debug="false">    <!-- 负责写日志,控制台日志 -->    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">        <!-- 一是把日志信息转换成字节数组,二是把字节数组写入到输出流 -->        <encoder>            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>            <charset>UTF-8</charset>        </encoder>    </appender>    <!-- 文件日志 -->    <appender name="DEBUG" class="ch.qos.logback.core.FileAppender">        <file>debug.log</file>        <!-- append: true,日志被追加到文件结尾; false,清空现存文件;默认是true -->        <append>true</append>        <filter class="ch.qos.logback.classic.filter.LevelFilter">            <!-- LevelFilter: 级别过滤器，根据日志级别进行过滤 -->            <level>DEBUG</level>            <onMatch>ACCEPT</onMatch>            <onMismatch>DENY</onMismatch>        </filter>        <encoder>            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>            <charset>UTF-8</charset>        </encoder>    </appender>    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">        <File>info.log</File>        <!-- ThresholdFilter:临界值过滤器，过滤掉 TRACE 和 DEBUG 级别的日志 -->        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">            <level>INFO</level>        </filter>        <encoder>            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>            <charset>UTF-8</charset>        </encoder>        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <!-- 每天生成一个日志文件，保存30天的日志文件            - 如果隔一段时间没有输出日志，前面过期的日志不会被删除，只有再重新打印日志的时候，会触发删除过期日志的操作。            -->            <fileNamePattern>info.%d{yyyy-MM-dd}.log</fileNamePattern>            <maxHistory>30</maxHistory>            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>100MB</maxFileSize>            </TimeBasedFileNamingAndTriggeringPolicy>        </rollingPolicy>    </appender >    <!--<!– 异常日志输出 –>-->    <!--<appender name="EXCEPTION" class="ch.qos.logback.core.rolling.RollingFileAppender">-->        <!--<file>exception.log</file>-->        <!--<!– 求值过滤器，评估、鉴别日志是否符合指定条件. 需要额外的两个JAR包，commons-compiler.jar和janino.jar –>-->        <!--<filter class="ch.qos.logback.core.filter.EvaluatorFilter">-->            <!--<!– 默认为 ch.qos.logback.classic.boolex.JaninoEventEvaluator –>-->            <!--<evaluator>-->                <!--<!– 过滤掉所有日志消息中不包含"Exception"字符串的日志 –>-->                <!--<expression>return message.contains("Exception");</expression>-->            <!--</evaluator>-->            <!--<OnMatch>ACCEPT</OnMatch>-->            <!--<OnMismatch>DENY</OnMismatch>-->        <!--</filter>-->        <!--<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">-->            <!--<!– 触发节点，按固定文件大小生成，超过5M，生成新的日志文件 –>-->            <!--<maxFileSize>5MB</maxFileSize>-->        <!--</triggeringPolicy>-->    <!--</appender>-->    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">        <file>error.log</file>        <encoder>            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>            <charset>UTF-8</charset>        </encoder>        <!-- 按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。        -    窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。        -    可以指定文件压缩选项        -->        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">            <fileNamePattern>error.%d{yyyy-MM}(%i).log.zip</fileNamePattern>            <minIndex>1</minIndex>            <maxIndex>3</maxIndex>            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">                <maxFileSize>100MB</maxFileSize>            </timeBasedFileNamingAndTriggeringPolicy>            <maxHistory>30</maxHistory>        </rollingPolicy>    </appender>    <!-- 异步输出 -->    <appender name ="ASYNC" class= "ch.qos.logback.classic.AsyncAppender">        <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->        <discardingThreshold >0</discardingThreshold>        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->        <queueSize>512</queueSize>        <!-- 添加附加的appender,最多只能添加一个 -->        <appender-ref ref ="ERROR"/>    </appender>    <!--    - 1.name：包名或类名，用来指定受此logger约束的某一个包或者具体的某一个类    - 2.未设置打印级别，所以继承他的上级<root>的日志级别“DEBUG”    - 3.未设置additivity，默认为true，将此logger的打印信息向上级传递；    - 4.未设置appender，此logger本身不打印任何信息，级别为“DEBUG”及大于“DEBUG”的日志信息传递给root，    -  root接到下级传递的信息，交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；    -->    <logger name="ch.qos.logback" />    <!--    - 1.将级别为“INFO”及大于“INFO”的日志信息交给此logger指定的名为“STDOUT”的appender处理，在控制台中打出日志，    -   不再向次logger的上级 <logger name="logback"/> 传递打印信息    - 2.level：设置打印级别（TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF），还有一个特殊值INHERITED或者同义词NULL，代表强制执行上级的级别。    -        如果未设置此属性，那么当前logger将会继承上级的级别。    - 3.additivity：为false，表示此logger的打印信息不再向上级传递,如果设置为true，会打印两次    - 4.appender-ref：指定了名字为"STDOUT"的appender。    -->    <logger name="com.weizhi.common.LogMain" level="INFO" additivity="false">        <appender-ref ref="STDOUT"/>        <!--<appender-ref ref="DEBUG"/>-->        <!--<appender-ref ref="EXCEPTION"/>-->        <!--<appender-ref ref="INFO"/>-->        <!--<appender-ref ref="ERROR"/>-->        <appender-ref ref="ASYNC"/>    </logger>    <!--    - 根logger    - level:设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。    -       默认是DEBUG。    -appender-ref:可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger    -->    <root level="DEBUG">        <appender-ref ref="STDOUT"/>        <!--<appender-ref ref="DEBUG"/>-->        <!--<appender-ref ref="EXCEPTION"/>-->        <!--<appender-ref ref="INFO"/>-->        <appender-ref ref="ASYNC"/>    </root></configuration>