logback介绍

转自https://www.cnblogs.com/yangyongjie/p/11146921.html　

一、介绍

Logback，一个“可靠、通用、快速而又灵活的Java日志框架”

分为以下几个模块：

　　logback-classic：log4j的一个改良版本，同时它完整提供了slf4j API是我们可以很方便地更换成其他日志系统如log4j

　　logback-access：访问模块与Servlet容器集成提供通过HTTP来访问日志的功能

　　logback-core：其他两个模块的基础模块

二、取代log4j的理由

　　1、更快的实现：重写了内核，在一些关键执行路径上性能提升了10倍以上，而且logback不仅性能提升了，初始化内存加载也更小了

　　2、非常充分的测试

　　3、Logback-classic非常自然实现了SLF4j：Logback-classic实现了SLF4j。在使用SLF4j中，你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了slf4j ，

　　　　所以切换到log4j或者其他，非常容易，只需要提供成另一个jar包就OK，根本不需要去动那些通过SLF4JAPI实现的代码。

　　4、非常充分的文档，官网有两百多页的文档，官网地址：https://logback.qos.ch/index.html

　　5、自动重新加载配置文件，当配置文件修改了，Logback-classic能自动重新加载配置文件。扫描过程快且安全，它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能跑得很欢

　　　　在JEE环境里面。
　　6、Lilith是log事件的观察者，和log4j的chainsaw类似。而lilith还能处理大数量的log数据 。
　　7、谨慎的模式和非常友好的恢复，在谨慎模式下，多个FileAppender实例跑在多个JVM下，能 够安全地写道同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它

　　　　的子类包括 RollingFileAppender能够非常友好地从I/O异常中恢复。
　　8、配置文件可以处理不同的情况，开发人员经常需要判断不同的Logback配置文件在不同的环境下（开发，测试，生产）。而这些配置文件仅仅只有一些很小的不同，可以通过,和来实现，这

　　　　样一个配置文件就可以适应多个环境。
　　9、Filters（过滤器）有些时候，需要诊断一个问题，需要打出日志。在log4j，只有降低日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你可以继续 保持那个日志级别

　　　　而除掉某种特殊情况，如alice这个用户登录，她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需加4行XML配置。可以参考MDCFIlter 。
　　10、SiftingAppender（一个非常多功能的Appender）：它可以用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender能够区别日志事件跟进用户的Session，然后每个用户会

　　　　有一个日志文件。
　　11、自动压缩已经打出来的log：RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，所以甚至对于大的日志文件，在压缩过程中应用不会受任

　　　　何影响。
　　12、堆栈树带有包版本：Logback在打出堆栈树日志时，会带上包的数据。
　　13、自动去除旧的日志文件：通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12，那那些

　　　　log文件超过12个月的都会被自动移除。

三、Logback的结构

　　Logback建立在三个类之上：Logger，Appender和Layouts。这三个类型的组件一起工作使开发人员能够根据消息类型和级别记录消息，并在运行时控制如何格式化这些消息以及在何处打印这些消息。

　　Logger context：指定了日志输出的上下文

　　Appender（附加目的地）：Logback允许将日志输出到多个目的地，一个输出目的地对应一个Appender。目前Appeners有，console、file、remote socket servers、to MySQL、PostgreSQL 还有其他的数据库、JMS、remote UNIX Syslog daemons。

　　　　一个Logger可以输出到一个或多个appender。

　　　　默认情况下，日志输出Appender会继承，如所有的Logger都会输出到root指定的Appender，子包会输出到其父包的Appender。所以想要避免重复输出，需要指定additivity属性为false。

　　　　如果想根据日志级别筛选appender，那就使用filter，常用的filter有只输出某个级别的和输出定义级别及以上级别的过滤器：

<filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>INFO</level>// 只输出INFO级别的日志
      <onMatch>ACCEPT</onMatch> // 匹配就接受
      <onMismatch>DENY</onMismatch> // 不匹配就拒绝
    </filter>

 <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>INFO</level> // 接受所有INFO及以上级别的日志，WARN、ERROR
    </filter>　　　

　　　　

最后：实践

pom配置：

slf4j：

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

 <!--logback-->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-access</artifactId>
            <version>1.0.0</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.1.11</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.1.11</version>
        </dependency>

在工程src目录下建立logback.xml

注：

　　1.logback首先会试着查找logback.groovy文件;

　　2.当没有找到时，继续试着查找logback-test.xml文件;

　　3.当没有找到时，继续试着查找logback.xml文件;

　　4.如果仍然没有找到，则使用默认配置（打印到控制台）。

logback.xml配置介绍

　　appender：主要用于指定日志的输出目的地，目的地可以是控制台、文件、远程套接字服务器、MySQL等

　　logger：用来设置某一个包或具体的某一个类的日志打印级别，以及指定<appender>，<logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性，可以包含零个或

　　　　多个<appender-ref>元素，标识这个appender将会添加这个logger

　　root：也是logger元素，是所有logger的上级，只有一个level属性

pattern：

<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}|%thread|%-5level|%X{threadId}|%r|%C|%msg%n</pattern>

%表示日期

| 表示分隔符，可以自己指定其他分隔符

%t/thread表示线程名

%-5level：表示显示日志的级别，从左显示5个字符宽度

%X{threadId}：threadId是自己定义的线程号，在代码中使用MDC.put()开始，MDC.remove()结束

 MDC.put("threadId", UUID.randomUUID().toString().replaceAll("-", ""));
 ...
 MDC.remove("threadId");

%r/relative：输出应用程序启动到创建日志事件所花费的毫秒数

%C/class：表示输出日志所在类的全路径

%msg/m/message：表示日志信息

%n：换行符

%L/line：输出发起日志请求所在的行号

%M/method：输出发起日志请求的方法名

 一个简单的配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="/logback/LogFile"/>
    <!--控制台输出-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS}|%thread|%-5level|%r|%X{threadId}|%C|%msg%n</pattern>
        </encoder>
    </appender>
    <!--<logger name=""-->
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

 项目中稍复杂的配置

<?xml version="1.0" encoding="UTF-8"?>
<!--默认每隔一分钟扫描此配置文件的修改并重新加载-->
<configuration>
    <!--定义日志文件的存储地址 勿在LogBack的配置中使用相对路径-->
    <property name="LOG_HOME" value="xxx/logs"/>
    <!--控制台输出-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders are assigned the type
        ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
        <encoder>
            <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS}|%t|%highlight(%-5level)|%green(%X{threadId})|%cyan(%C{0}#%M:%L)|%msg%n</pattern>
        </encoder>
    </appender>
    <!--输出日志到文件中-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_HOME}/info.log</file>
        <!--不输出ERROR级别的日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch>
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <!--根据日期滚动输出日志策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/info.log.%d{yyyy-MM-dd}</fileNamePattern>
            <!--日志保留天数-->
            <maxHistory>360</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS}|%t|%-5level|%X{threadId}|%C{0}#%M:%L|%msg%n</pattern>
        </encoder>
    </appender>
    <!--错误日志输出文件-->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_HOME}/error.log</file>
        <!--只输出ERROR级别的日志-->
        <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">
            <fileNamePattern>${LOG_HOME}/error.log.%d{yyyy-MM-dd}</fileNamePattern>
            <!--日志保留天数-->
            <maxHistory>360</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS}|%t|%-5level|%X{threadId}|%C{0}#%M:%L|%msg%n</pattern>
        </encoder>
    </appender>
    <!--异步打印日志,任务放在阻塞队列中，如果队列达到80%，将会丢弃TRACE,DEBUG,INFO级别的日志任务，对性能要求不是太高的话不用启用-->
    <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <queueSize>1000</queueSize>
        <!--设为0表示队列达到80%，也不丢弃任务-->
        <discardingThreshold>0</discardingThreshold>
        <!--日志上下文关闭后，AsyncAppender继续执行写任务的时间，单位毫秒-->
        <maxFlushTime>1000</maxFlushTime>
        <!--队列满了直接丢弃要写的消息-->
        <neverBlock>true</neverBlock>
        <!--是否包含调用方的信息，false则无法打印类名方法名行号等-->
        <includeCallerData>true</includeCallerData>
        <!--One and only one appender may be attached to AsyncAppender，添加多个的话后面的会被忽略-->
        <appender-ref ref="FILE"/>
    </appender>
    <appender name="ERROR_ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <queueSize>256</queueSize>
        <!--设为0表示队列达到80%，也不丢弃任务-->
        <discardingThreshold>0</discardingThreshold>
        <!--日志上下文关闭后，AsyncAppender继续执行写任务的时间，单位毫秒-->
        <maxFlushTime>1000</maxFlushTime>
        <!--队列满了直接丢弃要写的消息，不阻塞写入队列-->
        <neverBlock>true</neverBlock>
        <!--是否包含调用方的信息，false则无法打印类名方法名行号等-->
        <includeCallerData>true</includeCallerData>
        <!--One and only one appender may be attached to AsyncAppender，添加多个的话后面的会被忽略-->
        <appender-ref ref="ERROR_FILE"/>
    </appender>

    <!--指定一些依赖包的日志输出级别,所有的logger会继承root，为了避免日志重复打印，需指定additivity="false",将不会继承root的append-ref-->
<!--    <logger name="com.xxx" level="ERROR" additivity="false">
        <appender-ref ref="STDOUT"/>
        &lt;!&ndash;<appender-ref ref="ERROR_FILE"/>&ndash;&gt;
    </logger>-->

    <root level="INFO">
        <!--<appender-ref ref="STDOUT"/>-->
        <appender-ref ref="FILE"/>
        <appender-ref ref="ERROR_FILE"/>
        <!--使用异步打印日志-->
        <!--<appender-ref ref="ASYNC"/>-->
        <!--<appender-ref ref="ERROR_ASYNC"/>-->
    </root>
</configuration>