logback配置⽂件---l详解
⼀、参考⽂档
1、官⽅⽂档
2、博客⽂档
⼆、l常⽤配置详解
常⽤节点结构图：
1、根节点<configuration>，包含下⾯三个属性：
    scan: 当此属性设置为true时，配置⽂件如果发⽣改变，将会被重新加载，默认值为true。
    scanPeriod: 设置监测配置⽂件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性⽣效。默认的时间间隔为1分钟。
    debug: 当此属性设置为true时，将打印出logback内部⽇志信息，实时查看logback运⾏状态。默认值为false。
⽰例：
<configuration scan="true" scanPeriod="60 seconds" debug="false">
  <!--其他配置省略-->
</configuration>　
2、⼦节点<appender>：负责写⽇志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。
下⽂只简述常见的appder，其他appender使⽤请参考官⽅⽂档。
2.1、ConsoleAppender 把⽇志输出到控制台，有以下⼦节点：
<encoder>：对⽇志进⾏格式化。
<target>：字符串System.out(默认)或者
⽰例：把>=DEBUG级别的⽇志都输出到控制台
<configuration>
  　<appender name="STDOUT" class="ch.ConsoleAppender">
    　<encoder>
        　<pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
    　</encoder>
  　</appender>
  　<root level="DEBUG">
      <appender-ref ref="STDOUT"/>
  　</root>
</configuration>
2.2、FileAppender：把⽇志添加到⽂件，有以下⼦节点：
    　<file>：被写⼊的⽂件名，可以是相对⽬录，也可以是绝对⽬录，如果上级⽬录不存在会⾃动创建，没有默认值。
    　<append>：如果是 true，⽇志被追加到⽂件结尾，如果是 false，清空现存⽂件，默认是true。
    　<encoder>：对记录事件进⾏格式化。（具体参数稍后讲解）
    　<prudent>：如果是 true，⽇志会被安全的写⼊⽂件，即使其他的FileAppender也在向此⽂件做写⼊操作，效率低，默认是false。
⽰例：把>=DEBUG级别的⽇志都输出到testFile.log
    <configuration>
      <appender name="FILE" class="ch.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>
2.3、RollingFileAppender：滚动记录⽂件，先将⽇志记录到指定⽂件，当符合某个条件时，将⽇志记录到其他⽂件。有以下⼦节点：
log4j2自定义日志文件名
    <file>：被写⼊的⽂件名，可以是相对⽬录，也可以是绝对⽬录，如果上级⽬录不存在会⾃动创建，没有默认值。
    <append>：如果是 true，⽇志被追加到⽂件结尾，如果是 false，清空现存⽂件，默认是true。
    <rollingPolicy>：当发⽣滚动时，决定RollingFileAppender的⾏为，涉及⽂件移动和重命名。属性class定义具体的滚动策略类
<1> class="ch.olling.TimeBasedRollingPolicy"：最常⽤的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下⼦节点：
      <fileNamePattern>：必要节点，包含⽂件名及“%d”转换符，“%d”可以包含⼀个SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。
如果直接使⽤ %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可⽆，通过设置file，可以为活动⽂件和归档⽂件指定不同位置，当前⽇志总是记录到file指定的⽂件（活动⽂件），活动⽂件的名字不会改变；
如果没设置file，活动⽂件的名字会根据fileNamePattern 的值，每隔⼀段时间改变⼀次。“/”或者“\”会被当做⽬录分隔符。
        <maxHistory>:
可选节点，控制保留的归档⽂件的最⼤数量，超出数量就删除旧⽂件。假设设置每个⽉滚动，且<maxHistory>是6，则只保存最近6个⽉的⽂件，删除之前的旧⽂件。注意，删除旧⽂件是，那些为了归档⽽创建的⽬录也会被删除。
<2> class="ch.olling.SizeBasedTriggeringPolicy"：查看当前活动⽂件的⼤⼩，如果超过指定⼤⼩会告知RollingFileAppender 触发当前活动⽂件滚动。只有⼀个节点:
    　<maxFileSize>：这是活动⽂件的⼤⼩，默认值是10MB。
    　<prudent>：当为true时，不⽀持FixedWindowRollingPolicy。⽀持TimeBasedRollingPolicy，但是有两个限制，1不⽀持也不允许⽂件压缩，2不能设置file属性，必须留空。
    　<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
<3> class="ch.olling.FixedWindowRollingPolicy" 根据固定窗⼝算法重命名⽂件的滚动策略。有以下⼦节点：
    　<minIndex>：窗⼝索引最⼩值
    　<maxIndex>：窗⼝索引最⼤值，当⽤户指定的窗⼝过⼤时，会⾃动将窗⼝设置为12。
    　<fileNamePattern>：必须包含“%i”例如，假设最⼩值和最⼤值分别为1和2，命名模式为 mylog%i.log，会产⽣归档⽂件mylog1.log和mylog2.log。还可以指定⽂件压缩选项，例如，mylog% 或者没有log%i.log.zip
⽰例：每天⽣成⼀个⽇志⽂件，保存30天的⽇志⽂件。
      <configuration>
          <appender name="FILE" class="ch.olling.RollingFileAppender">
            <rollingPolicy class="ch.olling.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>
3、⼦节点<logger>：⽤来设置某⼀个包或具体的某⼀个类的⽇志打印级别、以及指定<appender>。
<logger>仅有⼀个name属性，⼀个可选的level和⼀个可选的addtivity属性。
可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。
    name: ⽤来指定受此loger约束的某⼀个包或者具体的某⼀个类。
    level: ⽤来设置打印级别，⼤⼩写⽆关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有⼀个特殊值INHERITED或者同义词NULL，代表强制执⾏上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
    addtivity: 是否向上级logger传递打印信息。默认是true。可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。
4、⼦节点<root>：它也是<logger>元素，但是它是根loger，是所有<loger>的上级。只有⼀个level属性，因为
name已经被命名为"root"，且已经是最上级了。
    level: ⽤来设置打印级别，⼤⼩写⽆关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。
同<loggert>⼀样，可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。
⽰例：常⽤logger配置
<!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
<logger name="pe.descriptor.sql.BasicBinder" level="TRACE"/>
<logger name="pe.descriptor.sql.BasicExtractor" level="DEBUG"/>
<logger name="org.hibernate.SQL" level="DEBUG"/>
<logger name="ine.QueryParameters" level="DEBUG"/>
<logger name="ine.query.HQLQueryPlan" level="DEBUG"/>
<!--myibatis log configure-->
<logger name="com.apache.ibatis" level="TRACE"/>
<logger name="java.sql.Connection" level="DEBUG"/>
<logger name="java.sql.Statement" level="DEBUG"/>
<logger name="java.sql.PreparedStatement" level="DEBUG"/>
5、⼦节点<contextName>：⽤来设置上下⽂名称，每个logger都关联到logger上下⽂，默认上下⽂名称
为default。但可以使⽤<contextName>设置成其他名字，⽤于区分不同应⽤程序的记录。⼀旦设置，不能修改。
⽰例：
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
  <!--其他配置省略-->
</configuration>
6、⼦节点<property> ：⽤来定义变量值，它有两个属性name和value，通过<property>定义的值会被插⼊到logger上下⽂中，可以使“${}”来使⽤变量。   
    name: 变量的名称
    value: 的值时变量定义的值
⽰例：
<configuration scan="true" scanPeriod="60 seconds" debug="false">
  　<property name="APP_Name" value="myAppName"/>
  　<contextName>${APP_Name}</contextName>
  　<!--其他配置省略-->
</configuration>
7、⼦节点<timestamp>：获取时间戳字符串，他有两个属性key和datePattern。   
    key: 标识此<timestamp> 的名字；
    datePattern: 设置将当前时间（解析配置⽂件的时间）转换为字符串的模式，遵循SimpleDateFormat的格式。
⽰例：
<configuration scan="true" scanPeriod="60 seconds" debug="false">
      <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
      <contextName>${bySecond}</contextName>
      <!-- 其他配置省略-->
</configuration>
三、l配置⽰例
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--定义⽇志⽂件的存储地址勿在 LogBack 的配置中使⽤相对路径-->
<property name="LOG_HOME" value="/home"/>
<!--控制台⽇志，控制台输出 -->
<appender name="STDOUT" class="ch.ConsoleAppender">
<encoder class="ch.qos.der.PatternLayoutEncoder">
<!--格式化输出：%d表⽰⽇期，%thread表⽰线程名，%-5level：级别从左显⽰5个字符宽度,%msg：⽇志消息，%n是换⾏符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
</appender>
<!--⽂件⽇志，按照每天⽣成⽇志⽂件 -->
<appender name="FILE" class="ch.olling.RollingFileAppender">
<rollingPolicy class="ch.olling.TimeBasedRollingPolicy">
<!--⽇志⽂件输出的⽂件名-->
<FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<!--⽇志⽂件保留天数-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.der.PatternLayoutEncoder">
<!--格式化输出：%d表⽰⽇期，%thread表⽰线程名，%-5level：级别从左显⽰5个字符宽度%msg：⽇志消息，%n是换⾏符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</encoder>
<!--⽇志⽂件最⼤的⼤⼩-->
<triggeringPolicy class="ch.olling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
<logger name="pe.descriptor.sql.BasicBinder" level="TRACE"/>
<logger name="pe.descriptor.sql.BasicExtractor" level="DEBUG"/>
<logger name="org.hibernate.SQL" level="DEBUG"/>
<logger name="ine.QueryParameters" level="DEBUG"/>
<logger name="ine.query.HQLQueryPlan" level="DEBUG"/>
<!--myibatis log configure-->
<logger name="com.apache.ibatis" level="TRACE"/>
<logger name="java.sql.Connection" level="DEBUG"/>
<logger name="java.sql.Statement" level="DEBUG"/>
<logger name="java.sql.PreparedStatement" level="DEBUG"/>
<!-- ⽇志输出级别 -->
<root level="DEBUG">
<appender-ref ref="STDOUT"/>
<appender-ref ref="FILE"/>
</root>
</configuration>
四、总结
1、输出源选择
logback的配置，需要配置输出源appender，打⽇志的logger（⼦节点）和root（根节点），实际上，它输出⽇志是从⼦节点开始，⼦节点如果有输出源直接输⼊，如果⽆，判断配置的addtivity，是否向上级传递，即是否向root传递，传递则采⽤root的输出源，否则不输出⽇志。2、⽇志级别Level
⽇志记录器（Logger）的⾏为是分等级的：分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。
Log4j建议只使⽤四个级别，优先级从⾼到低分别是 ERROR、WARN、INFO、DEBUG，优先级⾼的将被打印出来。（logback通⽤）
通过定义级别，可以作为应⽤程序中相应级别的⽇志信息的开关。
⽐如在这⾥定义了INFO级别，则应⽤程序中所有DEBUG级别的⽇志信息将不被打印出来。（设置INFO级别，即：>=INFO ⽣效）
项⽬上⽣产环境的时候⼀定得把debug的⽇志级别重新调为warn或者更⾼，避免产⽣⼤量⽇志。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。