logback的使用

2018-04-17 本文已影响0人非文666

1. 依赖的jar包

 <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-api</artifactId>
                </exclusion>
            </exclusions>
</dependency>
<dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
</dependency>
<dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-access</artifactId>
</dependency>
<dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
</dependency>

2. logback的加载

logback 首先会查找 logback.groovy 文件
当没有找到，继续试着查找 logback-test.xml 文件
当没有找到时，继续试着查找 logback.xml 文件
如果仍然没有找到，则使用默认配置（打印到控制台

3. logback.xml的配置

3.1 configuration节点

configuration是配置文件的根节点，

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

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

3.2 contextName

设置上下文的名称

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

3.3 property

设置变量
用于定义键值对的变量， property 有两个属性 name 和 value，name 是键，value 是值，通过 property 定义的键值对会保存到logger 上下文的 map 集合内。定义变量后，可以使用 “${}” 来使用变量

3.4 logger

logger有两种级别，一种是普通的另一种是<root>
logger是用来设置某一个类或者某一个包的日志打印级别，以及指定的appender。
logger有三个属性：

name:指定日志打印的类或者包，也可能是单纯的一个名字，对应到loggerfactory获取logger的方法参数的那个名字,例：

Logger DISPATCHER_SUCCESS_LOGGER = LoggerFactory.getLogger("dispatcher_success");

level：用来设置打印机别
addtivity：是否向上级 logger 传递打印信息。默认是 true

logger的父级关系

每个包名通过包名决定决定父级关系

 <!-- 根 logger -->
        <root level="info">
            <appender-ref ref="STDOUT"/>
        </root>

        <!--
            普通的 logger
            name：类名或包名，标志该 logger 与哪个包或哪个类绑定
            level：该 logger 的日志级别
            additivity：是否将日志信息传递给上一级
        -->
        <logger name="com.lwc.qg.test.logbackDemo" level="debug" additivity="true">
            <appender-ref ref="STDOUT"/>
        </logger>

        <logger name="com.lwc.qg.test" level="info" additivity="true">
            <appender-ref ref="STDOUT"/>
        </logger>

        <logger name="com.lwc.qg" level="info" additivity="true">
            <appender-ref ref="STDOUT"/>
        </logger>

他们几个logger的父级关系是
com.lwc.qg.test.logbackDemo → com.lwc.qg.tes → com.lwc.qg → root

日志打印流程：从最低级别的logger开始，判断级别，有自己的级别用自己的，有appender-ref就打印日志，再看additivity属性，为true就再向上传递日志信息，为false就整个一条链断了，所有父级不管有没有appender-ref都也不打日志
日志级别：有子级的日志级别用子级的，如果没有子级且自己也没有用父级的

3.5 appender

appender 是负责写日志的组件，常用的组件有

ConsoleAppender
FileAppender
RollingFileAppender

3.5.1 ConsoleAppender

控制台日志组件，该组件将日志信息输出到控制台,该组件有以下节点：
encoder：对日志进行格式化
target：System.out 或者 System.err，默认是 System.out

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
        <encoder>  
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
        </encoder> 
        <target>System.out</target> 
    </appender>

3.5.2 FileAppender

文件日志组件，该组件将日志信息输出到日志文件中，该组件有以下节点

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

<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>
        <prudent>true</prudent>
    </appender>

3.5.3 RollingFileAppender

滚动记录文件日志组件，先将日志记录记录到指定文件，当符合某个条件时，将日志记录到其他文件，该组件有以下节点

file：文件名
encoder：格式化
rollingPolicy：当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
triggeringPolicy：告知 RollingFileAppender 合适激活滚动
prudent：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。

3.5.3.1 rollingPolicy

滚动策略

TimeBasedRollingPolicy：最常用的滚动策略，它根据时间来制定滚动策略，即负责滚动也负责触发滚动，包含节点：

fileNamePattern：文件名模式
maxHistoury：控制文件的最大数量，超过数量则删除旧文件

FixedWindowRollingPolicy：根据固定窗口算法重命名文件的滚动策略，包含节点

minInedx：窗口索引最小值
maxIndex：串口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12

fileNamePattern：文件名模式，必须包含%i，命名模式为 log%i.log，会产生 log1.log，log2.log 这样的文件

triggeringPolicy：根据文件大小的滚动策略，包含节点
maxFileSize：日志文件最大大小

<appender name="daoPerf4j" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${LOG_HOME}/dispatcher.daoPerf4j.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/history/%d{yyyyMM,aux}/dispatcher.daoPerf4j.log.%d{yyyyMMdd}</FileNamePattern>
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder>
            <Pattern>%msg%n</Pattern>
            <charset>utf-8</charset>
        </encoder>
    </appender>

注：日志行的格式

由appender的encoder子标签决定

<encoder>
            <charset>UTF-8</charset>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{15} [%M:%L] %X{traceId} %X{orderNo} - %msg%n</pattern>
        </encoder>