日志工具logback的简介与配置

Logback是由log4j创始人设计的又一个开源日志组件。logback当前分成三个模块：logback-core,logback- classic和logback-access。logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。

 

 

<dependency>

    <groupId>org.springframework</groupId>

    <artifactId>spring-context</artifactId>

    <version>${spring.version}</version>

    <exclusions>

       <exclusion>

          <groupId>commons-logging</groupId>

          <artifactId>commons-logging</artifactId>

       </exclusion>

    </exclusions>            

</dependency>

 

 <!-- logback -->

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

  <dependency>

   <groupId>ch.qos.logback</groupId>

   <artifactId>logback-access</artifactId>

   <version>${logback.version}</version>

  </dependency>

 

  <!-- Logging -->

  <dependency>

   <groupId>org.slf4j</groupId>

   <artifactId>slf4j-api</artifactId>

   <version>${org.slf4j.version}</version>

  </dependency>

  <dependency>

   <groupId>org.slf4j</groupId>

   <artifactId>jcl-over-slf4j</artifactId>

   <version>${org.slf4j.version}</version>

   <scope>runtime</scope>

  </dependency>

 

 

1、

 scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 

 

scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 

 

debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 

 

例如：

 

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

          <!-- 省略-->  

    </configuration>  

 

2、 <loger> 

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<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。

  

 

3、<root>

也是<loger>元素，但是它是根loger。只有一个level属性，应为已经被命名为"root". 

 

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

默认是DEBUG。 

 

<root>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger。

 

4、 <appender>： 

 

<appender>是<configuration>的子节点，是负责写日志的组件。

 

<appender>有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。

 

 

1）、ConsoleAppender:

 

把日志添加到控制台，有以下子节点：

 

<encoder>：对日志进行格式化。（具体参数稍后讲解 ）

 

<target>：字符串 System.out 或者 System.err ，默认 System.out ；

 

2）、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。

 

 

例子：

 

1、每天生成一个日志文件，保存30天的日志文件。

 

 <configuration>  

  <appender name="savefile" 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="info">  

    <appender-ref ref="savefile" />  

  </root>  

</configuration> 

 

每小时产生一个日志文件，并保存在当天的日志文件夹中

 

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

        <fileNamePattern>

                logs/%d{yyyy-MM-dd,aux}/%d{yyyy-MM-dd-hh}.log

        </fileNamePattern>

        <maxHistory>60</maxHistory>

</rollingPolicy>

 

参考文档：

http://logback.qos.ch/manual/appenders.html

 

2、按照固定窗口模式生成日志文件，当文件大于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>  

 

 

参考资料：

http://www.cppblog.com/fwxjj/archive/2012/08/16/187345.html