logback-spring.xml配置简述

什么是 Logback

logback继承自log4j,它建立在有十年工业经验的日志系统之上。它比其它所有的日志系统更快并且更小,包含了许多独特并且有用的特性。

这话是官网说的

Logback 的配置

Configruation

从上面的配置例子中我们可以看到根节点为

在根节点的配置中包含了三个属性如下:

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

比如如下配置:

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
configuration> 

Property

标签作为标签的子标签主要用来定义变量的,它有namevalue两个属性,他的值会进入logger的上下文中,使用${name}可以引用到。

  • name: 变量的名称。
  • value: 变量的值。

比如如下配置:

<property name="APP_NAME" value="DEMO"/>

Timestamp

标签作为标签的子标签主要用来获取当前时间的字符串,它有keydataPattern两个属性,它也同样会进入logger的上下文中,使用${key}可以引用到。

  • key: 表示此标签的名字,类似上面propertyname作用。
  • dataPattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。

比如如下配置:

<timestamp key="FULL_DATE" dataPattern="yyyy-MM-dd HH:mm:ss"/>

emmmm感觉好像用的不多。

Appender

标签是写日志的组件,它主要有两个属性即nameclass

  • name: 即指定该组件的名称。
  • class: 为全限定名,他们必须实现自 ch.qos.logback.core.Appender接口。

常用的Appender有三种,他们分别是ConsoleAppenderFileAppenderRollingFileAppender

选择每一个不同的Appender,所具有的子节点是不同的。

在开始介绍不同的Appender之前,先介绍几个转换标记,因为在下面写文件名以及格式化日志的时候会用到:

  • %d: 输出日志时间点的日期或时间,指定格式的方式 %d{yyyy-MM-dd HH:mm:ss}

  • %i: 这是个一个自增索引,在分文件的时候,达到设的限制时,索引便会自增,从0开始,下面会用到

  • %p: 输出优先级,即DEBUGINFOWARNERRORFATAL

  • %r: 输出从应用启动到输出该日志所耗费的毫秒数

  • %t: 输出产生该日志的线程名

  • %f: 输出日志所属的类别名

  • %c: 输出日志类的全名

  • %l: 输出日志事件的发生位置,即输出日志语句在他所在类别的第几行。

  • %m: 输出代码中指定的信息,如log(message)中的message

  • %n: 输出一个换行符号

ConsoleAppender

ConsoleAppender所对应的是将日志写到控制台的,它具有以下子节点:

  • : 对日志进行格式化。

例如:


<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>
            [%-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%npattern>
        <charset>UTF-8charset>
    encoder>
appender>

FileAppender

FileAppender是将日志写入到文件中,它有以下子节点:

  • : 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  • : 如果是true,日志被追加到文件结尾,如果是false,清空现存文件,默认是true
  • : 对日志进行格式化。
  • : 如果是true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是false

例如:


<appender name="MONITOR_FILE" class="ch.qos.logback.core.FileAppender">
    <encoder>
        <pattern>${PATTERN}pattern>
        <charset>UTF-8charset>
    encoder>
    <file>logs/${APP_NAME}.logfile>
    <prudent>trueprudent>
appender>

这里的${PATTERN}就是取的上文中提到的标签,将[%-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n定义在其中了

RollingFileAppender

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

  • : 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  • : 对日志进行格式化。
  • : 如果是true,日志被追加到文件结尾,如果是false,清空现存文件,默认是true
  • : 当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。属性class定义具体的滚动策略类。这里有几种常见的策略,比如:
    • TimeBasedRollingPolicy: 这是一种相对比较常用的策略,可以按天、按月等来分日志文件。
    • SizeAndTimeBasedRollingPolicy: 这种策略是用来在比如按日期归档文件的时候,想要限制其大小,可以使用这种策略来实现。

例如:


    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>${PATTERN}pattern>
            <charset>UTF-8charset>
        encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFOlevel>
            <onMatch>ACCEPTonMatch>
            <onMismatch>DENYonMismatch>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_DIR}/${APP_NAME}/info-${APP_NAME}-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>32 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <prudent>trueprudent>
    appender>

Logger

该节点设置某一个包下或者某一个类的日志级别的,他有以下属性:

  • name: 用来指定受此logger作用的某一个包或者具体的某一个类。
  • level: 用来设置当前指定包或类的日志级别,大小写不敏感,可以设置:TRACEDEBUGINFOWARNERRORALLOFF,还有一个特殊的值INHERITED或者NULL,代表强制执行上级的级别,如果未设置此属性,那么当前logger将会继承上级的级别。
  • addtivity: 是否向上级logger传递打印信息。默认是true

例如:

<logger name="org.mybatis.spring" level="INFO" />

Root

节点也是一个必选的节点,用来指定基础的日志输出级别,就是除了上面指定的,其他都是按此级别的,它只有一个level属性:

level: 也是用来指定日志级别的,但是这里不能设置特殊的值INHERITED或者NULL了,默认是DEBUG,其可以包含零个或者多个元素,标识使用哪些appender会在这里生效。

例如:

<root level="INFO">
  <appender-ref ref="STDOUT" />
  <appender-ref ref="INFO_FILE" />
  <appender-ref ref="WARN_FILE" />
  <appender-ref ref="DEBUG_FILE" />
  <appender-ref ref="ERROR_FILE" />
root>

完整示例

这个便是在学习这些配置的时候,结合自己要写的工程编写的logbakc-spring.xml文件,结合上面所说的配置,再加上少量注释,应该大致可以理解了:


<configuration scan="true" scanPeriod="10 seconds">

    <property name="APP_NAME" value="queen-registry"/>
    <property name="PATTERN" value="[%-5level] [%date{yyyy-MM-dd HH:mm:ss}] %logger{96} [%line] - %msg%n"/>

    
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${PATTERN}pattern>
            <charset>UTF-8charset>
        encoder>
    appender>

    
    <appender name="MONITOR_FILE" class="ch.qos.logback.core.FileAppender">
        <encoder>
            <pattern>${PATTERN}pattern>
            <charset>UTF-8charset>
        encoder>
        <file>logs/${APP_NAME}.logfile>
        <prudent>trueprudent>
    appender>

    
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>${PATTERN}pattern>
            <charset>UTF-8charset>
        encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFOlevel>
            <onMatch>ACCEPTonMatch>
            <onMismatch>DENYonMismatch>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${APP_NAME}/logs/info-${APP_NAME}-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>32 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <prudent>trueprudent>
    appender>

    
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>${PATTERN}pattern>
            <charset>UTF-8charset>
        encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARNlevel>
            <onMatch>ACCEPTonMatch>
            <onMismatch>DENYonMismatch>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${APP_NAME}/logs/warn-${APP_NAME}-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>32 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <prudent>trueprudent>
    appender>

    
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>${PATTERN}pattern>
            <charset>UTF-8charset>
        encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUGlevel>
            <onMatch>ACCEPTonMatch>
            <onMismatch>DENYonMismatch>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${APP_NAME}/logs/debug-${APP_NAME}-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>32 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <prudent>trueprudent>
    appender>

    
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>${PATTERN}pattern>
            <charset>UTF-8charset>
        encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERRORlevel>
            <onMatch>ACCEPTonMatch>
            <onMismatch>DENYonMismatch>
        filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${APP_NAME}/logs/error-${APP_NAME}-%d{yyyy-MM-dd}.%i.logfileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>32 MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
        <prudent>trueprudent>
    appender>
 
    
    
    <springProfile name="dev, staging">
        <root level="INFO">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="MONITOR_FILE" />
        root>
        <logger name="top.felixu.queen" level="DEBUG"/>
        <logger name="org.mybatis.spring" level="INFO" />
        <logger name="com.netflix.discovery" level="INFO" />
        <logger name="org.springframework.amqp.rabbit" level="INFO" />
    springProfile>

    
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="INFO_FILE" />
            <appender-ref ref="WARN_FILE" />
            <appender-ref ref="DEBUG_FILE" />
            <appender-ref ref="ERROR_FILE" />
        root>
    springProfile>
configuration>

结语

在写完这篇文章的时候还发现了个中文网http://www.logback.cn/

参考自logback官网

你可能感兴趣的:(Spring,Logback,logback)