Java日志框架-logback的介绍及配置使用方法(纯Java工程)
发布日期:2021-06-30 17:38:27 浏览次数:4 分类:技术文章

本文共 11066 字,大约阅读时间需要 36 分钟。

说明:内容估计有些旧,2011年的,但是大体意思应该没多大变化,最新的配置可以参考官方文档。

一、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来访问日志的功能。 Logback是要与SLF4J结合起来用两个组件的官方网站如下:

logback的官方网站: 

SLF4J的官方网站:

本文章用到的组件如下:

logback-access-1.0.0.jar(这个可以不用)

logback-classic-1.0.0.jar

logback-core-1.0.0.jar

slf4j-api-1.6.0.jar

如果有spring-boot-starter-test 依赖则不需要引用

POM:

org.slf4j
slf4j-api
1.6.0
jar
compile
ch.qos.logback
logback-core
0.9.28
jar
ch.qos.logback
logback-classic
0.9.28
jar

二、logback取代log4j的理由:

Logback和log4j是非常相似的,如果你对log4j很熟悉,那对logback很快就会得心应手。下面列了logback相对于log4j的一些优点:

1、更快的实现 

Logback的内核重写了,在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了,初始化内存加载也更小了。

2、非常充分的测试 

Logback经过了几年,数不清小时的测试。Logback的测试完全不同级别的。在作者的观点,这是简单重要的原因选择logback而不是log4j。

3、Logback-classic非常自然实现了SLF4j   

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

4、非常充分的文档 

官方网站有两百多页的文档。

5、自动重新加载配置文件  

当配置文件修改了,Logback-classic能自动重新加载配置文件。扫描过程快且安全,它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。

6、Lilith  

Lilith是log事件的观察者,和log4j的chainsaw类似。而lilith还能处理大数量的log数据 。

7、谨慎的模式和非常友好的恢复  

在谨慎模式下,多个FileAppender实例跑在多个JVM下,能 够安全地写道同一个日志文件。RollingFileAppender会有些限制。Logback的FileAppender和它的子类包括 RollingFileAppender能够非常友好地从I/O异常中恢复。

8、配置文件可以处理不同的情况   

开发人员经常需要判断不同的Logback配置文件在不同的环境下(开发,测试,生产)。而这些配置文件仅仅只有一些很小的不同,可以通过 <if>,<then><else>标签来实现,这样一个配置文件就可以适应多个环境。

9、Filters(过滤器)  

有些时候,需要诊断一个问题,需要打出日志。在log4j,只有降低日志级别,不过这样会打出大量的日志,会影响应用性能。在Logback,你可以继续 保持那个日志级别而除掉某种特殊情况,如alice这个用户登录,她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需 加4行XML配置。可以参考MDCFIlter 。

10、SiftingAppender(一个非常多功能的Appender) 

它可以用来分割日志文件根据任何一个给定的运行参数。如,SiftingAppender能够区别日志事件跟进用户的Session,然后每个用户会有一个日志文件。

11、自动压缩已经打出来的log  

RollingFileAppender在产生新文件的时候,会自动压缩已经打出来的日志文件。压缩是个异步过程,所以甚至对于大的日志文件,在压缩过程中应用不会受任何影响。

12、堆栈树带有包版本  

Logback在打出堆栈树日志时,会带上包的数据。

13、自动去除旧的日志文件 

通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性,你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12,那那些log文件超过12个月的都会被自动移除。

总之,logback比log4j太优秀了,让我们的应用全部建立logback上吧 !

、Logback的配置介绍

1、Logger、appender及layout

Logger作为日志的记录器,把它关联到应用的对应的context上后,主要用于存放日志对象,也可以定义日志类型、级别。

Appender主要用于指定日志输出的目的地,目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。 

Layout负责把事件转换成字符串,格式化的日志信息的输出。

2、logger context

各个logger都被关联到一个LoggerContext,LoggerContext负责制造logger,也负责以树结构排列各 logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以logger名称为参数。用同一名字调用LoggerFactory.getLogger 方法所得到的永远都是同一个logger对象的引用。

3、有效级别及级别的继承

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

4、打印方法与基本的选择规则

打印方法决定记录请求的级别。例如,如果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。

1、Logback的配置文件

Logback配置文件的语法非常灵活。正因为灵活,所以无法用DTD或XML schema进行定义。

  • (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: 的值时变量定义的值
  例如:

   
   
${APP_Name}
   
  • (4) 子节点<timestamp>:获取时间戳字符串,他有两个属性key和datePattern

    key: 标识此<timestamp> 的名字;

    datePattern: 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。
  例如:

      
      
${bySecond}
      
  • (5) 子节点<appender>:负责写日志的组件,它有两个必要属性name和class。name指定appender名称,class指定appender的全限定名

2.ConsoleAppender 把日志输出到控制台,有以下子节点:

      

:对日志进行格式化。(具体参数稍后讲解 )
:字符串System.out(默认)或者System.err(区别不多说了)

    例如:

 

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

 

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

3. FileAppender:把日志添加到文件,有以下子节点:     

:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
:对记录事件进行格式化。(具体参数稍后讲解 )
:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。

例如:

      
        
testFile.log
        
true
        
          
%-4relative [%thread] %-5level %logger{35} - %msg%n
        
      
      
      
      

 

 

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

4、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 触发当前活动文件滚动。只有一个节点:
:这是活动文件的大小,默认值是10MB。
:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。
:告知 RollingFileAppender 合适激活滚动。class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点:
:窗口索引最小值
:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
:必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip例如:         
         
            
              
logFile.%d{yyyy-MM-dd}.log
              
30
            
            
              
%-4relative [%thread] %-5level %logger{35} - %msg%n
            
          
          
            
          
 
备注:上述配置表示每天生成一个日志文件,保存30天的日志文件。
          
            
test.log
            
              
tests.%i.log.zip
              
1
              
3
            
            
              
5MB
            
            
              
%-4relative [%thread] %-5level %logger{35} - %msg%n
            
          
          
            
          
备注:上述配置表示按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。
:对记录事件进行格式化。负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个
节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“\%”进行转义。

还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这里就不详解了。
大家可以参考官方文档(http://logback.qos.ch/documentation.html),还可以编写自己的Appender。

5.子节点<loger>:

用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。

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

 

name: 用来指定受此loger约束的某一个包或者具体的某一个类。level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。 如果未设置此属性,那么当前loger将会继承上级的级别。addtivity: 是否向上级loger传递打印信息。默认是true。同
一样,可以包含零个或多个
元素,标识这个appender将会添加到这个loger。

6.子节点<root>:

它也是<loger>元素,但是它是根loger,是所有<loger>的上级。只有一个level属性,因为name已经被命名为"root",且已经是最上级了。level: 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能设置为INHERITED或者同义词NULL。 默认是DEBUG。

 

五、常用loger配置

 

1、Logback默认配置的步骤

(1). 尝试在classpath下查找文件logback-test.xml;

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

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

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

 

六、在程序用应用Logback

 

import org.slf4j.Logger;import org.slf4j.LoggerFactory;public class BlogAction{     //定义一个全局的记录器,通过LoggerFactory获取     private static final Logger logger = LoggerFactory.getLogger(BlogAction.class);      /**     * @param args     */    public static void main(String[] args) {        logger.info("logback 成功了");        logger.error("logback 成功了");    }}

 

七、切面的配合使用

package com.xxx.xxx.config;//xxx需要修改import java.util.Enumeration;import javax.servlet.http.HttpServletRequest;import org.aspectj.lang.JoinPoint;import org.aspectj.lang.annotation.Aspect;import org.aspectj.lang.annotation.Before;import org.aspectj.lang.annotation.Pointcut;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.stereotype.Component;import org.springframework.web.context.request.RequestContextHolder;import org.springframework.web.context.request.ServletRequestAttributes;@Component@Aspectpublic class WebControllerAopConfig {	//定义一个全局的记录器,通过LoggerFactory获取    private static final Logger logger =     LoggerFactory.getLogger(WebControllerAopConfig.class); 	// xxx 改成你自己的路径    @Pointcut("execution(* com.xxx.xxx.controller..*.*(..))")    public void webLog(){    	    }    @Before("webLog()")    public void doBefore(JoinPoint joinPoint){        ServletRequestAttributes attributes = (ServletRequestAttributes)                             RequestContextHolder.getRequestAttributes();        HttpServletRequest request = attributes.getRequest();        // 记录下请求内容        logger.info(">>><<< URL : " + request.getRequestURL().toString());        logger.info(">>><<< HTTP_METHOD : " + request.getMethod());        logger.info(">>><<< IP : " + request.getRemoteAddr());        Enumeration
enu = request.getParameterNames(); while (enu.hasMoreElements()) { String name = (String) enu.nextElement(); logger.info("name:[{}],value:[{}]", name, request.getParameter(name)); } }}

 

转载地址:https://lemonstone.blog.csdn.net/article/details/83182503 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:Swagger2 使用说明
下一篇:The valid characters are defined in RFC 7230 and RFC 3986

发表评论

最新留言

逛到本站,mark一下
[***.202.152.39]2024年04月20日 12时42分02秒