zoukankan      html  css  js  c++  java
  • Logback 学习笔记

    来源:http://webinglin.github.io/2015/06/04/Logback-%E5%AD%A6%E4%B9%A0%E7%AC%94%E8%AE%B0/

    Logback背景

    Logback是一个开源的日志组件,是log4j的作者开发的用来替代log4j的。

    logback由三个部分组成,logback-core, logback-classic, logback-access。其中logback-core是其他两个模块的基础。

    slf4j 定义日志接口及基本实现,而具体的实现由其他日志组件提供

    1. log4j
    2. commons-logging
    3. logback

    因此,如果想替换成其他的日志组件,只需要替换jar包即可。

    logback中三个重要概念: Logger,Appender,Layout

    Logger: 日志记录器,把它关联到应用对应的context上后,主要用于存放日志对象,定义日志类型,级别。

    Appender: 指定日志输出的目的地,目的地可以是控制台,文件,或者数据库等

    Layout: 负责把事件转换成字符串,格式化日志信息的输出

    寻找logback.xml

    1. logback首先在classpath寻找logback.groovy文件,
    2. 如果没找到,继续寻找logback-test.xml文件
    3. 如果没找到,继续寻找logback.xml文件
    4. 如果仍然没找到,则使用默认配置(打印到控制台)

    为什么使用Logback

    为什么要使用logback引用博客园的一段话,如下

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

    2、非常充分的测试 Logback经过了几年,数不清小时的测试。Logback的测试完全不同级别的。在作者的观点,这是简单重要的原因选择logback而不是log4j。

    3、Logback-classic非常自然实现了SLF4j Logback-classic实现了 SLF4j。在使用SLF4j中,你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了SLF4J, 所 以切换到log4j或者其他,非常容易,只需要提供成另一个jar包就OK,根本不需要去动那些通过SLF4JAPI实现的代码。

    4、非常充分的文档 官方网站有两百多页的文档。

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

    6、Lilith 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比log4j太优秀了,让我们的应用全部建立logback上吧 !

    Logback配置文件及实例解读

    这个logback的实例会这样展开:

    • 项目结构
    • 项目中使用到的类和配置文件
    • 根据源码对logback.xml这个配置文件进行解释

    其中Test.java
    package com.piedra.logback;

    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class Test {
        private final static Logger logger = LoggerFactory.getLogger(Test.class);
    
        public static void main(String[] args) {
            logger.info("logback {}","INFO ( TRACE < DEBUG < INFO < WARN < ERROR )");
            logger.error("logback {}","ERROR ( TRACE < DEBUG < INFO < WARN < ERROR )");
        }
    }
    

    logback.xml:

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration debug="false">
        <contextName>Logback Demo</contextName>
    
        <property name="LOG_HOME" value="logs" />  
    
        <!-- 控制台输出 -->
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <!-- encoder默认配置为PartternLayoutEncoder    -->
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
        </appender>
    
        <appender name="FILE" class="ch.qos.logback.core.FileAppender">
            <file>${LOG_HOME}/myLog.log</file>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
        </appender>
    
        <!-- 按照每天生成日志文件 -->
        <appender name="ROLLINGFILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!--日志文件输出的文件名-->
                <FileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}.log</FileNamePattern>
                <!--日志文件保留天数-->
                <MaxHistory>30</MaxHistory>
            </rollingPolicy>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </encoder>
            <!--日志文件最大的大小-->
           <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
             <MaxFileSize>10MB</MaxFileSize>
           </triggeringPolicy>
        </appender>
    
        <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" additivity="false" /> 
        <logger name="com.piedra.logback" level="WARN">
            <appender-ref ref="FILE"/>
        </logger>
    
        <root level="ERROR">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="ROLLINGFILE" />
        </root>
    </configuration>
    

    build.gradle

    apply plugin:"java"
    apply plugin:"eclipse"
    
    repositories{
        mavenCentral()
    }
    
    dependencies{
        compile "ch.qos.logback:logback-classic:1.1.2"
    }
    

    至此,已经将项目的源码和目录结构都截图说明了,接下来根据Test.java来对logback.xml文件进行解释说明。

    configuration: 为logback.xml配置文件的根节点,具有属性 scan,scanPeriod,debug
    scan:    当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
    scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
    debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false
    
    • contextName 表示工程的名称,唯一值

    • property 节点用来定义变量值,具有两个属性,name和value,后续的配置中可以通过 ${var} 来引用在property中定义的变量

    • appender 是的子节点,负责写日志的组件,具备如下属性:

      name: appender的名称
      class: appender全限定名
      

    具体的Appender分类

    • ConsoleAppender 子节点:

      encoder: 对日志进行格式化
      target: System.out 或者 System.err默认为System.out
      
    • FileAppender 将日志文件写到文件中

      file: 被写入的文件名,相对目录或者绝对目录,如果上级目录不存在会自动创建,无默认值
      append: 如果为true,末尾追加。  如果为false,清空现有文件
      encoder: 格式化
      prudent: 如果为true,日志会被安全的写入文件,效率低   默认为false
      
    • RollingFileAppender 滚动记录文件,先将日志记录到指定的文件,当符合某个调价你的时候,将日志记录到其他文件。有以下子节点:

      file: 被写入的文件名
      append: true表示追加  默认为true
      encoder: 格式化
      rollingPolicy:
      triggeringPolicy
      prudent:
      

    • logger 用来设置某一个包或者某一个类的日志打印级别,以及指定

      name: 用来指定受此logger约束的某一个包或者某一个类
      level: 用来设定打印机别. TRACE < DEBUG < INFO < WARN < ERROR
         addtivity: 默认为true,将此loger的打印信息向上级传递;
      <logger>可以包含0到多个 <appender-ref>
      

    对于

    <logger name="com.piedra.logback" level="WARN">
        <appender-ref ref="FILE"/>
    </logger>
    

    这个logger来说,指定了com.piedra.logback这个包的日志级别为WARN,appender-ref为FILE,并且addtivity默认为true,表示向上级传递。所以,当Test类记录日志的时候,调用error方法的日志会被输出到FILE的Appender中,并且向上传递到root logger。因为root logger为ERROR的日志级别,所以,也会将信息输出到STDOUT和ROLLINGFILE这两个Appender中。

    • root 也是元素,但是它是根logger。只有一个level属性。因为已经被命名为为root

      参数参考<logger>元素的相关说明
      

    多项目依赖

    如果日志模块单独出一个项目,比如上面的例子,单独出一个logback模块,那么另外一个项目A引用这个模块,如果说项目A没有任何logback.xml 或者 logback-test.xml配置文件的话,就会采用引入的子模块logback中的配置文件来输出日志信息。

    如果项目A中定义了自己的logback.xml配置文件,那么就使用项目A自己的配置。

    转载请注明出处! 原文地址: http://webinglin.github.io

    Sincerely!

    References:

    1. Logback官方文档
    2. logback.xml常用配置
  • 相关阅读:
    HDOJ-3635-Dragon Balls 解题报告
    HDOJ-1217-Arbitrage 解题报告
    C语言控制台窗口图形界面编程(总结)
    PC(win10)上搭建 kubernetes + docker 集群环境
    Hessian 2.0 序列化协议
    对响应式布局的理解
    常用链接集合
    dubbox升级dubbo的过渡方案:通过扩展dubbo的Protocol实现dubbo与dubbox的相互调用
    Wordpress部署 —— 基于Ubuntu、Mysql和Nginx
    关于27种常见设计模式的总结
  • 原文地址:https://www.cnblogs.com/duwanjiang/p/5392716.html
Copyright © 2011-2022 走看看