最近一个项目中用到logback来配置日志,网上找来找去都太零碎,而且重复太多,没有一个全面的介绍怎么配置的,这里我就整理一下。
根节点包含的属性
- scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
- scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
- debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
例如:
1 | <configuration scan="true" scanPeriod="60 seconds" debug="false"> |
根节点的子节点
结构目录如下:
设置上下文名称:
每个logger都关联到logger上下文,默认上下文名称为default。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改,如下配置:
1 | <configuration scan="true" scanPeriod="60 seconds" debug="false"> |
设置变量:
用来定义变量值的标签, 有两个属性name和value:
- name: 变量的名称
- value: 的值时变量定义的值。
通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量;例如使用定义上下文名称,然后在设置logger上下文时使用,如下:
1 | <configuration scan="true" scanPeriod="60 seconds" debug="false"> |
获取时间戳字符串:
- key: 标识此 的名字;
- datePattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。
例如将解析配置文件的时间作为上下文名称,如下:
1 | <configuration scan="true" scanPeriod="60 seconds" debug="false"> |
设置loger
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性,一个可选的level和一个可选的addtivity属性。
- name: 用来指定受此loger约束的某一个包或者具体的某一个类。
- level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO,WARN,ERROR,ALL和OFF,还有一个特俗值INHERITED或者同义词NULL`,代表强制执行上级的级别。 如果未设置此属性,那么当前loger将会继承上级的级别。
- addtivity: 是否向上级loger传递打印信息。默认是true。
也是元素,但是它是根loger。只有一个level属性,应为已经被命名为”root”。
- level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。 默认是DEBUG。
和可以包含零个或多个元素,标识这个appender将会添加到这个loger。
例如: LogbackDemo.java类
1 | package logback; |
logback.xml配置文
第1种:只配置root
1 | <configuration> |
其中appender的配置表示打印到控制台(稍后详细讲解appender ); 将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。
当执行logback.LogbackDemo类的main方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
打印结果如下:
1 | 13:30:38.484 [main] INFO logback.LogbackDemo - ======info |
第2种:带有loger的配置,不指定级别,不指定appender:
1 | <configuration> |
其中appender的配置表示打印到控制台(稍后详细讲解appender ); 将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“DEBUG”; 没有设置addtivity,默认为true,将此loger的打印信息向上级传递; 没有设置appender,此loger本身不打印任何信息。 将root的打印级别设置为“DEBUG”,指定了名字为“STDOUT”的appender。
当执行logback.LogbackDemo类的main方法时,因为LogbackDemo 在包logback中,所以首先执行,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印; root接到下级传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;
打印结果如下:
1 | 13:19:15.406 [main] DEBUG logback.LogbackDemo - ======debug |
第3种:带有多个loger的配置,指定级别,指定appender:
1 | <configuration> |
其中appender的配置表示打印到控制台(稍后详细讲解appender )。
将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“DEBUG”; 没有设置addtivity,默认为true,将此loger的打印信息向上级传递; 没有设置appender,此loger本身不打印任何信息。
控制logback.LogbackDemo类的日志打印,打印级别为“INFO”; additivity属性为false,表示此loger的打印信息不再向上级传递, 指定了名字为“STDOUT”的appender。
将root的打印级别设置为“ERROR”,指定了名字为“STDOUT”的appender。
当执行logback.LogbackDemo类的main方法时,先执行,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向次loger的上级 传递打印信息; 未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;
打印结果如下:
1 | 4:09:01.531 [main] INFO logback.LogbackDemo - ======info |