logback的使用

logback的介绍

  Logback是由创始人设计的另一个开源日志组件。它分为下面三个模块：

1）logback-core

  其他两个模块的基础模块

2) logback-classic

  他是log4j的一个改良版本，同时它完整实现了slf4j API，可以很方便地更换成其他日志系统如log4j或JDK14 Logging

3) logback-access

  访问模块与Servlet容器集成提供通过HTTP来访问日志的功能。

logback的默认配置

1) logback的配置文件

  Logback配置文件的语法非常灵活，所以无法用DTD或XML schema进行定义。尽管如此，可以描述配置文件的基本结构：以<configuration>开始，后面有零个或多个<appender>元素，有零个或多个<logger>元素，有最多一个<root>元素。

2) logback默认配置的步骤

• 尝试在classpath下查找文件logback-test.xml；
• 如果文件不存在，则查找文件logback.xml；
• 如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，这会导致记录输出到控制台。

logback.xml常用配置详解

1）根结点<configuration>，包含三个属性

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

<configuration scan="true" scanPeriod="60000" debug="true">
    <!--其他配置省略-->
<configuration>

2）子节点<contextName>

  用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

<configuration debug="true" scanPeriod="60000" scan="true">
    <contextName>${appName}</contextName>
    <!--其他配置省略-->
<configuration>

3）子节点<property>

  用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使"${}"来使用变量。

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

<configuration debug="true" scanPeriod="60000" scan="true">
    <contextName>${appName}</contextName>
    <property name="appName" value="oss.ui"/>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="/home/test/data_dir/logs"/>
    <!--其他配置省略-->
<configuration>

4）子节点<appender>

  负责写日志的组件，它有两个必要属性name和class。

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

4.1）ConsoleAppender

  把日志输出到控制台有以下子节点：

• <encoder>: 对日志进行格式化；
• <target>: 字符串System.out（默认）或者System.err。

<configuration debug="true" scanPeriod="60000" scan="true">

    <contextName>${appName}</contextName>
    <property name="appName" value="oss.ui"/>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度，%logger: Java类名（含包名，这里设定了36位，若超过36位，包名会精简为类似a.b.c.JavaBean)，%line: Java类的行号，%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-5level] [%logger{36}:%line] - [%msg]%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
<configuration>

上述配置表示把>=INFO级别的日志都输出到控制台

4.2）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>

上述配置表示把>=DEBUG级别的日志都输出到testFile.log

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

• <file>: 被写入的文件名字，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动给创建，没有默认值。
• <append>: 如果是true，日志被追加到文件结尾，如果是false，清空现存文件，默认是true。
• <rollingPolicy>: 当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类
  • class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"，最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。有以下子节点：
    
    (1) <fileNamePattern>: 必要节点，包含文件名及"%d"转换符，"%d"可以包含一个java.text.SimpleDateFormat指定的时间格式，如%d{yyyy-MM-dd}。如果直接使用%d，默认格式yyyy-MM-dd。RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录如果没设置file，活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次。"/"或者""会被当作目录分隔符。
    
    (2) <maxHistory>: 可选节点，控制保留的归档文件的最大数量，超出数量就删除就文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的就文件。注意，删除旧文件包括为了归档而创建的目录也会被删除。
  • class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"，查看当前活动文件的饿大小，如果超过指定大小会告知RollingFileAppender触发当前活动文件滚动。只有一个节点：
    
    (1) <maxFileSize>：活动文件的大小，默认值是10MB；
    
    (2) <prudent>：当为true是，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1 不支持也不允许文件压缩，2 不能设置file属性，必须留空。
    
    (3) <triggerPolicy>：告知RollingFileAppender合适激活滚动。
  • class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下字节点：
    
    (1) <minIndex>: 窗口索引最小值
    
    (2) <maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
    
    (3) <fileNamePattern>: 必须包含"%i"。例如：假设最小值和最大值分别为1和2，命名模式为mylog%i.log，会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如 ，mylog%i.log.gz或者没有log%i.log.zip。
• <encoder>：对记录时间进行格式化。负责两件事：一是把日志信息转换成字节数组，二是吧字节数组写入到输出流。PatternLayoutEncoder是唯一有用的且默认的encoder，又一个节点，用来设置日志的输入格式。使用"%"加"转换符"方式，如果要输出"%"，则必须用""对"%"进行转义。

<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>

上述配置表示每天生成一个日志文件，保存30天的日志文件。

<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>
　　　　    <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
　　　　　　<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-5level] [%logger{36}:%line] - [%msg]%n</pattern> 
　　　　</encoder> 
　　</appender> 

    <!-- 日志输出级别 -->
　　<root level="DEBUG"> 
　　　　<appender-ref ref="FILE" /> 
　　</root> 
</configuration>

上述配置表示按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。

5）子节点<logger>

  用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性，一个可选的level和一个可选的addivity属性。可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。

• name: 用来指定受此logger约束的某一个包或者具体的某一个类
• level: 用来设置打印级别，大小写无关：ALL、TRACE、 DEBUG、INFO、WARN、ERROR、FATAL、OFF、INHERITED和NULL，其中INHRFITED和NULL的作用是一样的，并不是不打印任何日志，二是强制这个logger必须从其父辈继承一个日志级别。如果未设置此属性，那么当前logger将会继承上级的级别。additibity的取值是一个布尔值，true或false。

6）子节点<root>

  和<logger>标签的配置类似，是所有<logger>的上级。只有一个level属性，因为name已经被命名为"root"，且已经是最上级了。

• level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。

<appender name="GENERAL-RPC-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <append>true</append>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>${LOG_HOME}/${appName}/general-rpc.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>5</maxHistory>
    </rollingPolicy>
<appender>
<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-5level] [%logger{36}:%line] - [%msg]%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <FileNamePattern>${LOG_HOME}/${appName}/oss.ui.debug.log.%d{yyyy-MM-dd}</FileNamePattern>
        <MaxHistory>${LOG_KEEP_TIME}</MaxHistory>
    </rollingPolicy>
    <!-- 过滤器，只记录TRACE级别的日志 --> 
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>TRACE</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>

<appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-5level] [%logger{36}:%line] - [%msg]%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <FileNamePattern>${LOG_HOME}/${appName}/oss.ui.info.log.%d{yyyy-MM-dd}</FileNamePattern>
        <MaxHistory>${LOG_KEEP_TIME}</MaxHistory>
    </rollingPolicy>
    <!-- 过滤器，只记录DEBUG级别的日志 -->
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>INFO</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>

<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-5level] [%logger{36}:%line] - [%msg]%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <FileNamePattern>${LOG_HOME}/${appName}/oss.ui.error.log.%d{yyyy-MM-dd}</FileNamePattern>
        <MaxHistory>${LOG_KEEP_TIME}</MaxHistory>
    </rollingPolicy>
    <!-- 过滤器，只记录ERROR级别的日志 -->
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>ERROR</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>

<appender name="EXPRESS_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-5level] [%logger{36}:%line] - [%msg]%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <FileNamePattern>${LOG_HOME}/${appName}/oss.ui.express.log.%d{yyyy-MM}</FileNamePattern>
        <MaxHistory>6</MaxHistory>
    </rollingPolicy>
</appender>
<logger name="ch.qos.logback" additivity="true" level="INFO"/>

<logger name="org.quartz" additivity="true" level="ERROR"/>

<logger name="org.spring" additivity="true" level="ERROR"/>

<logger name="trace-log" level="INFO" additivity="false">
    <appender-ref ref="TRACE-LOG" />
</logger>

<logger name="general-rpc-log" level="DEBUG" additivity="false" >
    <appender-ref ref="GENERAL-RPC-LOG" />
</logger>

<logger name="com.xman.rainbow.backups" additivity="true" level="INFO">
    <appender-ref ref="DEBUG_FILE"/>
    <appender-ref ref="INFO_FILE"/>
    <appender-ref ref="ERROR_FILE"/>
</logger>

<logger name="com.xman.common.log.ILog" level="INFO" additivity="true">
    <appender-ref ref="EXPRESS_FILE" />
</logger>


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

Maven配置

<properties>
　　<logback.version>1.1.7</logback.version>
　　<slf4j.version>1.7.21</slf4j.version>
</properties>

<dependencies>
　　<dependency>
　　　　<groupId>org.slf4j</groupId>
　　　　<artifactId>slf4j-api</artifactId>
　　　　<version>${slf4j.version}</version>
　　　　<scope>compile</scope>
　　</dependency>
　　<dependency>
　　　　<groupId>ch.qos.logback</groupId>
　　　　<artifactId>logback-core</artifactId>
　　　　<version>${logback.version}</version>
　　</dependency>
　　<dependency>
　　　　<groupId>ch.qos.logback</groupId>
　　　　<artifactId>logback-classic</artifactId>
　　　　<version>${logback.version}</version>
　　　　</dependency>
</dependencies>

总结

  logback的配置，需要配置输出源appender，打日志的logger（子节点）和root（根节点），实际上，他输出日志是从子节点开始，子节点如果有输出源直接输入，如果无，判断配置的additivity，是否向上级传递，即是否向root传递，传递则采用root的输出源，否则不输出日志。