logback学习与配置使用


目录(?)[-]
  1. Logback介绍
  2. Logback的配置
    1. LoggerAppender和 Layout
    2. Logger context
    3. 有效级别与级别继承
    4. 打印方法与基本选择规则
    5. LoggerAppenders及layouts的关系
    6. Logback的默认配置
      1. logback配置文件
      2. Logback默认配置的采用的步骤
    7. Logback自定义配置
      1. 配置root logger

Logback介绍

Logback 分为三个模块:Core、Classic 和 Access。Core模块是其他两个模块的基础。 Classic模块扩展了core模块。 Classic模块相当于log4j的显著改进版。Logback-classic 直接实现了 SLF4J API。

要引入logback,由于Logback-classic依赖slf4j-api.jar和logback-core.jar,所以要把slf4j-api.jar、logback-core.jar、logback-classic.jar,添加到要引入Logbac日志管理的项目的class path中.

Logback的配置

Logger、Appender和 Layout

Logback建立于三个主要类之上:Logger、Appender 和 Layout。Logger类是logback-classic模块的一部分,而Appender和Layout接口来自logback-core。作为一个多用途模块,logback-core 不包含任何 logger。

Logger作为日志的记录器,把它关联到应用的对应的context上后,主要用于存放日志对象,也可以定义日志类型、级别。Appender主要用于指定日志输出的目的地,目的地可以是控制台、文件、远程套接字服务器、 MySQL、 PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。Layout 负责把事件转换成字符串,格式化的日志信息的输出。

Logger context

各个logger 都被关联到一个 LoggerContext,LoggerContext负责制造logger,也负责以树结构排列各 logger。

如果 logger的名称带上一个点号后是另外一个 logger的名称的前缀,那么,前者就被称为后者的祖先。如果 logger与其后代 logger之间没有其他祖先,那么,前者就被称为子logger 之父。比如,名为 "com.foo""的 logger 是名为"com.foo.Bar"之父。root logger 位于 logger 等级的最顶端,root logger 可以通过其名称取得,如下所示:

Logger rootLogger = LoggerFactory.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);

其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger 名称为参数。用同一名字调用LoggerFactory.getLogger 方法所得到的永远都是同一个logger对象的引用。

有效级别与级别继承

Logger 可以被分配级别。级别包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定义于 ch.qos.logback.classic.Level类。如果 logger没有被分配级别,那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。

打印方法与基本选择规则

打印方法决定记录请求的级别。例如,如果 L 是一个 logger 实例,那么,语句 L.info("..")是一条级别为 INFO 的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用,否则,称为被禁用。

记录请求级别为 p,其 logger的有效级别为 q, 只有则当 p>=q时, 该请求才会被执行。

该规则是 logback 的核心。级别排序为: TRACE < DEBUG < INFO < WARN < ERROR。

Logger、Appenders及layouts的关系

一个 logger 可以被关联多个 appender。 方法 addAppender() 为指定的 logger 添加一个 appender。 对于 logger 的每个启用了的记录请求,都将被发送到 logger 里的全部 appender 及更高等级的 appender。换句话说,appender叠加性地继承了 logger 的层次等级。

Logger L的记录语句的输出会发送给 L及其祖先的全部 appender。如果 logger L的某个祖先 P设置叠加性标识为 false,那么,L的输出会发送给L 与 P之间(含P)的所有 appender,但不会发送给P的任何祖先的appender。

Logger 的叠加性默认为 true。如果希望定制输出格式。这时为 appender 关联一个 layout 即可。Layout 负责根据用户意愿对记录请求进行格式化,appender 负责将格式化化后的输出发送到目的地。

例如,转换模式"%-4relative [%thread] %-5level %logger{32} - %msg%n"在 PatternLayout里会输出形如:

176 [main] DEBUG manual.architecture.HelloWorld2 - Hello world.

第一个字段是自程序启动以来的逝去时间,单位是毫秒。
第二个地段发出记录请求的线程。
第三个字段是记录请求的级别。
第四个字段是与记录请求关联的 logger 的名称。
"-"之后是请求的消息文字。

Logback的默认配置

如果配置文件 logback-test.xml 和 logback.xml 都不存在,那么 logback 默认地会调用BasicConfigurator ,创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root logger 默认级别是 DEBUG。
logback配置文件
Logback 配置文件的语法非常灵活。正因为灵活,所以无法用 DTD 或 XML schema 进行定义。尽管如此,可以这样描述配置文件的基本结构:以<configuration>开头,后面有零个或多个<appender>元素,有零个或多个<logger>元素,有最多一个<root>元素。
Logback默认配置的采用的步骤
1. 尝试在 classpath 下查找文件 logback-test.xml;

2. 如果文件不存在,则查找文件 logback.xml;

3. 如果两个文件都不存在,logback 用 Bas icConfigurator 自动对自己进行配置,这会导致记录输出到控制台。

假设配置文件 logback-test.xml 和 logback.xml 都不存在,那么 logback 默认地会调用BasicConfigurator ,创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。还有,根 logger 默认级别是 DEBUG。

自动打印警告和错误消息

当解析配置文件有警告或出错时,logback 会在控制台上自动打印状态数据。如果没有警告或错误,还是想检查 logback 的内部状态的话, 可以调用 StatusPrinter 的 print()方法。

对应的配置文件:
  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <configuration>  
  3.     <!--定义一个名为STDOUT的appender,并将其关联到ch.qos.logback.core.ConsoleAppender-->  
  4.     <appender name="STDOUT"  class="ch.qos.logback.core.ConsoleAppender">  
  5.         <!-- encoders 作用是将logger事件转换成字节数组,并将字节数组写入到输出流-->  
  6.         <encoder>  
  7.             <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->  
  8.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>  
  9.         </encoder>  
  10.     </appender>  
  11.     <root level="debug">    <!-- root logger,定义级别为debug-->  
  12.         <appender-ref ref="STDOUT" />    <!--将名为STDOUT的appender添加到root logger下-->  
  13.     </root>  
  14. </configuration>  
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <!--定义一个名为STDOUT的appender,并将其关联到ch.qos.logback.core.ConsoleAppender-->
    <appender name="STDOUT"  class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoders 作用是将logger事件转换成字节数组,并将字节数组写入到输出流-->
        <encoder>
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度 %msg:日志消息,%n是换行符-->
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <root level="debug">    <!-- root logger,定义级别为debug-->
        <appender-ref ref="STDOUT" />    <!--将名为STDOUT的appender添加到root logger下-->
    </root>
</configuration>

控制台输出结果如下:
…………
20:12:33,359 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback.groovy]
20:12:33,359 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback-test.xml]
20:12:33,359 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Found resource [logback.xml] at [file:/D:/Workspaces/MyEclipse%208.5/logback_test/WebRoot/WEB-INF/classes/logback.xml]
20:12:33,484 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - About to instantiate appender of type [ch.qos.logback.core.ConsoleAppender]
20:12:33,484 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - Naming appender as [STDOUT]
20:12:33,500 |-INFO in ch.qos.logback.core.joran.action.NestedComplexPropertyIA - Assuming default type [ch.qos.logback.classic.encoder.PatternLayoutEncoder] for [encoder] property
20:12:33,593 |-INFO in ch.qos.logback.classic.joran.action.RootLoggerAction - Setting level of ROOT logger to DEBUG
20:12:33,593 |-INFO in ch.qos.logback.core.joran.action.AppenderRefAction - Attaching appender named [STDOUT] to Logger[ROOT]
20:12:33,593 |-INFO in ch.qos.logback.classic.joran.action.ConfigurationAction - End of configuration.
20:12:33,593 |-INFO in ch.qos.logback.classic.joran.JoranConfigurator@cb6009 - Registering current configuration as safe fallback point
…………

Logback自定义配置

配置root logger

<root>元素配置根 logger。该元素有一个 level属性。没有 name 属性,因为已经被命名为"ROOT"。 Level 属性的值大小写无关,其值为下面其中一个字符串:TRACE、DEBUG、INFO、WARN、ERROR、ALL和 OFF。注意不能设置为"INHERITED" 或"NULL"。 <logger>元素可以包含零个或多个<appender-ref>元素。与<logger>元素类似,声明<root>元素后,会先关闭然后移除全部当前 appender,只引用声明了的 appender。如果 root 元素没有引用任何 appender,就会失去所有 appender。

假设我们不想看到"com.ttpod.file"包里的任何组件的任何 DEBUG 信息,可以设置如下:
  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <configuration>  
  3.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
  4.         <encoder>  
  5.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>  
  6.         </encoder>  
  7.     </appender>  
  8.     <!-- 设置configuration下的logger的级别为INFO,默认是继承root logger的debug级别 -->  
  9.     <logger name="chapters.configuration" level="INFO" />  
  10.     <!-- 严格来说, root logger 的level属性没有必要设置,因为 -->  
  11.     <!-- root logger的级别被默认设置为DEBUG -->  
  12.     <root level="DEBUG">  
  13.        <!--在root标签内没有引入chapters.configuration,所有在此包下不会显示任何组件的任何 DEBUG 信息 -->  
  14.        <appender-ref ref="STDOUT" />    <!-- 将appender引入到root logger -->  
  15.     </root>  
  16. </configuration>  
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 设置configuration下的logger的级别为INFO,默认是继承root logger的debug级别 -->
    <logger name="chapters.configuration" level="INFO" />
    <!-- 严格来说, root logger 的level属性没有必要设置,因为 -->
    <!-- root logger的级别被默认设置为DEBUG -->
    <root level="DEBUG">
       <!--在root标签内没有引入chapters.configuration,所有在此包下不会显示任何组件的任何 DEBUG 信息 -->
       <appender-ref ref="STDOUT" />    <!-- 将appender引入到root logger -->
    </root>
</configuration>

注意:由名为"chapters.configuration.Foo"的 logger 生成的 DEBUG 级别的信息都被屏蔽了.同样,也可以为任意数量的 logger 设置级别。

配置 Appenders

Appender 用<appender>元素配置,该元素必要属性 name 和 class。 name 属性指定 appender 的名称,class 属性指定 appender 类的全限定名。 <appender>元素可以包含零个或多个<layout>元素、零个或多个<encoder>元素和零个或多个<filter>元素。除了这三个常用元素之外,还可以包含 appender 类的任意数量的 javabean

属性。下图演示了常用结构,注意对 javabean 属性的支持在图中不可见。

记录输出到多个 appender 很简单,先定义各种 appender,然后在 logger 里进行引用,就行了。如下面的配置文件所示:
  1. <configuration>  
  2.     <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
  3.         <file>myApp.log</file>  
  4.         <!-- encoders are assigned by default the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->  
  5.         <encoder>  
  6.             <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>  
  7.         </encoder>  
  8.     </appender>  
  9.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
  10.         <encoder>  
  11.            <pattern>%msg%n</pattern>  
  12.        </encoder>  
  13.     </appender>  
  14.     <root level="debug">  
  15.         <appender-ref ref="FILE" />  
  16.         <appender-ref ref="STDOUT" />  
  17.     </root>  
  18. </configuration>  
<configuration>
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>myApp.log</file>
        <!-- encoders are assigned by default the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
        <encoder>
            <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
        </encoder>
    </appender>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
           <pattern>%msg%n</pattern>
       </encoder>
    </appender>
    <root level="debug">
        <appender-ref ref="FILE" />
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

该配置文件定义了两个 appender,分别是"FILE"和"STDOUT"。 "FILE" 这个 appender 把记录输 出到文件 "myapp.log " ,它的 encoder 是PatternLayoutEncoder,输出了日期、级别、线程名、logger 名、文件名及记录请求的行号、消息和行分隔符。 "STDOUT"这个 appender 把记录输出到控制台,它的 encoder 只是输出消息和行分隔符。 myApp.log文件内容如下:
2011-12-25 16:56:48,593 INFO [main] c.t.c.c.MyApp3 [MyApp3.java:48] Entering application.
2011-12-25 16:56:48,593 DEBUG [main] c.t.c.c.Foo [Foo.java:24] Did it again!
2011-12-25 16:56:48,593 INFO [main] c.t.c.c.MyApp3 [MyApp3.java:52] Exiting application.
    注意每个 appender 都有自己的 encoder。Encoder 通常不能被多个 appender 共享,layout也是。所以,logback 的配置文件里没有共享 encoder 或 layout 的语法。

Appender累积

默认情况下,appender 是可累积的:logger 会把记录输出到它自身的 appender 和它所有祖先的 appender。因此,把同一 appender 关联到多个 logger 会导致重复输出,如下面的配置文件会导致重复的输出:
  1. <configuration>  
  2.     <appender name="STDOUT"class="ch.qos.logback.core.ConsoleAppender">  
  3.         <encoder>  
  4.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>  
  5.         </encoder>  
  6.     </appender>  
  7.     <logger name="chapters.configuration">  
  8.         <appender-ref ref="STDOUT" />  
  9.     </logger>  
  10.     <root level="debug">  
  11.         <appender-ref ref="STDOUT" /> <!—这会导致重复输出-->  
  12.     </root>  
  13. </configuration>  
<configuration>
    <appender name="STDOUT"class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <logger name="chapters.configuration">
        <appender-ref ref="STDOUT" />
    </logger>
    <root level="debug">
        <appender-ref ref="STDOUT" /> <!—这会导致重复输出-->
    </root>
</configuration>

输出结果如下:
20:53:29.328 [main] INFO c.t.chapters.configuration.MyApp2 - Entering application.
20:53:29.328 [main] INFO c.t.chapters.configuration.MyApp2 - Entering application.
20:53:29.328 [main] DEBUG com.ttpod.chapters.configuration.Foo - Did it again!
20:53:29.328 [main] DEBUG com.ttpod.chapters.configuration.Foo - Did it again!
20:53:29.328 [main] INFO c.t.chapters.configuration.MyApp2 - Exiting application.
20:53:29.328 [main] INFO c.t.chapters.configuration.MyApp2 - Exiting application.

覆盖默认的累积行为

如果你觉得默认的累积行为不合适,可以设置叠加性标识为 false 以关闭它。 这样的话,logger 树里的某个分支可以输出到与其他 logger 不同的 appender。

示例:叠加性标识
  1. <configuration>  
  2.     …………  
  3.     <logger name="com.ttpod.chapters.configuration.Foo" additivity="false">  
  4.         <appender-ref ref="FILE" />  
  5.     </logger>  
  6.     <root level="debug">  
  7.         <appender-ref ref="STDOUT" />  
  8.     </root>  
  9. </configuration>  
<configuration>
    …………
    <logger name="com.ttpod.chapters.configuration.Foo" additivity="false">
        <appender-ref ref="FILE" />
    </logger>
    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

输出结果:
Entering application.
Exiting application.

此例中,logger"chapters.configuration.Foo"关联 appender"FILE",它的叠加性标记为false,这样它的记录输出仅会被发送到 appender"FILE",不会被发送到更高 logger 等级关联的 appender。其他 logger 不受此影响。 用 additivityFlag.xml 配置 MyApp3 , 运 行 后 , 控 制 台 上 由 输 出 由"chapters.configuration.MyApp3"产生的记录。而 logger" chapters.configuration.Foo"将且仅仅将输出到文件 foo.log。

Layout格式化输出日志

配置自定义 layout

配置自定义layout与配置其他layout是一样的。 FileAppender和其子类需要一个encoder。如链接中的例子:http://logback.qos.ch/xref/chapters/layouts/MySampleLayout.html

    此类中定义了一个处理格式的输出类,为了满足自定义的格式化的输出,把包裹了 MySampleLayout 的 LayoutWrappingEncoder 实例传递给FileAppender。下面是配置文件:
  1. <configuration debug="true">  
  2.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
  3.         <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">  
  4.             <!—自定义的格式化输出处理类-->  
  5.             <layout class="com.ttpod.chapters.layouts.MySampleLayout" />  
  6.         </encoder>  
  7.     </appender>  
  8.     <root level="DEBUG">  
  9.         <appender-ref ref="STDOUT" />  
  10.     </root>  
  11. </configuration>  
<configuration debug="true">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <!—自定义的格式化输出处理类-->
            <layout class="com.ttpod.chapters.layouts.MySampleLayout" />
        </encoder>
    </appender>
    <root level="DEBUG">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

输出结果如下:

250 DEBUG [main] com.ttpod.chapters.introduction.HelloWorld1 - Hello world.

layout转换符

它和C语言的printf方法非常类似。格式转换由普通字符和转换字符组合而成。转换字符由%开始,紧跟着的是可选的格式修饰符和转换字符标示。使用%前缀的表示符号将被转换到实际的内容。如name, level, date, thread name.可用的转换符有:

转换符

描述


调用日志事件的所在记录器的名字,如一个logger的名字是my.test.bbb.ccc,调用的是WARN级别的日志输出,那么输出的是输出my.test.bbb.ccc,可以在其右边指定了精度,如%c{2}那么输出的是bbb.ccc

调用日志事件的所在的类名,和c转换符一样,可以在右边指定宽度,如%C{2}输出%C{2}


日志调用所发生的时间,日期格式在其后跟着的大括号内的格式指定如%d{yyyy-MM-dd HH:mm:ss},我现在输出的结果是2011-07-11 21:05:22,推荐使用的是log4j本身提供的日期格式,如%d{ISO8601},%d{ABSOLUTE},%d{DATE}

所处所在文件名,如上面说C转换符的例子,输出结果是LayoutTest.java

是的日志事件发生的位置信息,这个和虚拟机的实现有点关系,一般境况下能得到类,方法,行数源文件等信息,

只是输出触发日志事件代码所在的行号,性能损耗会小很多。

显示应用给日志提供的其他信息,如消息。logger.warn("Message 2");那么%m将得到的是Message 2

输出调用者所在的方法名

换行,和\r \r\n有相同功能,能识别系统的换行符,自动转换成\r或者\r\n,log4j推荐使用这个转换符,而不是\r或者\r\n

输出调用的日志的级别,如我是调用logger.debug方法,那么级别就是debug

输出自应用启动后第一次调用logger的日志输出方法,到输出该log信息耗费的毫秒数

输出所在线程的名字

输出产生的日志事件的线程的NDC(嵌套诊断上下文)

输出与生成的日志事件的线程关联的MDC(映射诊断上下文)。X转换符括号之间放置了一个key,就像在%X {clientNumber}中的clientNumberkey 一样。在MDC correspondingvalue将被输出。

写上%%后将直接输出一个%符号

layout格式修饰符

如给定的一个格式:%-5p [%t]: %m%n中,并没有明确的分隔转换字符和普通文本的字符存在。PatternLayout能自己区分普通文本和转换字符。其中%-5p是日志的调用级别。事件是左对齐的,5个字符宽度。

格式修饰符,放在%和转换符之间。 第一个可选的格式修饰符是左对齐(-);第二个可选的格式修饰符是字段最小宽度。一个整数。表示输出的最小字符数。如果数据未达到指定最小大小,那么它将以左填充(默认)或者右填充方式(左对齐情况下只能使用右填充了)。用空格填充,直到达到最小宽度。如果大于指定最小宽度,不会被截断 。当然可以指定最大字符数,使用.符号加数字表示最大字符数。如果大于指定长度,多余的字符会被删除。它是从前面删除,而不是从后面删除的。如最大字符是8个,数据有10个字符,那么前面两个字符会被删除。 

%20c 右对齐,最少20字符,没有左边用空格填充 

%-20c 左对齐,最少20字符,没有右边用空格填充 

%.30c 右对齐,最多30字符,超过左边的截取掉 

%20.30c 右对齐,最少20字符,最多30字符,填充或截取规则略

%-20.30c 左对齐,最少20字符,最多30字符,填充或截取规则略 

在程序里启用logback记录

三个必须步骤:
1. 配置 logback 环境。
2. 在每个需要执行记录的类里,调用 org.slf4j.LoggerFactory 类的 getLogger()方法获
取一个 Logger 实例,以当前类名或类本身作为参数。
3. 调用取得的 logger 实例的打印方法,即 debug()、info()、warn()和 error(),把记录
输出到配置里的各 appender。
直接调用JoranConfigurator
Logback 依赖Joran,Joran是 logback-core 的一部分,是个配置类库。Logback 的默认配置机制是调用JoranConfigurator对classpath上的默认配置文件进行处理。 不管出于什么理由,如果你想重新实现 logback 的默认配置机制的话,你可以直接调用 JoranConfigurator。下面程序 MyApp1 就调用了 JoranConfigurator 对作为参数传入的配置文件进行处理。


此程序通过参数传配置文件的名字,对程序的日志输出配置,本例如下:

  1. <configuration>  
  2.     <!-- 指定属性文件路径 -->  
  3.     <property file="src/com/ttpod/file/variables.properties" />  
  4.     <!-- 指定日志输出到文件-->  
  5.     <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
  6.       <file>${destination}</file>  
  7.       <encoder>  
  8.       <!-- %msg表示日志信息,%n表示换行 -->  
  9.         <pattern>%msg%n</pattern>  
  10.       </encoder>  
  11.     </appender>  
  12.     <root level="debug">  
  13.       <appender-ref ref="FILE" /><!—添加到根logger-->  
  14.     </root>  
  15. </configuration>  
<configuration>
    <!-- 指定属性文件路径 -->
    <property file="src/com/ttpod/file/variables.properties" />
    <!-- 指定日志输出到文件-->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
      <file>${destination}</file>
      <encoder>
      <!-- %msg表示日志信息,%n表示换行 -->
        <pattern>%msg%n</pattern>
      </encoder>
    </appender>
    <root level="debug">
      <appender-ref ref="FILE" /><!—添加到根logger-->
    </root>
</configuration>

对应的properties文件,嵌套的设置了日志文件的输出路径及文件名,如下:

#指定USER_HOME目录
USER_HOME=./log
#指定日志文件名
fileName=myApp.log
#生成日志文件的目的地
destination=${USER_HOME}/${fileName}
配置好后,右键MyApp3 -> run as… -> run configurations -> 选择MyApp3,及arguments ->

配置program Aguments:src/com/ttpod/MyApp1Config.xml,以指定配置文件,然后运行即可,即可在当前就应用的/log文件夹下生成myApp.log ,输出如下:
Entering application.demo class Foo >>>
test logger in other class!
Exiting application. demo class Foo <<<

运用滚动策略与触发策略

RollingFileAppender 继承 FileAppender,能够滚动记录文件。例如,RollingFileAppender能先记录到文件"log.txt",然后当符合某个条件时,变成记录到其他文件。 RollingFileAppender 有两个与之互动的重要子组件。第一个是RollingPolicy,负责滚动。第二个是 TriggeringPolicy,决定是否以及何时进行滚动。所以,RollingPolicy 负责"什么", TriggeringPolicy 负责"何时"。

要想 RollingFileAppender 起作用,必须同时设置 RollingPolicy 和 TriggeringPolicy。不过,如果 RollingPolicy 也实现了 TriggeringPolicy 接口,那么只需要设置 RollingPolicy。

// 没有自定义它的logback所需的配置文件,程序启动时会自动加载classpath目录下的查找

// logback-test.xml;如果没找到则logback-test.xml,则继续在classpath下查找lobback.xml。

此测试类,在定时器中定义了一个执行计划,按照执行计划生成日志文件。在file包中添加相的logback配置文件,如下:

  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <configuration>  
  3.     <jmxConfigurator />  
  4.     <!-- 配置文件路径 -->  
  5.     <property file="src/com/ttpod/file/variables.properties" />  
  6.     <!--logback的版本必须是0.9.21以上才支持-->  
  7.     <timestamp key="byDay" datePattern="yyyyMMdd"/>  
  8.     <!-- 控制台输出日志 -->  
  9.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
  10.         <layout class="ch.qos.logback.classic.PatternLayout">  
  11.            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>  
  12.         </layout>  
  13.     </appender>  
  14.     <!-- 文件输出日志 (文件大小策略进行文件输出,超过指定大小对文件压缩(.zip)备份)-->  
  15.     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">  
  16.         <!-- 文件的路径及文件名 -->  
  17.         <File>${USER_HOME}/SystemOut.log</File>  
  18.         <!-- 定义窗口滚动策略 -->  
  19.         <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">  
  20.             <!-- 每触发一次,自动压缩日志文件,%i在1-3之间循环变化 -->  
  21.             <FileNamePattern>${USER_HOME}/SystemOut_%i.log.zip</FileNamePattern>  
  22.             <MinIndex>1</MinIndex> <!-- %i的最小值为1-->  
  23.             <MaxIndex>3</MaxIndex> <!-- %i的最大值为3-->  
  24.         </rollingPolicy>  
  25.         <!-- 触发策略,通常rollingPolicy与triggeringPolicy联合使用 -->  
  26.         <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">  
  27.             <MaxFileSize>10KB</MaxFileSize>  
  28.         </triggeringPolicy>  
  29.         <!-- 格式化输出 -->  
  30.         <!-- %d表示日期,格式为:yyyy-MM-dd HH:mm:ss.SSS ;%thread:线程名;%-5level:从左边以5个字符的宽度显示级别; %logger:显示logger名;%msg:日志消息;%n:换行   
  31.         <layout class="ch.qos.logback.classic.PatternLayout">  
  32.             <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>  
  33.         </layout>  
  34.         -->  
  35.         <!-- 或者用下面的形式格式(推荐)-->  
  36.         <encoder>  
  37.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%relative%thread%mdc%level%logger%msg</pattern>  
  38.         </encoder>  
  39.         <!-- 以html文件输出 -->  
  40.         <!--  
  41.         <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">  
  42.             <layout class="ch.qos.logback.classic.html.HTMLLayout">  
  43.                 <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%relative%thread%mdc%level%logger%msg</pattern>  
  44.             </layout>  
  45.         </encoder>  
  46.        -->  
  47.     </appender>  
  48.     <!-- 输出ERROR级别的日志到文件(同样采用文件大小策略进行文件输出,超过指定大小对文件压缩(.zip)备份) -->  
  49.     <appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">  
  50.         <filter class="ch.qos.logback.classic.filter.LevelFilter">  
  51.             <level>ERROR</level> <!-- 指定要对级别为ERROR日志信息过滤 -->  
  52.             <OnMismatch>DENY</OnMismatch>     <!-- 如果不匹配,则拒绝处理 -->  
  53.             <OnMatch>ACCEPT</OnMatch>         <!-- 如果匹配,则立即处理 -->  
  54.         </filter>  
  55.         <File>${USER_HOME}/SystemErr.log</File> <!-- 文件名即路径 -->  
  56.         <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">  
  57.             <FileNamePattern>${USER_HOME}/SystemErr_%i.log.zip</FileNamePattern>  
  58.             <MinIndex>1</MinIndex>  
  59.             <MaxIndex>3</MaxIndex>  
  60.         </rollingPolicy>  
  61.         <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">  
  62.             <MaxFileSize>10KB</MaxFileSize>  
  63.         </triggeringPolicy>  
  64.         <!-- 格式化输出 -->  
  65.         <!--  
  66.         <layout class="ch.qos.logback.classic.PatternLayout">  
  67.             <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>  
  68.         </layout>  
  69.         -->  
  70.         <encoder>  
  71.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%relative%thread%mdc%level%logger%msg</pattern>  
  72.         </encoder>  
  73.     </appender>  
  74.     <!--这里指定logger name 是为jmx设置日志级别做铺垫 -->  
  75.     <!-- 分别将STDOUT与FILE appender都添加到自定义的logger中,否则将不会输出到appender指定的 目的地-->  
  76.     <logger name="SystemOut" level="INFO">  
  77.         <appender-ref ref="STDOUT" />  
  78.         <appender-ref ref="FILE" />  
  79.     </logger>  
  80.     <logger name="SystemErr" level="INFO">  
  81.         <appender-ref ref="STDOUT" />  
  82.         <appender-ref ref="FILE-ERROR" />  
  83.     </logger>  
  84. </configuration>  
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <jmxConfigurator />
    <!-- 配置文件路径 -->
    <property file="src/com/ttpod/file/variables.properties" />
    <!--logback的版本必须是0.9.21以上才支持-->
    <timestamp key="byDay" datePattern="yyyyMMdd"/>
    <!-- 控制台输出日志 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
           <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </layout>
    </appender>
    <!-- 文件输出日志 (文件大小策略进行文件输出,超过指定大小对文件压缩(.zip)备份)-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 文件的路径及文件名 -->
        <File>${USER_HOME}/SystemOut.log</File>
        <!-- 定义窗口滚动策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <!-- 每触发一次,自动压缩日志文件,%i在1-3之间循环变化 -->
            <FileNamePattern>${USER_HOME}/SystemOut_%i.log.zip</FileNamePattern>
            <MinIndex>1</MinIndex> <!-- %i的最小值为1-->
            <MaxIndex>3</MaxIndex> <!-- %i的最大值为3-->
        </rollingPolicy>
        <!-- 触发策略,通常rollingPolicy与triggeringPolicy联合使用 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10KB</MaxFileSize>
        </triggeringPolicy>
        <!-- 格式化输出 -->
        <!-- %d表示日期,格式为:yyyy-MM-dd HH:mm:ss.SSS ;%thread:线程名;%-5level:从左边以5个字符的宽度显示级别; %logger:显示logger名;%msg:日志消息;%n:换行 
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
        </layout>
        -->
        <!-- 或者用下面的形式格式(推荐)-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%relative%thread%mdc%level%logger%msg</pattern>
        </encoder>
        <!-- 以html文件输出 -->
        <!--
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="ch.qos.logback.classic.html.HTMLLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%relative%thread%mdc%level%logger%msg</pattern>
            </layout>
        </encoder>
       -->
    </appender>
    <!-- 输出ERROR级别的日志到文件(同样采用文件大小策略进行文件输出,超过指定大小对文件压缩(.zip)备份) -->
    <appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level> <!-- 指定要对级别为ERROR日志信息过滤 -->
            <OnMismatch>DENY</OnMismatch>     <!-- 如果不匹配,则拒绝处理 -->
            <OnMatch>ACCEPT</OnMatch>         <!-- 如果匹配,则立即处理 -->
        </filter>
        <File>${USER_HOME}/SystemErr.log</File> <!-- 文件名即路径 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <FileNamePattern>${USER_HOME}/SystemErr_%i.log.zip</FileNamePattern>
            <MinIndex>1</MinIndex>
            <MaxIndex>3</MaxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10KB</MaxFileSize>
        </triggeringPolicy>
        <!-- 格式化输出 -->
        <!--
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
        </layout>
        -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%relative%thread%mdc%level%logger%msg</pattern>
        </encoder>
    </appender>
    <!--这里指定logger name 是为jmx设置日志级别做铺垫 -->
    <!-- 分别将STDOUT与FILE appender都添加到自定义的logger中,否则将不会输出到appender指定的 目的地-->
    <logger name="SystemOut" level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </logger>
    <logger name="SystemErr" level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE-ERROR" />
    </logger>
</configuration>

执行以上程序,在控制台也会不断的输出以下日志信息:

14:42:34.875 [Timer-0] INFO SystemOut - 测试Logback日志的使用
14:42:34.875 [Timer-0] ERROR SystemErr - 发生错误
14:42:34.937 [Timer-0] INFO SystemOut - 测试Logback日志的使用
14:42:34.937 [Timer-0] ERROR SystemErr - 发生错误
14:42:35.000 [Timer-0] INFO SystemOut - 测试Logback日志的使用
14:42:35.000 [Timer-0] ERROR SystemErr - 发生错误
14:42:35.062 [Timer-0] INFO SystemOut - 测试Logback日志的使用
14:42:35.062 [Timer-0] ERROR SystemErr - 发生错误

生成的日志文件如下图:

FixedWindowRollingPolicy当发生滚动时,FixedWindowRollingPolicy 根据如下固定窗口(window)算法重命名文件。 选项"fileNamePattern"代表归档(滚动)记录文件的文件名模式。该选项是必需的,且必需在模式的某处包含标志"%i"。如示例3中的MyApp3-RollingFixedWindow.xml 。

TimeBasedRollingPolicy 或许是最受流行的滚动策略。它根据时间来制定滚动策略,例如根据日或月。TimeBasedRollingPolicy 既负责滚动也负责触发滚动。实际上,TimeBasedRollingPolicy 同时实现了 RollingPolicy 接口和 TriggeringPolicy 接口。和 FixedWindowRollingPolicy一样,TimeBasedRollingPolicy 也支持自动压缩文件。如果"fileNamePattern"选项以".gz"或".zip"结尾,就表示需要压缩。如示例3中的MyApp3-RollingTimeBased.xml 。


SizeAndTimeBasedFNATP按照日期进行归档的同时限制每个记录文件的大小,特别是当后处理工具对记录文件大小有限制时。Logback 为此提供了 SizeAndTimeBasedFNATP ,它是TimeBasedRollingPolicy 的子组件,FNATP 代表"FNATP stands for File Naming And Triggering Policy"。 下面的例子MyApp3-sizeAndTime.xml演示了基于大小和时间的记录文件归档。
配置文件:
  1. <configuration>  
  2.     <!-- 指定属性文件路径 -->  
  3.     <property file="src/com/ttpod/file/variables.properties" />  
  4.     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">  
  5.         <file>${USER_HOME}/testFile.log</file>  
  6.         <!--滚动策略-->  
  7.         <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">  
  8.             <!—自动压缩备份-->  
  9.             <fileNamePattern>${USER_HOME}/testFile.%i.log.zip</fileNamePattern>  
  10.             <minIndex>1</minIndex>  
  11.             <maxIndex>3</maxIndex><!--%i在1-3之间循环变化-->  
  12.         </rollingPolicy>  
  13.        <!—触发策略-->  
  14.        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">  
  15.             <!--日志文件大小限制在5kB以内,否则就触发滚动-->  
  16.             <maxFileSize>5kB</maxFileSize>  
  17.         </triggeringPolicy>  
  18.         <encoder><!--格式化输出-->  
  19.             <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
  20.         </encoder>  
  21.     </appender>  
  22.    <root level="DEBUG">  
  23.        <appender-ref ref="FILE" />  
  24.    </root>  
  25. </configuration>  
<configuration>
    <!-- 指定属性文件路径 -->
    <property file="src/com/ttpod/file/variables.properties" />
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${USER_HOME}/testFile.log</file>
        <!--滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <!—自动压缩备份-->
            <fileNamePattern>${USER_HOME}/testFile.%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex><!--%i在1-3之间循环变化-->
        </rollingPolicy>
       <!—触发策略-->
       <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <!--日志文件大小限制在5kB以内,否则就触发滚动-->
            <maxFileSize>5kB</maxFileSize>
        </triggeringPolicy>
        <encoder><!--格式化输出-->
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>
   <root level="DEBUG">
       <appender-ref ref="FILE" />
   </root>
</configuration>

多次运行MyApp3,logback配置参数传入MyApp3-RollingFixedWindow.xml,即可发现在当前应用的log目录下生成了如:testFile.1.log.zip、testFile.2.log.zip、testFile.3.log.zip,testFile.log文件。备份的压缩文件中的日志文件的文件名默认后缀跟了归档日期,如下图:

  1. <configuration>  
  2.     <!-- 指定属性文件路径 -->  
  3.     <property file="src/com/ttpod/file/variables.properties" />  
  4.     <!-- 基于时间的滚动策略 -->  
  5.     <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">  
  6.         <file>${USER_HOME}/logFile.log</file>  
  7.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
  8.             <!-- 每天滚动<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>-->  
  9.             <!-- 每分钟滚动 -->  
  10.             <fileNamePattern>${USER_HOME}/logFile.%d{yyyy-MM-dd_HH-mm}.log</fileNamePattern>  
  11.             <!-- 限制文件最大保存时间为30天-->  
  12.             <maxHistory>30</maxHistory>  
  13.         </rollingPolicy>  
  14.         <encoder>  
  15.             <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
  16.         </encoder>  
  17.     </appender>  
  18.     <root level="DEBUG">  
  19.         <appender-ref ref="FILE" />  
  20.     </root>  
  21. </configuration>  
<configuration>
    <!-- 指定属性文件路径 -->
    <property file="src/com/ttpod/file/variables.properties" />
    <!-- 基于时间的滚动策略 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${USER_HOME}/logFile.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天滚动<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>-->
            <!-- 每分钟滚动 -->
            <fileNamePattern>${USER_HOME}/logFile.%d{yyyy-MM-dd_HH-mm}.log</fileNamePattern>
            <!-- 限制文件最大保存时间为30天-->
            <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>

< !--
运行:
java chapters.appenders.ConfigurationTester
src/com/ttpod/chapters/appenders/conf/logback-RollingTimeBased.xml
-->

多次运行MyApp3,logback配置参数传入MyApp3-RollingTimeBased.xml,若设置一个执行计谋,程序不停止,则每分钟可触发一次日志备份,即可发现在当前应用的log目录下生成了按配置的格式的文件,如:
  1. <configuration>  
  2.     <!-- 基于时间与大小的归档 -->  
  3.     <statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener" />  
  4.     <!-- 指定属性文件路径 -->  
  5.     <property file="src/com/ttpod/file/variables.properties" />  
  6.     <!-- 基于时间与大小的归档 -->  
  7.     <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">  
  8.         <file>${USER_HOME}/mylog.txt</file>  
  9.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
  10.             <!-- 每天滚动<fileNamePattern>${USER_HOME}/mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>-->  
  11.             <minIndex>1</minIndex>  
  12.             <maxIndex>3</maxIndex>  
  13.             <!-- 每分钟滚动 -->  
  14.             <fileNamePattern>${USER_HOME}/mylog-%d{yyyy-MM-dd_HH-mm}.%i.txt</fileNamePattern>  
  15.             <!-- 限制文件最大保存时间为30天-->  
  16.             <maxHistory>30</maxHistory>  
  17.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">  
  18.                <!-- 当文件大小超过5kB时触发滚动,这里设置5kb只是便于测试 -->  
  19.                <maxFileSize>5kB</maxFileSize>  
  20.             </timeBasedFileNamingAndTriggeringPolicy>  
  21.         </rollingPolicy>  
  22.         <encoder>  
  23.             <pattern>%msg%n</pattern>  
  24.         </encoder>  
  25.     </appender>  
  26.     <root level="debug">  
  27.         <appender-ref ref="ROLLING" />  
  28.     </root>  
  29. </configuration>  
<configuration>
    <!-- 基于时间与大小的归档 -->
    <statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener" />
    <!-- 指定属性文件路径 -->
    <property file="src/com/ttpod/file/variables.properties" />
    <!-- 基于时间与大小的归档 -->
    <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${USER_HOME}/mylog.txt</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天滚动<fileNamePattern>${USER_HOME}/mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>-->
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
            <!-- 每分钟滚动 -->
            <fileNamePattern>${USER_HOME}/mylog-%d{yyyy-MM-dd_HH-mm}.%i.txt</fileNamePattern>
            <!-- 限制文件最大保存时间为30天-->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
               <!-- 当文件大小超过5kB时触发滚动,这里设置5kb只是便于测试 -->
               <maxFileSize>5kB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>%msg%n</pattern>
        </encoder>
    </appender>
    <root level="debug">
        <appender-ref ref="ROLLING" />
    </root>
</configuration>

运行时,logback配置参数传入src/com/ttpod/file/MyApp3-sizeAndTime.xml即可。当日志文件超过5kB时,或到另一天时,程序又被执行了,则会触发滚动,按照此前配置规则备原来的文件。输出的文件如下图所示:


以网页形式输出日志文件

HTMLLayout 与 logback-classic 里的 HTMLLayout 相似。 默认情况下,PatternLayout 创建包含下列数据的表格:远程IP;日期;请求的URL;状态吗;Content Length 。

用以下配置文件格式化输出到properties文件指向的目的地。

  1. <configuration>  
  2.     <!-- 指定属性文件路径 -->  
  3.     <property file="src/com/ttpod/html/variables.properties" />  
  4.     <!-- 指定日志输出到文件-->  
  5.     <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
  6.         <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">  
  7.             <layout class="ch.qos.logback.classic.html.HTMLLayout">  
  8.                 <pattern>%relative%thread%mdc%level%logger%msg</pattern>  
  9.             </layout>  
  10.         </encoder>  
  11.         <file>${destination}</file>  
  12.     </appender>  
  13.     <root level="DEBUG">  
  14.         <appender-ref ref="FILE" />  
  15.     </root>  
  16. </configuration>  
<configuration>
    <!-- 指定属性文件路径 -->
    <property file="src/com/ttpod/html/variables.properties" />
    <!-- 指定日志输出到文件-->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="ch.qos.logback.classic.html.HTMLLayout">
                <pattern>%relative%thread%mdc%level%logger%msg</pattern>
            </layout>
        </encoder>
        <file>${destination}</file>
    </appender>
    <root level="DEBUG">
        <appender-ref ref="FILE" />
    </root>
</configuration>
<!-- 以以下方式运行
java com.ttpod.html.HtmlTest1 src/com/ttpod/html/htmlLayoutConfig1.xml
-->

属性文件内容如下:
(com/ttpod/html/ variables.properties)
#指定USER_HOME目录
USER_HOME=./log
#指定日志文件名
fileName=htmlTest.htm
#生成日志文件的目的地
destination=${USER_HOME}/${fileName}
运行html/HTMLTest1,并传入配置参数:src/com/ttpod/html/htmlLayoutConfig1.xml,可以发现在在当前应用的/log目录下生成一个htmlTest.htm日志文件。输出日志结果如下图:

以邮件形式输出日志

    以邮件形式输出日志,依赖于SMTPAppender ,SMTPAppender在固定大小的缓冲里积累记录时间,当用户指定的事件发生后,就通过email发出这些事件。默认情况下,email发送是由级别为 ERROR 或更高级别的记录事件触发的。

    下面的演示程序 chapters.appenders.mail.EMail,生成大量记录消息,然后生成一个错误消息。该程序有两个参数,第一个是需要生成的记录消息的数量,第二个是 logback 配置文件。该程序生成的最后一条记录事件,即 ERROR 级别的事件,将触发 email的发送。

如下配置文件从属性文件中读取发送邮件定义的属性,配置由邮件输出日志,如下:
  1. <configuration>  
  2.     <!-- 指定属性文件的位置 -->  
  3.     <property file="src/com/ttpod/mail/gmailSSL.properties" />  
  4.     <!-- 目的指定向email的appender -->  
  5.     <appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">  
  6.         <SMTPHost>${SMTPHOST}</SMTPHost><!-- 邮件服务器地址 -->  
  7.         <SMTPPort>${SMTPPORT}</SMTPPort><!--SMTPPORT端口-->  
  8.         <SSL>true</SSL>  
  9.         <Username>${EMAIL_USERNAME}</Username><!-- 用户名 -->  
  10.         <Password>${EMAIL_PASSWORD}</Password><!-- 密码 -->  
  11.         <To>${EMAIL-DESTINATION}</To><!-- 目标接收人 -->  
  12.         <To>${ANOTHER_EMAIL_DESTINATION}</To> <!-- additional destinations are possible -->  
  13.         <From>${EMAIL_USERNAME}</From><!-- 发件人 -->  
  14.         <Subject>TESTING: %logger{20} - %m</Subject><!-- 主题 -->  
  15.         <encoder><!-- 一般采用这种方式格式化输出 -->  
  16.             <layout class="ch.qos.logback.classic.html.HTMLLayout">  
  17.                 <!-- 采用什么渲染方式,这采取的是HTML方式 -->  
  18.                 <Pattern>%date %-5level %logger - %message%n</Pattern>  
  19.             </layout>  
  20.         </encoder>  
  21.         <!--  
  22.         <layout class="ch.qos.logback.classic.PatternLayout">  
  23.             <Pattern>%date %-5level %logger - %message%n</Pattern>  
  24.         </layout>  
  25.         -->  
  26.     </appender>  
  27.     <!-- 输出到控制台,以便将日志也打印到控制台-->  
  28.     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
  29.         <encoder>  
  30.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>  
  31.         </encoder>  
  32.     </appender>  
  33.     <!-- 输出到文件,将日志记录到本地文件-->  
  34.     <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
  35.          <file>./log/mailtest.log</file>  
  36.          <encoder>  
  37.              <!-- %msg表示日志信息,%n表示换行 -->  
  38.              <pattern>%msg%n</pattern>  
  39.          </encoder>  
  40.     </appender>  
  41.     <root level="debug">  
  42.         <appender-ref ref="EMAIL" />  
  43.         <appender-ref ref="STDOUT" />  
  44.         <appender-ref ref="FILE"></appender-ref>  
  45.     </root>  
  46. </configuration>  
<configuration>
    <!-- 指定属性文件的位置 -->
    <property file="src/com/ttpod/mail/gmailSSL.properties" />
    <!-- 目的指定向email的appender -->
    <appender name="EMAIL" class="ch.qos.logback.classic.net.SMTPAppender">
        <SMTPHost>${SMTPHOST}</SMTPHost><!-- 邮件服务器地址 -->
        <SMTPPort>${SMTPPORT}</SMTPPort><!--SMTPPORT端口-->
        <SSL>true</SSL>
        <Username>${EMAIL_USERNAME}</Username><!-- 用户名 -->
        <Password>${EMAIL_PASSWORD}</Password><!-- 密码 -->
        <To>${EMAIL-DESTINATION}</To><!-- 目标接收人 -->
        <To>${ANOTHER_EMAIL_DESTINATION}</To> <!-- additional destinations are possible -->
        <From>${EMAIL_USERNAME}</From><!-- 发件人 -->
        <Subject>TESTING: %logger{20} - %m</Subject><!-- 主题 -->
        <encoder><!-- 一般采用这种方式格式化输出 -->
            <layout class="ch.qos.logback.classic.html.HTMLLayout">
                <!-- 采用什么渲染方式,这采取的是HTML方式 -->
                <Pattern>%date %-5level %logger - %message%n</Pattern>
            </layout>
        </encoder>
        <!--
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%date %-5level %logger - %message%n</Pattern>
        </layout>
        -->
    </appender>
    <!-- 输出到控制台,以便将日志也打印到控制台-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 输出到文件,将日志记录到本地文件-->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
         <file>./log/mailtest.log</file>
         <encoder>
             <!-- %msg表示日志信息,%n表示换行 -->
             <pattern>%msg%n</pattern>
         </encoder>
    </appender>
    <root level="debug">
        <appender-ref ref="EMAIL" />
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE"></appender-ref>
    </root>
</configuration>

属性文件如下设置,以供自定的logback配置文件读取。

SMTPHOST=smtp.gmail.com
SMTPPORT=465
EMAIL_USERNAME = someone123@gmail.com
EMAIL_PASSWORD = password123
EMAIL-DESTINATION = someone456@ttpod.com
ANOTHER_EMAIL_DESTINATION = some456@126.com

传入配置文件参数,运行,当出现也error级别以及以上级别的日志时,就会触发日志发送到邮件,但目前此测试例子,可能由于本地tomcat服务器缓存邮件,以致邮件无法发送到外网服务器,所以在这里没给出具体发送成功的结果。但可以通过它生成对应的HTML文件,可以看到邮件内容,如下图:

    如果未指定选项"Evaluator",则 SMTPAppender 被默认分配一个 OnErrorEveluator(ch.qos.logback.classic.boolex.OnErrorEvaluator)实例,当遇到级别为 ERROR 或更高级别

的事件后,触发 email 传输。此处最后一条消息是一个error级别的记录,触发了邮件的发送。

另外,还可以将日志写入数据库要把记录事件写入数据库,依赖于DBAppender ,DBAppender把记录事件写入数据库的三张表。三张表分别是 logging_event、logging_event_property 和 logging_event_exception。在使用 DBAppender 之前,这三张表必须已经被创建。关于将日志记录写入到数据库中,更多可参考logback手册中的DBAppender。
展开阅读全文

没有更多推荐了,返回首页