logback RollingFileAppender使用详解

最新推荐文章于 2024-08-10 10:11:55 发布
最新推荐文章于 2024-08-10 10:11:55 发布
阅读量2w 收藏 40
点赞数 15
分类专栏： LogBack
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/p812438109/article/details/105028051
版权

一）logback日志组件

简介：logback是一款开源日志组件，属于Log4j的升级版本，现在项目组使用的次数越来越多。

 

优点：

1、初始化加载内存小

2、配置修改时，自动重新加载配置文件，扫描过程快且安全

 

组成模块：logback-core、logback-classic、logback-access

logback-core提供了logback的核心功能，是另外两个组件的基础；

logback-classic模块实现了SLF4J API；

logback-access模块与Servlet容器集成提供Http来访问日志的功能。

 

使用方式：在maven中pom.xml导入jar

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.1.11</version>
</dependency>
	
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.1.11</version>
</dependency>
	
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-access</artifactId>
    <version>1.1.11</version>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>

 

logback日志扫描顺序：（logback支持后缀名称为groovy与xml两种配置方式）

第一步：先在System Property系统配置文件中查找是否有logback.configurationFile对应的value

第二步：在classpath下寻找是否有logback.groovy文件

第三步：在classpath下寻找是否有logback-test.xml文件

第四步：在classpath下寻找是否有logback.xml文件

 

以上4步，只需要符合其中一步逻辑即可，具体代码实现可见ch.qos.logback.classic.util.ContextInitializer类的findURLOfDefaultConfigurationFile方法。

如果以上4步都步符合，logback会默认构造一个控制台输出日志，并会有默认的日志格式。

 

初始化方式：

第一种：通过指定名称初始化

private final static Logger LOGGER = LoggerFactory.getLogger("HelloLogback");

 

第二种：通过Class的方式初始化

private final static Logger LOGGER = LoggerFactory.getLogger(HelloLogback.class);

 

日志测试工具类：

package com.oysept.logback;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloLogback {
	
    private final static Logger LOGGER = LoggerFactory.getLogger(HelloLogback.class);
	
    public static void main(String[] args) {
        LOGGER.debug("this is debug message");
        LOGGER.info("this is info message");
        LOGGER.warn("this is warning message");
        LOGGER.error("this is error message");
        LOGGER.warn("this is  login message");
    }
}

 

二）logback日志控制台输出

在logback.xml中添加控制台输出日志配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60" debug="false">

    <!-- 自定义属性 -->
    <property name="pattern" value="%X{thread} [%date{yyyy-MM-dd HH:mm:ss.SSS}] %level %logger{36} %line - %msg%n"/>

    <!--控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 设置日志输出格式 -->
            <pattern>${pattern}</pattern>
			
            <!-- 设置输出字符集编码 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
	
    <!-- 根root looger -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

 

logback.xml配置文件详解

1、configuration：配置根节点

<!-- scan：程序运行时配置文件被修改，是否重新加载。true=重新加载；false=不重新加载；默认为true; -->
<!-- scanPeriod：监测配置文件被修改的时间间隔，scan属性必须设置为true才可生效；默认为1分钟，默认单位是毫秒； -->
<!-- debug：是否打印logback程序运行的日志信息。true=打印；false=不打印；默认为false; -->

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

 

2、property：属性变量

<!-- 自定义属性、相当于全局变量 -->
<!-- name ：变量的名称，可以随意起名，建议简单明了； -->
<!-- value：变量的值； -->
<!-- 在配置文件中，我们可以使用 ${pattern}方式，将变量引入到其他节点中去。如果有多处使用相同的内容，便可使用属性变量的方式进行统一，减少很多不必要的代码； -->

<property name="pattern" value="%X{thread} [%date{yyyy-MM-dd HH:mm:ss.SSS}] %level %logger{36} %line - %msg%n"/>

 

3、appender：日志输出的目的地

<!--appender标签中的name和class为必填属性 -->
<!--name ：节点的名称 -->
<!--class：全限定类名，ch.qos.logback.core.ConsoleAppender表示控制台输出 -->

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <!-- 设置日志输出格式 -->
        <pattern>${pattern}</pattern>
			
        <!-- 设置输出字符集编码 -->
        <charset>UTF-8</charset>
    </encoder>
</appender>

 

4、root：根日志对象

<!-- root： 但它位于logger体系中的最顶层。当一个类中的logger对象进行打印请求时，如果配置文件中没有为该类单独指定日志对象，那么都会交给root根日志对象来完成； -->
<!-- root： 节点中只有一个level属性，还可以单独指定日志输除目的地<apender-ref> -->

<root level="DEBUG">
    <appender-ref ref="STDOUT" />
</root>

 

三）logback日志磁盘文件输出

在logback.xml中添加磁盘输出日志配置（该方式用的较少）

缺点：该方式会导致日志都在一个文件中，文件会越来越大，最后可能会打不开，不好查看日志。

 

ch.qos.logback.core.FileAppender磁盘文件输出日志：

<?xml version="1.0" encoding="UTF-8" ?>
<configuration scan="true" scanPeriod="60" debug="false">
	
    <!-- 自定义变量 -->
    <property name="appName" value="ouyangjun-logback" />
	
    <!-- 日志文件名称, 可随便命名 -->
    <property name="baseFile" value="ouyangjun-logback" />
	
    <!-- 项目所在盘符的根目录下, 也可以指定具体盘符位置, 如：E:\\app\\ouyangjun-logback\\logs -->
    <property name="rootPath" value="/app/ouyangjun-logback/logs" />
    
    <!-- 日志输出格式 -->
    <property name="pattern" value="%X{thread} [%date{yyyy-MM-dd HH:mm:ss.SSS}] %level %logger{36} %line - %msg%n"/>
    
    <!-- 设置上下文名称 -->
    <contextName>${appName}</contextName>

    <!-- 磁盘文件输出日志 -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <File>${rootPath}/${baseFile}.log</File>
        <append>true</append>  
        <prudent>false</prudent>
		
        <!-- 日志输出格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
            
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="FILE" />
    </root>
</configuration>

 

四）logback日志滚动输出（磁盘）

在logback.xml中添加磁盘输出日志配置，当设置生效时，按照具体的设置生成日志文件。如当日志文件超过一定大小时，重新生成一个新日志文件存储。

 

优化点：由于每次输出日志到磁盘，都会进行IO流操作，所以可以结合异步输出日志的方式实现功能，当日志到一定量的时候，再一次写入到磁盘文件中。

 

ch.qos.logback.core.rolling.RollingFileAppender磁盘文件滚动输出日志

<?xml version="1.0" encoding="UTF-8" ?>
<configuration scan="true" scanPeriod="60" debug="false">
	
    <!-- 自定义变量 -->
    <property name="appName" value="ouyangjun-logback" />
	
    <!-- 日志文件名称, 可随便命名 -->
    <property name="baseFile" value="ouyangjun-logback" />
	
    <!-- 项目所在盘符的根目录下, 也可以指定具体盘符位置, 如：E:\\app\\ouyangjun-logback\\logs -->
    <property name="rootPath" value="/app/ouyangjun-logback/logs" />
    
    <!-- 日志输出格式 -->
    <property name="pattern" value="%X{thread} [%date{yyyy-MM-dd HH:mm:ss.SSS}] %level %logger{36} %line - %msg%n"/>
    
    <!-- 设置上下文名称 -->
    <contextName>${appName}</contextName>

    <!-- 磁盘文件滚动输出日志 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${rootPath}/${baseFile}.log</File>
        <append>true</append>  
        <prudent>false</prudent>
    	
        <!-- 磁盘日志文件rolling策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${rootPath}/${baseFile}_%d{yyyy-MM-dd}.log.gz</FileNamePattern>
            
            <!-- 日志在磁盘上保留天数 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>

        <!-- 日志输出格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
            
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    
    <!-- 把日志异步输出到磁盘文件中，避免每次都进行磁盘IO操作 -->
    <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>10000</queueSize>
        <appender-ref ref="FILE" />
    </appender>

    <root level="INFO">
        <!-- <appender-ref ref="FILE" /> -->
        
        <appender-ref ref="ASYNC" />
    </root>
</configuration>

 

把日志异步输出到磁盘文件中，避免每次都进行磁盘IO操作

<!-- 把日志异步输出到磁盘文件中，避免每次都进行磁盘IO操作 -->
<appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
    <discardingThreshold>0</discardingThreshold>
    <queueSize>10000</queueSize>
    <appender-ref ref="FILE" />
</appender>

<!-- queueSize：指的是BlockingQueue的队列容量大小，默认为256个，程序测试时，可设置小一点，方便监控日志 -->
<!-- 
discardingThreshold：如果BlockingQueue中还剩余20%的容量，那么程序会丢弃TRACE、DEBUG和INFO级别的日志打印事件event，只保留WARN和ERROR级别的。
为了保留所有的日志打印事件，可以将该值设置为0
-->
<!-- appender下只能有一个appender-ref子节点 -->

 

日志rollingPolicy滚动策略详解

第一种：根据时间制定日志文件的滚动策略，如：按天、按小时、按分钟生成日志文件

ch.qos.logback.core.rolling.TimeBasedRollingPolicy

<!-- 磁盘日志文件rolling策略，按天生成日志文件 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <FileNamePattern>${rootPath}/${baseFile}_%d{yyyy-MM-dd}.log.gz</FileNamePattern>
            
    <!-- 日志在磁盘上保留天数 -->
    <maxHistory>30</maxHistory>
</rollingPolicy>

 

第二种：表示如果日志文件大小超过指定范围时，会根据文件名拆分成多个文件；

ch.qos.logback.core.rolling.FixedWindowRollingPolicy

<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
    <fileNamePattern>${baseFile}_.%i.log.gz</fileNamePattern>
    <minIndex>1</minIndex>
    <maxIndex>3</maxIndex>
</rollingPolicy>

 

第三种：和rollingPolicy一样平级的策略triggeringPolicy，表示根据日志文件大小，超过制定大小会触发日志滚动；

ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy

<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
    <maxFileSize>5MB</maxFileSize>
</triggeringPolicy>

 

五）实战中logback.xml配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<configuration scan="true" scanPeriod="60" debug="false">
    
    <!-- 自定义变量 -->
    <property name="appName" value="ouyangjun-logback" />
    
    <!-- 日志文件名称, 可随便命名 -->
    <property name="baseFile" value="ouyangjun-logback" />
    
    <!-- 项目所在盘符的根目录下, 也可以指定具体盘符位置, 如：E:\\app\\ouyangjun-logback\\logs -->
    <property name="rootPath" value="/app/ouyangjun-logback/logs" />
    
    <!-- 日志输出格式 -->
    <property name="pattern" value="%X{thread} [%date{yyyy-MM-dd HH:mm:ss.SSS}] %level %logger{36} %line - %msg%n"/>
    
    <!-- 设置上下文名称 -->
    <contextName>${appName}</contextName>
	
    <!-- 把日志在控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
            
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 磁盘文件输出日志 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${rootPath}/${baseFile}.log</File>
        <append>true</append>  
        <prudent>false</prudent>
    	
        <!-- 日志文件rolling策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${rootPath}/${baseFile}_%d{yyyy-MM-dd}.log.gz</FileNamePattern>
            <!-- 日志保留天数 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>

        <!-- 日志输出格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
            
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 文件输出日志 (文件大小策略进行文件输出，每小时产生一个日志文件给异常监控平台进行分析) -->
    <appender name="ERRORFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${rootPath}/${baseFile}_error.log</File>
        <append>true</append>  
        <prudent>false</prudent>
    	
        <!-- 日志文件rolling策略 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${rootPath}/${baseFile}_error_%d{yyyy-MM-dd}.log.gz</FileNamePattern>
            
            <!-- 日志在磁盘上保留天数 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        
        <!-- 过滤器，只ACCEPT接收ERROR级别的日志，其它日志级别都DENY拒绝 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        
        <!-- 日志输出格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${pattern}</pattern>
            
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
	
    <!-- 把日志异步输出到磁盘文件中，避免每次都进行磁盘IO操作 -->
    <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>10000</queueSize>
        <appender-ref ref="FILE" />
    </appender>
	
    <root level="INFO">
        <!-- 生产环境,可以不需要再控制台输出日志 -->
        <appender-ref ref="STDOUT" />
        
        <!-- 异步输出日志到磁盘文件中 -->
        <appender-ref ref="ASYNC" />
        
        <!-- 错误文件,需要实时输出到磁盘中 -->
        <appender-ref ref="ERRORFILE" />
    </root>
</configuration>

 

识别二维码关注个人微信公众号

本章完结，待续，欢迎转载！
 
本文说明：该文章属于原创，如需转载，请标明文章转载来源！

ouyangjun__
关注
专栏目录
详解Log4j2中的RollingFileAppender
03-21 1万+
目录 一、什么是RollingFile 二、TriggeringPolicy SizeBasedTriggeringPolicy TimeBasedTriggeringPolicy CompositeTriggeringPolicy 三、DefaultRolloverStrategy 四、DeleteAction 五、程序测试demo 六、参考资料 一、什么是RollingFile RollingFileAppender是Log4j2中的一种能够实现日志文件滚动更新(rollover)
Spring boot使用logback实现日志管理过程详解
08-19
Spring Boot 使用 Logback 实现日志管理过程详解 本文主要介绍了在 Spring Boot 中使用 Logback 实现日志管理的过程。Logback 是一个流行的日志管理框架，它提供了许多灵活的配置选项，可以满足不同的日志记录需求...
Spring如何动态自定义logback日志目录详解
08-26
主要给大家介绍了关于Spring如何动态自定义logback日志目录的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot之LogBack配置详解
08-26
主要介绍了SpringBoot之LogBack配置详解，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
log4j2的RollingFileAppender
最新发布
Java程序员的知识博客
08-10 848
RollingFileAppender 是一种可以根据特定条件滚动生成新日志文件的输出源，它能够有效地管理日志文件，避免单个文件过大，并提供了灵活的文件命名和存储策略。TimeBasedTriggeringPolicy（基于时间的触发策略）SizeBasedTriggeringPolicy（基于大小的触发策略）来格式化日志事件，并且配置了基于时间的触发策略。）创建一个新的日志文件，文件命名模式为。的文件，并在每天（根据日期格式。被配置为将日志写入名为。灵活的文件命名和存储。
logback-RollingFileAppender源码分析（关于缓冲和性能）
dch9210的博客
04-25 1642
打印性能是日志打印框架的核心关注点之一，从logback的日志打印流程看看其性能如何？ 本文基于logback1.2.3版本，以下配置（1.2.0版本后，logback提供了 SizeAndTimeBasedRollingPolicy 策略，可同时基于时间+空间两个维度控制日志文件的滚动） 形如下面这句debug日志的打印，调用栈是这样的 LOGGER.debug("msg {}", msg); Appender接口&实现类 Appender接口作为logback的核心三大件（Logger、A
logback中RollingFileAppender属性简介说明
qq_25073223的博客
07-29 1610
logback中RollingFileAppender属性简介说明
【Logback】Logback 中的 Appenders
swadian2008的博客
03-06 1621
Appender组件负责处理Logback日志写入的任务，该组件必须实现接口，该接口的主要方法总结如下：//主要是解决将日志写到哪里去的问题//核心方法Appender接口中其实就一个最核心的方法，即doAppend()方法，且该方法只有一个参数，也就是类型为 E 的对象实例。泛型 E 的实例类型需要根据 logback 的具体模块进行决定，在模块内，E 的类型为ILoggingEvent(日志记录事件)，在模块内，E 的类型为。
logback 之 创建 RollingFileAppender
LionBule
09-24 986
最近有需求要将context信息写入文件，以备后续数据分析。本想直接同步写入文件了事，但是logback针对日志的输出性能尤佳，且为异步写入。既然logback封装如此完美，何不直接使用？   动态创建Logger及其appender。代码如下：   import org.slf4j.Logger; import org.slf4j.LoggerFactory; import ch...
slf4j与logback配合使用详解
SLF4J与Logback简介 ## 1.1 SLF4J介绍 SLF4J（Simple Logging Facade for Java）是一个日志记录框架的接口，它允许我们以统一的方式进行日志记录。SLF4J提供了一组简单易用的日志记录接口，并具备良好的性能和灵活...
logback：RollingFileAppender
诚的博客
01-19 1073
RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 ps: <?xml version="1.0" encoding="UTF-8"?> <configuration debug="true" scan="true" scanPeriod="1 seconds"> <contextName>webA</contextName> <appender name="..
log4j2教程【RollingFileAppender】
热门推荐
山鬼谣的专栏
05-18 5万+
说明自己翻译官网的说明RollingFileAppenderRollingFileAppender是一个OutputStreamAppender，它（会把日志）写入到filename参数命名的文件中，并且会根据TriggeringPolicy和RolloverPolicy来滚动文件（rolls the file over）。RollingFileAppender会使用RollingFileManag
【进阶】logback之 RollingFileAppender 的原理及避坑建议Applehope
BASK2312的博客
12-31 1700
我是石页兄，如果这篇文章对您有帮助，或者有所启发的话，欢迎关注笔者的微信公众号【 架构染色 】进行交流和学习。您的支持是我坚持写作最大的动力。原文链接：https://juejin.cn/post/7183152831677857847来源：稀土掘金。
RollingFileAppender
Work Hard, Play Harder!
02-18 2261
For full details see the SDK Reference entry: log4net.Appender.RollingFileAppender. The RollingFileAppender builds on the FileAppender and has the same options as that appender. The following ex
logback的FileAppender
Leon_Jinhai_Sun的博客
05-06 627
FileAppender配置 <?xml version="1.0" encoding="UTF-8"?> <configuration> <!-- 自定义属性 可以通过${name}进行引用--> <property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss} %c %M ...
logback--基础--04--配置--appender
zhou920786312的博客
06-22 1782
1、根节点< configuration>的子节点< appender> 对日志进行格式化。 对记录事件进行格式化 对记录事件进行格式化当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。告知 RollingFileAppender 何时激活滚动。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值