日志框架之2 slf4j+logback实现日志架构

客官°小女子只卖身不卖艺 2022-06-10 10:56 292阅读 0赞

如何从缤纷复杂的日志系统世界筛选出适合自己的日志框架以及slf4j+logback的组合美妙之处？此文可能有帮助

## logback介绍 ##

Logback是由log4j创始人设计的另一个开源日志组件,官方网站： [http://logback.qos.ch][http_logback.qos.ch]。它当前分为下面下个模块：  
  
1. logback-core：其它两个模块的基础模块  
2. logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging  
3. logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能

## logback取代log4j的理由 ##

1.  更快的实现：Logback的内核重写了，在一些关键执行路径上性能提升10倍以上。而且logback不仅性能提升了，初始化内存加载也更小了。
2.  Logback-classic非常自然实现了SLF4j：Logback-classic实现了SLF4j。在使用SLF4j中，你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了slf4j ， 所 以切换到log4j或者其他，非常容易，只需要提供成另一个jar包就OK，根本不需要去动那些通过SLF4JAPI实现的代码。
3.  非常充分的文档，官方网站有两百多页的文档。
4.  自动重新加载配置文件，当配置文件修改了，Logback-classic能自动重新加载配置文件。扫描过程快且安全，它并不需要另外创建一个扫描线程。这个技术充分保证了应用程序能跑得很欢在JEE环境里面。
5.  谨慎的模式和非常友好的恢复，在谨慎模式下，多个FileAppender实例跑在多个JVM下，能够安全地写到同一个日志文件。  
    RollingFileAppender会有些限制。  
    Logback的FileAppender和它的子类包括RollingFileAppender能够非常友好地从I/O异常中恢复。
6.  Filters（过滤器）有些时候，需要诊断一个问题，需要打出日志。在log4j，只有降低日志级别，不过这样会打出大量的日志，会影响应用性能。在Logback，你可以继续 保持那个日志级别而除掉某种特殊情况
7.  SiftingAppender（一个非常多功能的Appender）：它可以用来分割日志文件根据任何一个给定的运行参数。如，SiftingAppender能够区别日志事件跟进用户的Session，然后每个用户会有一个日志文件。
8.  自动压缩已经打出来的log：RollingFileAppender在产生新文件的时候，会自动压缩已经打出来的日志文件。压缩是个异步过程，所以甚至对于大的日志文件，在压缩过程中应用不会受任何影响。
9.  堆栈树带有包版本：Logback在打出堆栈树日志时，会带上包的数据。
10. 自动去除旧的日志文件：通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性，你可以控制已经产生日志文件的最大数量。如果设置maxHistory 12，那些log文件超过12个月的都会被自动移除。

## 为什么选择slf4j+logback日志框架 ##

如果是在一个新的项目中建议使用Slf4j与Logback组合，这样有如下的几个优点。

*  Slf4j实现机制决定Slf4j限制较少，使用范围更广。由于Slf4j在编译期间，静态绑定本地的LOG库使得通用性要比Commons logging要好。
 *  Logback拥有更好的性能。Logback声称：某些关键操作，比如判定是否记录一条日志语句的操作，其性能得到了显著的提高。这个操作在Logback中需要3纳秒，而在Log4J中则需要30纳秒。LogBack创建记录器（logger）的速度也更快：13毫秒，而在Log4J中需要23毫秒。更重要的是，它获取已存在的记录器只需94纳秒，而Log4J需要2234纳秒，时间减少到了1/23。跟JUL相比的性能提高也是显著的。
 *  Commons Logging开销更高 在使Commons Logging时为了减少构建日志信息的开销，通常的做法是：

if(log.isDebugEnabled()){
        log.debug("User name： " + user.getName() + " buy goods id ：" + good.getId());
    }

在Slf4j阵营，你只需这么做：

log.debug("User name：{} ,buy goods id ：{}", user.getName(),good.getId());

也就是说，slf4j把构建日志的开销放在了它确认需要显示这条日志之后，减少内存和cpu的开销，使用占位符号，代码也更为简洁

*  Logback文档免费。Logback的所有文档是全面免费提供的，不象Log4J那样只提供部分免费文档而需要用户去购买付费文档。

## 使用slf4j+logback ##

### 配置文件解析 ###

#### 根节点configuration ####

根节点，包含下面三个属性：  
1. scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。  
2. scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。  
3. debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

<?xml version="1.0" encoding="utf-8"?>
    <configuration scan="true" scanPeriod="10 seconds" debug="true">
        ...
    </configuration>

#### 子节点contextName ####

用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

例如：

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

#### 子节点property ####

子节点property：用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“$\{\}”来使用变量。

1.  name: 变量的名称
2.  value: 的值时变量定义的值

例如：

#### 子节点timestamp ####

子节点：获取时间戳字符串，他有两个属性key和datePattern  
1. key: 标识此 的名字；  
2. datePattern: 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。

<configuration scan="true" scanPeriod="60 seconds" debug="false">
    　<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
    　<contextName>${bySecond}</contextName>
    　
    </configuration>

#### 子节点appender ####

子节点：负责写日志的组件，r主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。它有两个必要属性name和class。  
1. name指定appender名称  
2. class指定appender的全限定名

常用的Appder有三个，它们来自同一个超类OutputStreamAppender。需要搭配相应的滚动策略（rolliingPolicy）和触发策略（tripggringPolicy）使用。  
1. ConsoleAppender  
2. FileAppende  
3. RollingFileAppderRollingFileAppender

##### ConsoleAppender #####

ConsoleAppender 把日志输出到控制台，有以下子节点：  
1. ：对日志进行格式化。  
2. ：字符串System.out(默认)或者System.err（区别不多说了）

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

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

##### FileAppender #####

1.  ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
2.  ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
3.  ：对记录事件进行格式化。
4.  ：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

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

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

##### RollingFileAppender #####

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：  
1. ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。  
2. ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。  
3. :当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。

###### TimeBasedRollingPolicy ######

属性class定义具体的滚动策略类class=”ch.qos.logback.core.rolling.TimeBasedRollingPolicy”： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：  
　　　　　　　　  
1. ：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d\{yyyy-MM\}。  
如果直接使用 %d，默认格式是 yyyy-MM-dd。

RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；

如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\\”会被当做目录分隔符。  
2. : 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。

假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是那些为了归档而创建的目录也会被删除。

<configuration>
    　  <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    　      <file>/home/log/log.log.zip</file>
    　      
    　　    <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="DEBUG">
    　　　　<appender-ref ref="file" />
    　 </root>
    </configuration>

上述配置表示每天生成一个日志文件，保存30天的日志文件。

###### SizeBasedTriggeringPolicy ######

class=”ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。有以下子节点:

1.  :这是活动文件的大小，默认值是10MB。
2.  ：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，

1不支持也不允许文件压缩  
  
2不能设置file属性，必须留空。

1.  : 告知 RollingFileAppender 合适激活滚动。

###### FixedWindowRollingPolicy ######

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

<configuration>
    　  <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    　　    <file>/home/log/log.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>

上述配置表示按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。

###### 其他appender ######

还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这里就不详解了。

大家可以参考[官方文档][Link 1]，还可以编写自己的Appender。

##### 子节点 #####

用来设置某一个包或具体的某一个类的日志打印级别、以及指定。仅有一个name属性，一个可选的level和一个可选的addtivity属性。  
可以包含零个或多个元素，标识这个appender将会添加到这个logger  
　　　　　　　　  
1. name: 用来指定受此loger约束的某一个包或者具体的某一个类。  
2. level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前loger将会继承上级的级别。

以上是常用的自定义logger配置，方便输出接口请求信息和数据库sql信息等等。

##### 子节点 #####

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

#### 输出级别 ####

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

级别排序为： TRACE < DEBUG < INFO < WARN < ERROR

#### loback默认配置 ####

如果配置文件 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 进行定义。尽管如此，可以这样描述配置文件的基本结构：以开头，后面有零个或多个元素，有零个或多个元素，有最多一个元素。

2、Logback默认配置的步骤

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

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

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

### 简单的Demo ###

#### 选择jar包 ####

![这里写图片描述][SouthEast]

#### logback.xml ####

<?xml version="1.0" encoding="utf-8"?>
    <configuration scan="true" scanPeriod="10 seconds">
    
        
        <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-40.40logger{39} : %m%n" />
        <property name="charsetEncoding" value="UTF-8" />
        
    
        
        <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>${pattern}</pattern>
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
        <appender name="file" class="ch.qos.logback.core.FileAppender">
            <file>/home/hsy/logback/logfile.log</file>
            <append>true</append>
            <encoder>
                <pattern>${pattern}</pattern>
                <charset>${charsetEncoding}</charset>
            </encoder>
        </appender>
    
        <appender name="dailyRollingFileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <File>/home/hsy/logback/log.log</File>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>logback.%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <maxHistory>30</maxHistory>
            </rollingPolicy>
            <encoder>
                <Pattern>${pattern}</Pattern>
            </encoder>
        </appender>
    
        <logger name="org.springframework.web" level="debug"/>
        
        <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
        <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
        <logger name="org.hibernate.SQL" level="DEBUG" />
        <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
        <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />
    
        
        <logger name="com.apache.ibatis" level="TRACE"/>
        <logger name="java.sql.Connection" level="DEBUG"/>
        <logger name="java.sql.Statement" level="DEBUG"/>
        <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    
        <root level="debug">
            <appender-ref ref="console"/>
            <appender-ref ref="dailyRollingFileAppender"/>
            <appender-ref ref="file"/>
        </root>
    </configuration>

### 代码应用测试 ###

private final static Logger _logger = LoggerFactory.getLogger(CollectionHelper.class) ;
    /** * @description <p>处理的集合元素越多，去重速度更快，10万元素100毫秒，10个元素200毫秒</p> * @param list * @return * @returnType List<Object> * @author heshiyuan @date 2017年3月16日 下午7:37:53 * @path javase-common/com.javase.util/CollectionHelper.java * @date 2017年3月16日 下午7:37:53 * @price ￥：三毛三 * @copyright 如有复制粘贴请通知本人或者捐赠，微信号：hewei1109 * @email heshiyuan@chtwm.com * @callnumber 15910868535 */
    public static void duplicateRemoval(List<Integer> list) {
        _logger.info("CollectionHelper.duplicateRemoval工具类去重开始！");
        long startTime = System.currentTimeMillis() ;
        try{
            if(list == null) {
                _logger.info("将要去重的list集合是空，请检查参数再行调用！");
                long endTime = System.currentTimeMillis() ;
                _logger.info("调用去重工具类耗时{}毫秒！",(endTime - startTime));
                return ;
            }
            _logger.info("去重之前的集合是{}",list.toString());
            list = list.parallelStream().distinct().collect(Collectors.toList()) ;
            _logger.info("去重之后的集合是{}",list.toString());
        }catch(Exception e){
            _logger.error("调用去重工具类CollectionHelper.duplicateRemoval遇到异常，异常信息:{}",e.getMessage());
            throw e ;
        }finally{
            long endTime = System.currentTimeMillis() ;
            _logger.info("调用去重工具类耗时{}毫秒",(endTime - startTime));
            _logger.info("CollectionHelper.duplicateRemoval工具类去重结束！");
        }
    }

## 最后 ##

由于logback别的方面本次没有用到，此博客会后续维护。。。

[http_logback.qos.ch]: http://logback.qos.ch
[Link 1]: http://logback.qos.ch/documentation.html
[SouthEast]: /images/20220610/1acb9b68c0b34090849f65fdc71197e8.png