logback使用笔记

195 阅读5分钟

logback 的使用和 logback.xml 详解

一、logback 的介绍
官方网站: logback.qos.ch。它当前分为下面下个模块
logback-core:其它两个模块的基础模块
logback-classic:它是 log4j 的一个改良版本,同时它完整实现了 slf4j API 使你可以很方便地更换成其它日志系统如 log4j 或 JDK14 Logging logback-access:访问模块与 Servlet 容器集成提供通过 Http 来访问日志的功能 二、logback 取代 log4j 的理由:
更快的实现:Logback 的内核重写了,在一些关键执行路径上性能提升 10 倍以上。而且 logback 不仅性能提升了,初始化内存加载也更小了。 非常充分的测试:Logback 经过了几年,数不清小时的测试。Logback 的测试完全不同级别的。

Logback-classic 非常自然实现了 SLF4j:Logback-classic 实现了 SLF4j。在使用 SLF4j 中,你都感觉不到 logback-classic。而且因为 logback-classic 非常自然地实现了 slf4j , 所 以切换到 log4j 或者其他,非常容易,只需要提供成另一个 jar 包就 OK,根本不需要去动那些通过 SLF4JAPI 实现的代码。

三、logback 的配置介绍

Logger、appender 及 layout

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

  各个 logger 都被关联到一个 LoggerContext,LoggerContext 负责制造 logger,也负责以树结构排列各 logger。其他所有 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 四、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 进行定义。尽管如此,可以这样描述配置文件的基本结构:以 开头,后面有零个或多个 < appender > 元素,有零个或多个 < logger > 元素,有最多一个 < root > 元素。 Logback 默认配置的步骤 尝试在 classpath 下查找文件 logback-test.xml; 如果文件不存在,则查找文件 logback.xml; 如果两个文件都不存在,logback 用 BasicConfigurator 自动对自己进行配置,这会导致记录输出到控制台。 五、logback.xml 常用配置详解

(1) 根节点 < configuration>,包含下面三个属性:     scan: 当此属性设置为 true 时,配置文件如果发生改变,将会被重新加载,默认值为 true。     scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当 scan 为 true 时,此属性生效。默认的时间间隔为 1 分钟。     debug: 当此属性设置为 true 时,将打印出 logback 内部日志信息,实时查看 logback 运行状态。默认值为 false。   例如:      (2) 子节点 < contextName>:用来设置上下文名称,每个 logger 都关联到 logger 上下文,默认上下文名称为 default。但可以使用 < contextName > 设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。   例如: myAppName   
(3) 子节点 < property> :用来定义变量值,它有两个属性 name 和 value,通过 < property > 定义的值会被插入到 logger 上下文中,可以使 “${}” 来使用变量。     name: 变量的名称     value: 的值时变量定义的值   例如:

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
&emsp;&emsp;&emsp;<property name="APP_Name" value="myAppName" /> 
&emsp;&emsp;&emsp;<contextName>${APP_Name}</contextName> 
&emsp;&emsp;&emsp;<!--其他配置省略--> 
</configuration>

(4) 子节点 < timestamp>:获取时间戳字符串,他有两个属性 key 和 datePattern     key: 标识此 的名字;     datePattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循 java.txt.SimpleDateFormat 的格式。   例如:

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
&emsp;&emsp;<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> 
&emsp;&emsp;<contextName>${bySecond}</contextName> 
&emsp;&emsp;<!-- 其他配置省略--> 
</configuration>

(5) 子节点 < appender>:负责写日志的组件,它有两个必要属性 name 和 class。name 指定 appender 名称,class 指定 appender 的全限定名     5.1、ConsoleAppender 把日志输出到控制台,有以下子节点:       :对日志进行格式化。(具体参数稍后讲解 )       :字符串 System.out(默认) 或者 System.err(区别不多说了) 例如:

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

&emsp;&emsp;&emsp;<root level="DEBUG"> 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<appender-ref ref="STDOUT" /> 
&emsp;&emsp;&emsp;</root> 
</configuration>

上述配置表示把 >=DEBUG 级别的日志都输出到控制台     5.2、FileAppender:把日志添加到文件,有以下子节点:       :被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。       :如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是 true。       :对记录事件进行格式化。(具体参数稍后讲解 )       :如果是 true,日志会被安全的写入文件,即使其他的 FileAppender 也在向此文件做写入操作,效率低,默认是 false。     例如:

<configuration> 
&emsp;&emsp;<appender name="FILE" class="ch.qos.logback.core.FileAppender"> 
&emsp;&emsp;&emsp;&emsp;<file>testFile.log</file> 
&emsp;&emsp;&emsp;&emsp;<append>true</append> 
&emsp;&emsp;&emsp;&emsp;<encoder> 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
&emsp;&emsp;&emsp;&emsp;</encoder> 
&emsp;&emsp;</appender> 

&emsp;&emsp;<root level="DEBUG"> 
&emsp;&emsp;&emsp;&emsp;<appender-ref ref="FILE" /> 
&emsp;&emsp;</root> 
</configuration>

上述配置表示把 >=DEBUG 级别的日志都输出到 testFile.log     5.3、RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:       :被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。       :如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是 true。       : 当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。属性 class 定义具体的滚动策略类       class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:         :必要节点,包含文件名及 “%d” 转换符,“%d”可以包含一个 java.text.SimpleDateFormat 指定的时间格式,如:%d{yyyy-MM}。 如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender 的 file 字节点可有可无,通过设置 file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到 file 指定的文件(活动文件),活动文件的名字不会改变; 如果没设置 file,活动文件的名字会根据 fileNamePattern 的值,每隔一段时间改变一次。“/”或者 “\” 会被当做目录分隔符。         : 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且 是 6,则只保存最近 6 个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。

      

class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy":
``` 查看当前活动文件的大小,如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只有一个节点:
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<maxFileSize>: 这是活动文件的大小,默认值是 10MB。
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<prudent>:当为 true 时,不支持 FixedWindowRollingPolicy。支持 TimeBasedRollingPolicy,但是有两个限制,1 不支持也不允许文件压缩,2 不能设置 file 属性,必须留空。

&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<triggeringPolicy>: 告知 RollingFileAppender 合适激活滚动。
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<minIndex>: 窗口索引最小值
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<maxIndex>: 窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为 12。
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;<fileNamePattern>: 必须包含 “%i” 例如,假设最小值和最大值分别为 1 和 2,命名模式为 mylog%i.log, 会产生归档文件 mylog1.log 和 mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有 log%i.log.zip
例如: &emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;

                    logFile.%d{yyyy-MM-dd}.log          30                        %-4relative [%thread] %-5level %logger{35} - %msg%n           

              

备注:上述配置表示每天生成一个日志文件,保存 30 天的日志文件。
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;

          test.log

                 tests.%i.log.zip           1           3       

                 5MB                        %-4relative [%thread] %-5level %logger{35} - %msg%n           

              

备注:上述配置表示按照固定窗口模式生成日志文件,当文件大于 5MB 时,生成新的日志文件。窗口大小是 1 到 3,当保存了 3 个归档文件后,将覆盖最早的日志。
<encoder>:对记录事件进行格式化。负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。
PatternLayoutEncoder 是唯一有用的且默认的 encoder ,有一个 <pattern> 节点,用来设置日志的输入格式。使用 “%” 加“转换符”方式,如果要输出 “%”,则必须用“\” 对“\%”进行转义。
&emsp;&emsp;&emsp;&emsp;5.4、还有 SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这里就不详解了。
大家可以参考官方文档(http://logback.qos.ch/documentation.html),还可以编写自己的 Appender。
(6)子节点 <loger>:用来设置某一个包或具体的某一个类的日志打印级别、以及指定 < appender>。<loger > 仅有一个 name 属性,一个可选的 level 和一个可选的 addtivity 属性。
可以包含零个或多个 <appender-ref> 元素,标识这个 appender 将会添加到这个 loger
&emsp;&emsp;&emsp;&emsp;name: 用来指定受此 loger 约束的某一个包或者具体的某一个类。
&emsp;&emsp;&emsp;&emsp;level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值 INHERITED 或者同义词 NULL,代表强制执行上级的级别。 如果未设置此属性,那么当前 loger 将会继承上级的级别。
addtivity: 是否向上级 loger 传递打印信息。默认是 true。同 <loger> 一样,可以包含零个或多个 < appender-ref > 元素,标识这个 appender 将会添加到这个 loger。
(7)子节点 <root>: 它也是 < loger > 元素,但是它是根 loger, 是所有 < loger > 的上级。只有一个 level 属性,因为 name 已经被命名为 "root", 且已经是最上级了。
&emsp;&emsp;&emsp;&emsp;level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为 INHERITED 或者同义词 NULL。 默认是 DEBUG。
六、常用 logger 配置


``` 七、Demo (1)添加依赖包 logback 使用需要和 slf4j 一起使用,所以总共需要添加依赖的包有 slf4j-api logback 使用需要和 slf4j 一起使用,所以总共需要添加依赖的包有 slf4j-api.jar,logback-core.jar,logback-classic.jar,logback-access.jar 这个暂时用不到所以不添加依赖了,maven 配置    ```     UTF-8     1.1.7     1.7.21   

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

(2)logback.xml 配置

%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n ${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log 30 %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n 10MB ``` (3)java 代码
/**
&emsp;&emsp;* Hello world!
&emsp;&emsp;*/
&emsp;&emsp;public class App {

&emsp;&emsp;private final static Logger logger = LoggerFactory.getLogger(App.class);

&emsp;&emsp;&emsp;&emsp;public static void main(String[] args) {
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;logger.info("logback 成功了");
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;logger.error("logback 成功了");
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;logger.debug("logback 成功了");
&emsp;&emsp;&emsp;&emsp;}
&emsp;&emsp;}

(4)输出

八、总结

logback 的配置,需要配置输出源 appender,打日志的 loger(子节点)和 root(根节点),实际上,它输出日志是从子节点开始,子节点如果有输出源直接输入,如果无,判断配置的 addtivity,是否像上级传递,即是否向 root 传递,传递则采用 root 的输出源,否则不输出日志。