• LogBack学习


    Logback背景

      Logback是一个开源的日志组件,是log4j的作者开发的用来替代log4j的。logback由三个部分组成,logback-core, logback-classic, logback-access。其中logback-core是其他两个模块的基础。slf4j 定义日志接口及基本实现,而具体的实现由其他日志组件提供log4j、 commons-logging、logback。因此,如果想替换成其他的日志组件,只需要替换jar包即可。
    logback中三个重要概念: Logger,Appender,Layout
      Logger: 日志记录器,把它关联到应用对应的context上后,主要用于存放日志对象,定义日志类型,级别。
      Appender: 指定日志输出的目的地,目的地可以是控制台,文件,或者数据库等
      Layout: 负责把事件转换成字符串,格式化日志信息的输出
    寻找logback.xml

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

    为什么使用Logback

        1、更快的实现。Logback的内核重写了,在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了,初始化内存加载也更小了。
        2、Logback-classic非常自然实现了SLF4j。Logback-classic实现了SLF4j。在使用SLF4j中,你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了SLF4J, 所以切换到log4j或者其他,非常容易,只需要提供成另一个jar包就OK,根本不需要去动那些通过SLF4JAPI实现的代码。
        3、自动重新加载配置文件。当配置文件修改了,Logback-classic能自动重新加载配置文件。扫描过程快且安全,它并不需要另外创建一个扫描线程。
        4、Lilith。Lilith是log事件的观察者,和log4j的chainsaw类似。而lilith还能处理大数量的log数据 。
        5、配置文件可以处理不同的情况。开发人员经常需要判断不同的Logback配置文件在不同的环境下(开发,测试,生产)。而这些配置文件仅仅只有一些很小的不同,可以通过,和来实现,这样一个配置文件就可以适应多个环境。
        6、Filters(过滤器) 有些时候,需要诊断一个问题,需要打出日志。在log4j,只有降低日志级别,不过这样会打出大量的日志,会影响应用性能。在Logback,你可以继续 保持那个日志级别而除掉某种特殊情况,如alice这个用户登录,她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需 加4行XML配置。可以参考MDCFIlter 。
        7、自动压缩。已经打出来的log RollingFileAppender在产生新文件的时候,会自动压缩已经打出来的日志文件。压缩是个异步过程,所以甚至对于大的日志文件,在压缩过程中应用不会受任何影响。
        8、堆栈树带有包版本。Logback在打出堆栈树日志时,会带上包的数据。
        9、自动去除旧的日志文件 通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性,你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12,那那些log文件超过12个月的都会被自动移除。

    Logback配置

    一:根节点<configuration>包含的属性:

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

        <configuration scan="true" scanPeriod="60 seconds" debug="false">  
              <!-- 其他配置省略-->  
        </configuration> 

    二:根节点<configuration>的子节点:
    2.1设置上下文名称:<contextName>
      每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。

        <configuration scan="true" scanPeriod="60 seconds" debug="false"> 
              <contextName>myAppName</contextName>  
              <!-- 其他配置省略-->  
        </configuration>  

    2.2设置变量: <property>
      用来定义变量值的标签,<property> 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
    2.3设置logger:
      <logger>:用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。
        name:用来指定受此loger约束的某一个包或者具体的某一个类。
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。
        addtivity:是否向上级loger传递打印信息。默认是true。
       <loger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。<root>也是<logegr>元素,但是它是根logger。只有一个level属性,应为已经被命名为"root".默认是DEBUG。<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。
      例如:

    package logback;     
        import org.slf4j.Logger;  
        import org.slf4j.LoggerFactory;     
        public class LogbackDemo {  
            private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
            public static void main(String[] args) {  
                log.trace("======trace");  
                log.debug("======debug");  
                log.info("======info");  
                log.warn("======warn");  
                log.error("======error");  
            }  
        }  
    View Code

      logback.xml配置文件
      第1种:只配置root

    <configuration>     
          <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
            <!-- encoder 默认配置为PatternLayoutEncoder -->   
                <encoder>   
                      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
                </encoder>   
          </appender>   
           
          <root level="INFO">             
                <appender-ref ref="STDOUT" />   
          </root>     
    </configuration>  
    View Code

      其中appender的配置表示打印到控制台。当执行logback.LogbackDemo类的main方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
      第2种:带有loger的配置,不指定级别,不指定appender,

    <configuration>     
          <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
            <!-- encoder 默认配置为PatternLayoutEncoder -->   
                <encoder>   
                      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
                </encoder>   
          </appender>   
           
          <!-- logback为java中的包 -->   
          <logger name="logback"/>   
           
          <root level="DEBUG">             
                <appender-ref ref="STDOUT" />   
          </root>             
    </configuration>      
    View Code

      <logger name="logback" />将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级<root>的日志级别“DEBUG”;没有设置addtivity,默认为true,将此loger的打印信息向上级传递;没有设置appender,此loger本身不打印任何信息。
    <root level="DEBUG">将root的打印级别设置为“DEBUG”,指定了名字为“STDOUT”的appender。 当执行logback.LogbackDemo类的main方法时,因为LogbackDemo在包logback中,所以首先执行<logger name="logback" />,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印;root接到下级传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
      第3种:带有多个loger的配置,指定级别,指定appender  

    <configuration>   
           <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
            <!-- encoder 默认配置为PatternLayoutEncoder -->   
                <encoder>   
                      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>   
                </encoder>   
          </appender>   
           
          <!-- logback为java中的包 -->   
          <logger name="logback"/>   
          <!--logback.LogbackDemo:类的全路径 -->   
          <logger name="logback.LogbackDemo" level="INFO" additivity="false">  
                <appender-ref ref="STDOUT"/>  
          </logger>   
            
          <root level="ERROR">             
                <appender-ref ref="STDOUT" />   
          </root>     
    </configuration>  
    View Code

       当执行logback.LogbackDemo类的main方法时,先执行<logger name="logback.LogbackDemo" level="INFO" additivity="false">,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向次loger的上级 <logger name="logback"/> 传递打印信息;<logger name="logback"/>未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;
      如果将<logger name="logback.LogbackDemo" level="INFO" additivity="false">修改为 <logger name="logback.LogbackDemo" level="INFO" additivity="true">那打印结果将是什么呢?没错,日志打印了两次,想必大家都知道原因了,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。

    2.4设置<appender>
      <appender>是<configuration>的子节点,是负责写日志的组件。<appender>有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
    ConsoleAppender:把日志添加到控制台,有以下子节点:

    • <encoder>:对日志进行格式化。(具体参数稍后讲解 )
    • <target>:字符串 System.out 或者 System.err ,默认 System.out ; 
    <configuration>   
          <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
                <encoder>  
                      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
                </encoder>  
          </appender>  
          
          <root level="DEBUG">  
                <appender-ref ref="STDOUT" />  
          </root>  
    </configuration>  
    View Code

    FileAppender:把日志添加到文件,有以下子节点:

    • <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
    • <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
    • <encoder>:对记录事件进行格式化。
    • <prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
    <configuration>   
          <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>  
                  
          <root level="DEBUG">  
                <appender-ref ref="FILE" />  
          </root>  
    </configuration>  
    View Code

    RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:

    • <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
    • <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
    • <encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
    • <rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。
    • <triggeringPolicy >: 告知 RollingFileAppender何时激活滚动。
    • <prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。

    rollingPolicy:

    • TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:
      <fileNamePattern>:必要节点,包含文件名及“%d”转换符, “%d”可以包含一个Java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“”会被当做目录分隔符。
      <maxHistory>:可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且<maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。
    • FixedWindowRollingPolicy: 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
      <minIndex>:窗口索引最小值
      <maxIndex>:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
      <fileNamePattern >:必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip
    • triggeringPolicy:
      SizeBasedTriggeringPolicy: 查看当前活动文件的大小,如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
      <maxFileSize>:这是活动文件的大小,默认值是10MB。
      例如:每天生成一个日志文件,保存30天的日志文件
      <configuration>   
            <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">  
                  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
                        <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>   
                        <maxHistory>30</maxHistory>    
                  </rollingPolicy>   
                  <encoder>   
                        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
                  </encoder>   
            </appender>    
             
            <root level="DEBUG">   
                  <appender-ref ref="FILE" />   
            </root>   
      </configuration>  
      View Code
      例如:按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。
      <configuration>   
            <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
                  <file>test.log</file>   
             
              <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">   
                <fileNamePattern>tests.%i.log.zip</fileNamePattern>   
                <minIndex>1</minIndex>   
                <maxIndex>3</maxIndex>   
              </rollingPolicy>   
             
              <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">   
                <maxFileSize>5MB</maxFileSize>   
              </triggeringPolicy>   
              <encoder>   
                <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
              </encoder>   
            </appender>   
                     
            <root level="DEBUG">   
              <appender-ref ref="FILE" />   
            </root>   
          </configuration>  
      View Code
      4.另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这些就不在这里讲解了,大家可以参考官方文档。当然大家可以编写自己的Appender。
      <encoder>:负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。目前PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个<pattern>节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“”对“\%”进行转义。

    2.5<filter>配置:
      过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL,有序列表里的下个过滤器过接着处理日志;返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。过滤器被添加到<Appender> 中,为<Appender> 添加一个或多个过滤器后,可以用任意条件对日志进行过滤。<Appender> 有多个过滤器时,按照配置顺序执行。
      下面是几个常用的过滤器:

      LevelFilter: 级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点:

    • <level>:设置过滤级别
    • <onMatch>:用于配置符合过滤条件的操作
    • <onMismatch>:用于配置不符合过滤条件的操作

      例如:将过滤器的日志级别配置为INFO,所有INFO级别的日志交给appender处理,非INFO级别的日志,被过滤掉。

    <configuration>   
          <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">   
                <filter class="ch.qos.logback.classic.filter.LevelFilter">   
                      <level>INFO</level>   
                      <onMatch>ACCEPT</onMatch>   
                      <onMismatch>DENY</onMismatch>   
                </filter>   
                <encoder>   
                      <pattern>   
                            %-4relative [%thread] %-5level %logger{30} - %msg%n   
                      </pattern>   
                </encoder>   
          </appender>   
          <root level="DEBUG">   
                <appender-ref ref="CONSOLE" />   
          </root>   
    </configuration>  
        
    View Code

      ThresholdFilter: 临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。例如:过滤掉所有低于INFO级别的日志。

    <configuration>   
          <appender name="CONSOLE"   
            class="ch.qos.logback.core.ConsoleAppender">   
               <!-- 过滤掉 TRACE 和 DEBUG 级别的日志-->   
                <filter class="ch.qos.logback.classic.filter.ThresholdFilter">   
                      <level>INFO</level>   
                </filter>   
                <encoder>   
                      <pattern>   
                        %-4relative [%thread] %-5level %logger{30} - %msg%n   
                      </pattern>   
                </encoder>   
          </appender>   
          <root level="DEBUG">   
                <appender-ref ref="CONSOLE" />   
          </root>   
    </configuration>  
    View Code
  • 相关阅读:
    Understanding about Baire Category Theorem
    Isometric embedding of metric space
    Convergence theorems for measurable functions
    Mindmap for "Principles of boundary element methods"
    Various formulations of Maxwell equations
    Existence and uniqueness theorems for variational problems
    Kernels and image sets for an operator and its dual
    [loj6498]农民
    [luogu3781]切树游戏
    [atAGC051B]Three Coins
  • 原文地址:https://www.cnblogs.com/wxgblogs/p/6574765.html
Copyright © 2020-2023  润新知