当前位置： 首页 > article >正文

springboot基础-logback组件配置使用

article 2024/11/16 22:52:10

文章目录

      • 1. 添加依赖
      • 2. 创建Logback配置文件
      • 3. 配置Logback
      • 4. 使用日志
      • 5. 配置环境特定的日志级别
      • 6. 配置日志文件的滚动策略
        • 1. TimeBasedRollingPolicy
        • 2. SizeAndTimeBasedRollingPolicy
        • 3. FixedWindowRollingPolicy
        • 4. CompositeRollingPolicy
        • 5. NoRollingPolicy(基本不使用)
        • 总结

在Spring Boot项目中配置Logback通常涉及以下几个详细步骤：

1. 添加依赖

确保你的pom.xml文件中包含Logback的依赖。Spring Boot默认使用Logback作为日志框架，所以通常不需要显式添加依赖，但你可以检查一下是否包含以下内容：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

2. 创建Logback配置文件

在src/main/resources目录下创建一个名为logback-spring.xml的文件。Spring Boot会自动识别这个文件并使用它来配置Logback。

3. 配置Logback

在logback-spring.xml文件中，你可以配置日志的输出格式、级别、输出位置等。以下是一个详细的示例：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 定义日志输出格式 -->
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
    </encoder>

    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm =ss} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 文件输出 -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>app.log</file>
        <append>true</append>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 滚动文件输出 -->
    <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/app.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/app-%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 异步文件输出 -->
    <appender name="ASYNC_FILE" class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="ROLLING_FILE" />
    </appender>

    <!-- 日志级别配置 -->
    <root level="info">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
        <appender-ref ref="ASYNC_FILE" />
    </root>

    <!-- 特定包的日志级别配置 -->
    <logger name="com.example" level="debug" additivity="false">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="ASYNC_FILE" />
    </logger>
</configuration>

在这个示例中：

  • 定义了三种日志输出方式：控制台、文件和滚动文件。
  • 设置了日志的输出格式。
  • 配置了根日志级别为info，并将日志输出到控制台、文件和滚动文件。
  • 为com.example包设置了特定的日志级别为debug，并且关闭了日志的传递性（additivity="false"）。

4. 使用日志

在你的代码中使用日志记录器：

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

public class MyClass {
    private static final Logger logger = LoggerFactory.getLogger(MyClass.class);

    public void myMethod() {
        logger.debug("This is a debug message");
        logger.info("This is an info message");
        logger.warn("This is a warning message");
        logger.error("This is an error message");
    }
}

5. 配置环境特定的日志级别

如果你需要为不同的环境配置不同的日志级别，可以使用logback-spring.xml中的<springProfile>标签。例如：

<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>

    <springProfile name="dev">
        <logger name="com.example" level="debug"/>
    </springProfile>
    <springProfile name="prod">
        <logger name="com.example" level="info"/>
    </springProfile>
</configuration>

在这个示例中，当Spring Boot应用运行在dev环境时，com.example包的日志级别为debug；而在prod环境时，日志级别为info。

6. 配置日志文件的滚动策略

Logback提供了多种滚动策略，用于管理日志文件的大小和数量。滚动策略允许你在日志文件达到一定大小或时间间隔时自动创建新的日志文件，并可以配置保留旧的日志文件的数量。以下是Logback中几种常见的滚动策略及其详细解释：

1. TimeBasedRollingPolicy

TimeBasedRollingPolicy 是基于时间的滚动策略，它根据时间间隔来创建新的日志文件。

  • 配置示例：
<appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>logs/app-%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
    </encoder>
</appender>
  • 解释：
  • fileNamePattern：定义了滚动日志文件的命名模式，%d{yyyy-MM-dd} 表示按天滚动。
  • maxHistory：设置保留的旧日志文件的最大数量。在这个例子中，最多保留30天的日志文件。
2. SizeAndTimeBasedRollingPolicy

SizeAndTimeBasedRollingPolicy 是基于时间和文件大小的滚动策略，它结合了时间和文件大小两个条件来创建新的日志文件。

  • 配置示例：
<appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>logs/app-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <maxFileSize>10MB</maxFileSize>
        <maxHistory>30</maxHistory>
        <totalSizeCap>1GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
    </encoder>
</appender>
  • 解释：
    • fileNamePattern：定义了滚动日志文件的命名模式，%d{yyyy-MM-dd} 表示按天滚动，%i 表示在同一天内，当文件大小达到 maxFileSize 时，会创建新的日志文件。
    • maxFileSize：设置单个日志文件的最大大小。
    • maxHistory：设置保留的旧日志文件的最大数量。
    • totalSizeCap：设置所有日志文件的总大小上限。
3. FixedWindowRollingPolicy

FixedWindowRollingPolicy 是基于固定窗口的滚动策略，它根据固定的文件索引来创建新的日志文件。

  • 配置示例：
<appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
        <fileNamePattern>logs/app-%i.log</fileNamePattern>
        <minIndex>1</minIndex>
        <maxIndex>10</maxIndex>
    </rollingPolicy>
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
        <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
    </encoder>
</appender>
  • 解释：
    • fileNamePattern：定义了滚动日志文件的命名模式，%i 表示按固定窗口索引滚动。
    • minIndex 和 maxIndex：设置窗口的最小和最大索引。
    • triggeringPolicy：定义触发滚动的策略，这里使用 SizeBasedTriggeringPolicy，当文件大小达到 maxFileSize 时触发滚动。
4. CompositeRollingPolicy

CompositeRollingPolicy 允许你组合多种滚动策略，例如同时基于时间和文件大小进行滚动。

  • 配置示例：
<appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.CompositeRollingPolicy">
        <fileNamePattern>logs/app-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
            <maxFileSize>10MB</maxFileSize>
        </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
    </encoder>
</appender>
  • 解释：
    • fileNamePattern：定义了滚动日志文件的命名模式，%d{yyyy-MM-dd} 表示按天滚动，%i 表示在同一天内，当文件大小达到 maxFileSize 时，会创建新的日志文件。
    • timeBasedFileNamingAndTriggeringPolicy：这是一个组合策略，结合了时间和文件大小的触发策略。
    • maxFileSize：设置单个日志文件的最大大小。
5. NoRollingPolicy(基本不使用)

NoRollingPolicy 是一个不进行滚动的策略，它只是简单地写入一个固定的日志文件。

  • 配置示例：
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>logs/app.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.NoRollingPolicy"/>
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
    </encoder>
</appender>
  • 解释：
    • NoRollingPolicy：不进行任何滚动操作，日志文件不会被重命名或分割。
总结

Logback提供了多种滚动策略，以满足不同的日志管理需求。你可以根据具体的应用场景选择合适的滚动策略，并通过配置文件进行详细的设置。这些策略可以帮助你有效地管理日志文件的大小和数量，确保日志系统的稳定性和可维护性。


http://www.kler.cn/a/301866.html

相关文章：

  • Android笔记(三十七)：封装一个RecyclerView Item曝光工具——用于埋点上报
  • npm install命令报错：npm ERR Could not resolve dependency npm ERR peer…
  • c++ 类和对象（中）
  • outline 分析
  • 【从零开始的LeetCode-算法】3270. 求出数字答案
  • 图像处理之cornerdetection(角点检测)综述
  • 2024年9月12日（k8s环境及测试 常用命令）
  • 康谋分享 | 汽车仿真与AI的结合应用
  • 1.SpringCloud与SpringCloud Alibaba
  • Java面试篇基础部分-Java中的异常以及异常处理
  • 初识爬虫3
  • 【区块链通用服务平台及组件】信息数据流转验真技术研究项目 | FISCO BCOS应用案例
  • HCIA--实验十一：单区域OSPF路由实验
  • 基于SpringBoot+Vue+MySQL的垃圾分类回收管理系统
  • 【菜菜的sklearn机器学习】（2）回归树
  • 设计模式 22 模板方法模式
  • electron 客户端 windows linux（麒麟V10）多系统离线打包 最新版 ＜一＞
  • 【系统架构设计师】建造者模式（Builder Pattern）
  • Android通知——Notification
  • 【JUC并发编程系列】深入理解Java并发机制：从synchronized到CAS锁升级全过程(三、synchronized 前置知识)
  • SpringBoot教师招聘管理系统---附源码81097
  • ios调整启动图显示的时间
  • Java | Leetcode Java题解之第402题移掉K位数字
  • RabbitMQ 07 另两种集群方式 warren（主备模式），shovel（远程模式）
  • Java算法：二进制和位运算
  • redis的事务与管道有什么不同？