logback-日志深入使用

logback日志深入使用

在之前的博文中，博主已经简单的介绍了logback的配置文件以及简单的使用。下面，博主将介绍一下logback的一些其它用法。

格式化输出

logback的方法可以支持我们进行格式化输出，我们再也不用手动进行字符串的拼接了。

logger.info("name:{}","123456");

查看输出结果：

输出结果

自动删除历史文件

在实际的项目开发当中，对于测试环境或者生产环境的日志，如果没有经过程序的处理，可能需要我们人为定期进行日志的清理。因为如果日志长时间不清理，可能会造成磁盘空间不足，从而造成一连串的负面影响。这里我们可以考虑使用logback的日志最大保存天数和归档文件最大容量来解决这个问题。

日志最大保存天数

博主这里先使用简单的logback.xml配置文件来进行实验，并且maxHistory设置为1，也就是说日志最多会保留一天。

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="true">
    <!--配置变量-->
    <!--文件路径前缀-->
    <property name="LOG_HOME_PATH" value="logs"/>
    <property name="encoder_pattern" value="%d{yyyy/MM/dd HH:mm:ss.SSS} %cyan(%-5level) [%thread] [%c{0}:%L] %magenta(%logger{36}): %msg%n"/>
    <property name="maxHistory" value="1"/>
    <property name="maxFileSize" value="5KB"/>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${encoder_pattern}</pattern>
            <!--<charset>UTF-8</charset>-->
        </encoder>
    </appender>
    <appender name="FILE_ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME_PATH}/level_all.%d.%i.log</fileNamePattern>
            <maxHistory>${maxHistory}</maxHistory>
            <maxFileSize>${maxFileSize}</maxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>${encoder_pattern}</pattern>
            <!--<charset>UTF-8</charset>-->
        </encoder>
    </appender>
    <!-- 控制台输出日志级别 -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE_ALL"/>
    </root>
</configuration>

下面就是博主用于观察logback日志最大保存天数的代码，我们先让其运行一会，然后手动修改windows系统的时间，再来观察之前的日志文件是否消失了。

//输出的字符串
String content = "1234";
int byteLength = content.getBytes().length;
StringBuilder stringBuilder = new StringBuilder();
//日志打印输出6kb内容，加上一些格式化的内容总共肯定是大于6kb的
for(int i = 1; i <= 6 * 1024 / byteLength; i++)
{
    logger.info(content);
	//为了观察时间的变化
    Thread.sleep(100);
}

没修改时间之前，打印日志的时间为2020-08-26。

没修改时间之前

这里我们将时间修改为2020-08-28，再来查看日志文件是否发生了变化。因为改成27号，还是会保留26号的，而改成28号，则会删除26号的日志文件。

修改时间之后

归档文件最大大小

如果单纯只控制了最大保存天数，日志文件的大小还是有可能超出我们预定的限制，比如说我们限制日志文件最多占用1个G的磁盘空间。这里为了方便测试，我们将归档文件的最大大小设置为10kb。

 <property name="totalSizeCap" value="10KB"/>
 
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    <fileNamePattern>${LOG_HOME_PATH}/level_all.%d.%i.log</fileNamePattern>
    <maxHistory>${maxHistory}</maxHistory>
    <maxFileSize>${maxFileSize}</maxFileSize>
    <totalSizeCap>${totalSizeCap}</totalSizeCap>
</rollingPolicy>

这里需要注意的是logback版本需要>=1.1.8，从下图可以看到totalSizeCap的配置发生了作用。

enter description here

这时候，我们再来查看日志文件。

异步日志

默认情况下，logback使用的是同步方式记录日志，这时候如果程序存在打印大量日志的情况，则整体上会减慢应用的响应速度。所以我们可以使用logback的异步appender来实现日志的打印。

 <appender name="ASYNC_INFO" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>512</queueSize>
        <!-- 添加附加的appender,最多只能添加一个 -->
        <appender-ref ref="FILE_INFO"/>
    </appender>
    <!-- 控制台输出日志级别 -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="ASYNC_INFO"/>
    </root>

配置完异步日志之后，我们来查看异步配置是否生效，这里我们分别使用同步和异步的方式来打印234MB的日志文件，

enter description here

相对于同步打印日志来说，异步日志打印方式在性能上会好一些。

enter description here