Spring Boot 自定义日志打印（日志级别、logback-spring.xml 文件、自定义日志打印解读）

于 2025-04-01 07:00:00 发布
阅读量1.6k 收藏 12
点赞数 51
分类专栏： Java - 简化库与框架编程 文章标签： spring spring boot logback java jvm java-ee 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_52173250/article/details/146880043
版权

一、Logback

  1. 在 Spring Boot 中，日志框架默认使用的是 Logback，Spring Boot 提供了对日志配置的简化

  2. Spring Boot 默认会将日志输出到控制台，并且日志级别为 INFO

  3. 可以在 application.yaml 或 application.properties 文件中进行日志配置

  4. 如果需要自定义日志配置，可以使用 logback-spring.xml 文件，Spring Boot 会自动加载该文件

二、日志级别

1、基本介绍
（1）INFO

  1. 一般信息，用于记录应用程序的运行状态

  2. 适用于记录应用程序的关键事件，例如，启动、关闭、重要配置加载等

  3. 用于提供足够信息，帮助了解应用状态，同时避免过多细节

（2）WARN

  1. 警告信息，表示潜在的问题

  2. 适用于记录潜在的问题，例如，配置不当、资源不足等，这些问题不会立即影响运行，但需关注

  3. 用于帮助发现并预防潜在问题

（3）ERROR

  1. 错误信息，表示发生了错误，但应用程序仍可运行

  2. 适用于记录严重错误，如数据库连接失败、关键业务逻辑异常等

  3. 用于快速定位和解决重大问题

（4）DEBUG

  1. 调试信息，用于开发阶段

  2. 适用于调试时，记录详细执行流程、变量值等

  3. 通常关闭，避免日志量过大，必要时可临时开启

（5）TRACE

  1. 最详细的日志信息，通常用于调试

  2. 适用于记录最详细的执行信息，用于深度调试

  3. 一般不开启，除非有特殊需求

2、小结

  1. 应选择合适的日志级别以确保既能捕获关键信息，又不会产生过多冗余日志

  2. 生产环境通常设置为 INFO

  3. 可根据需求调整特定包的日志级别，例如，将某些复杂模块设为 DEBUG

三、Spring Boot 自定义日志打印

1、配置文件
  • 在 logback-spring.xml 文件中配置如下内容
<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!-- 定义日志输出格式 -->
    <property name="CONSOLE_PATTERN" value="[%-5p] %d{yyyy-MM-dd HH:mm:ss} - %m%n"/>
    <property name="FILE_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5p %logger{1}:%line - %m%n"/>

    <!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- 每日滚动文件输出 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>d:/my-logs/application.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>d:/my-logs/application.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory> <!-- 保留历史日志文件的最大天数 -->
        </rollingPolicy>
        <encoder>
            <pattern>${FILE_PATTERN}</pattern>
        </encoder>
    </appender>

    <!-- 根日志配置 -->
    <root level="info">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>

</configuration>
2、测试代码
@Component
public class LogTest {

    private static final Logger logger = LoggerFactory.getLogger(LogTest.class);

    @PostConstruct
    public void test1() {
        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");
    }
}

四、Spring Boot 自定义日志打印解读

1、配置文件
（1）定义日志输出格式
<property name="CONSOLE_PATTERN" value="[%-5p] %d{yyyy-MM-dd HH:mm:ss} - %m%n"/>
<property name="FILE_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5p %logger{1}:%line - %m%n"/>
  • CONSOLE_PATTERN 是控制台日志的输出格式

  1. %-5p：日志级别（例如，INFO、ERROR），左对齐，占 5 个字符

  2. %d{yyyy-MM-dd HH:mm:ss}：日志时间戳

  3. %m：日志消息

  4. %n：换行符

# 输出示例

[INFO ] 2023-10-01 12:34:56 - This is a log message
  • FILE_PATTERN 是文件日志的输出格式。

  1. %d{yyyy-MM-dd HH:mm:ss}：日志时间戳

  2. [%thread]：当前线程名

  3. %-5p：日志级别

  4. %logger{1}:%line：日志记录器的名称（只显示最后一部分）和代码行号

  5. %m：日志消息

  6. %n：换行符

# 输出示例

2023-10-01 12:34:56 [main] INFO  com.example.MyClass:42 - This is a log message
（2）控制台输出配置
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
        <pattern>${CONSOLE_PATTERN}</pattern>
    </encoder>
</appender>

  1. CONSOLE：定义一个名为 CONSOLE 的日志输出目标，输出到控制台

  2. ConsoleAppender：将日志输出到控制台

  3. encoder：定义日志的输出格式，使用前面定义的 CONSOLE_PATTERN

（3）文件输出配置
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>d:/my-logs/application.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>d:/my-logs/application.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
    <encoder>
        <pattern>${FILE_PATTERN}</pattern>
    </encoder>
</appender>

  1. FILE：定义一个名为 FILE 的日志输出目标，输出到文件

  2. RollingFileAppender：支持日志文件滚动（按时间或大小分割）

  3. file：当前日志文件的路径为 d:/my-logs/application.log

  4. rollingPolicy：定义日志滚动策略

  5. TimeBasedRollingPolicy：按时间滚动日志文件

  6. fileNamePattern：滚动后的日志文件命名格式，例如 application.2023-10-01.log

  7. maxHistory：保留最近 30 天的日志文件，超过 30 天的文件会被自动删除

  8. encoder：定义日志的输出格式，使用前面定义的 FILE_PATTERN

（4）根日志配置
<root level="info">
    <appender-ref ref="CONSOLE"/>
    <appender-ref ref="FILE"/>
</root>

  1. root：定义根日志记录器

  2. level="info"：设置日志级别为 INFO，即只记录 INFO 及以上级别（例如，WARN、ERROR）的日志

  3. appender-ref：将日志输出到 CONSOLE 和 FILE 两个目标

2、测试代码
（1）创建 Logger 实例
private static final Logger logger = LoggerFactory.getLogger(LogTest.class);

  1. LoggerFactory 是 SLF4J 提供的工厂类，用于创建 Logger 实例

  2. getLogger(LogTest.class) 方法会根据传入的类（LogTest.class）创建一个与该类关联的 Logger 实例

  3. 日志输出时会自动带上类名（LogTest），方便定位日志来源

（2）打印日志
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");
SpringBoot中自定义日志配置logback-spring.xml
BADAO_LIUMANG_QIZHI的博客
03-27 4272
场景 通过系统属性和传统的SpringBoot外部配置文件依然可以很好的支持日志控制和管理。 不同的日志系统对应的命名规范 Logback:logback-spring.xml logbak-spring.proovy logback.xml logback.groovy Log4j:log4j-spring.properties log4j-spring.xml log4...
配置logback-spring.xml不生效
知识改变命运，ヾ(◍°∇°◍)ﾉﾞ【求关注】
04-19 1593
按照以往的配置文件，始终不生成文件， ┭┮﹏┭┮。
springboot中配置logback-spring.xml
king_66的专栏
10-17 1712
该配置表明：配置日志根级别，也就是日志最低级别，如：debug
SpringBoot应用自定义logback日志
Huangjiazhen711的博客
10-06 1087
默认情况下，SpringBoot内部使用logback作为系统日志实现的框架，将日志输出到控制台，不会写到日志文件。如果在application.properties或application.yml配置，这样只能配置简单的场景，保存路径、日志格式等。复杂的场景（区分 info 和 error 的日志、每天产生一个日志文件等）满足不了，只能自定义配置文件logback-spring.xml或者logback.xml。本篇文章主要讲解下如何自定义logabck.xml以及对logback文件中配置做一个详解。
Spring Boot 自定义日志详解
weixin_33964094的博客
11-16 232
2019独角兽企业重金招聘Python工程师标准>>> ...
SpringBoot如何使用日志Logback，及日志等级详解
分享学习
05-29 1949
Spring Boot默认已经集成了SLF4J（Simple Logging Facade for Java）作为日志的接口，以及Logback作为日志的实现。这意味着在大多数情况下，你无需做额外的配置即可开始记录日志。下面是一个简要的指南，包括如何在Spring Boot应用中使用SLF4J和Logback，以及一些实际的代码示例。
SpringBoot日志
huapiaoy的博客
10-05 2565
我们说spring使用了slf4j框架，但是整个框架也不是一个真正的日志实现，而是一个抽象层，他对现有的一些日志框架制定了一种规范标准，也就是slf4j就是个接口，所以slf4j，需要和具体的日志框架配合使用slf4j就是其他日志框架的门面，可以理解为提供日志服务的统一API接口，并不涉及到具体日志逻辑实现。
Springboot日志级别
m0_67390788的博客
04-26 2396
一、开启Springboot详细日志 在application.properties文件中添加以下代码 logging.level.root=debug 二、sql打印在控制台 在application.properties文件中添加以下代码 logging.level.com.jdkj.monthlySalePerformanceAppraisal.dao=debug ...
SpringBoot之logback-spring.xml不生效的解决方法
08-28
当使用logback作为日志框架时，通常我们会将配置文件放在`src/main/resources`目录下，命名为`logback-spring.xml`，这是因为Spring Boot默认支持`logback-spring.xml`，它能与Spring的自动配置机制集成。...
logback-spring.xml日志打印demo
06-01
这里`logLevel`是自定义变量名，`source`则是Spring Boot的配置属性，如`logging.level.root`控制应用的根日志级别。 4. **`<appender>`标签**： 定义日志输出的目标，如控制台、文件、数据库等。例如，定义一个...
SpringBoot中自定义日志配置logback-spring.xml示例源码
03-26
SpringBoot中自定义日志配置logback-spring.xml示例源码
springboot的日志级别
xajh_czbk的博客
05-13 663
链接：Log日志级别从高到低排序 ERROR、WARN、INFO、DEBUG - 零度千里 - 博客园
SpringBoot日志输出级别：配置和使用指南
辰兮要努力
01-17 3081
SpringBoot日志输出级别：配置和使用指南
springboot日志的级别
qq_34158283的博客
02-06 639
【代码】springboot日志的级别。
spring boot日志
weixin_47737825的博客
12-31 506
共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF。Spring Boot 默认是用 logback 的日志框架的，所以需要排除 logback，不然会出现 jar 依赖冲突的报错。Console 节点、File 节点、RollingFile 节点的子节点，指定输出格式，不设置默认为：%m%n。：如果一条日志信息的级别大于等于配置文件的级别，就记录。SimpleLayout：以简单的形式显示。FILE（输出到文件）
SpringBoot开发中的日志级别
weixin_57333931的博客
06-20 1394
在SpringBoot开发中，日志系统是一个不可或缺的部分，它帮助我们跟踪应用程序的运行状态、调试代码以及监控性能。然而，随着日志信息的不断增加，如何合理设置日志级别成为了一个需要关注的问题。不合理的日志级别设置可能会导致关键信息被淹没在大量的日志中，或者重要日志因级别设置过高而被忽略。因此，本文将介绍SpringBoot中的日志级别及其使用步骤。在SpringBoot开发中，合理地设置和使用日志级别对于提高开发效率、监控应用程序运行状态以及排查问题至关重要。
logback-spring.xml打印日志
最新发布
03-20
### 配置 logback-spring.xml 实现日志打印 在 Spring Boot 项目中，`logback-spring.xml` 是用于自定义日志配置的核心文件。以下是关于如何正确配置 `logback-spring.xml` 来实现日志打印的具体方法。 #### 日志配置概述 Spring Boot 启动时会优先加载名为 `logback-spring.xml` 的文件作为日志系统的配置文件[^2]。如果没有找到此文件，则会退而求其次寻找 `logback.xml` 文件。由于 `logback-spring.xml` 支持更多高级功能（如 `${}` 占位符解析和基于 profile 的条件化配置），因此推荐使用它来进行日志管理。 #### 使用占位符引入外部属性 可以通过 `${}` 占位符机制，在 `logback-spring.xml` 中引用来自 `application.yml` 或者 `application.properties` 定义的变量。例如： ```xml <!-- application.yml --> logging: path: /var/log/myapp/ <!-- logback-spring.xml --> <configuration> <!-- 将 logging.path 属性映射到 log.path --> <property name="LOG_PATH" value="${logging.path}" /> <!-- 设置日志文件名 --> <property name="LOG_FILE_NAME" value="my-application.log" /> <!-- 控制台输出 --> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <!-- 文件输出 --> <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${LOG_PATH}/${LOG_FILE_NAME}</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${LOG_PATH}/%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <encoder> <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern> </encoder> </appender> <!-- Root logger level --> <root level="info"> <appender-ref ref="CONSOLE" /> <appender-ref ref="FILE" /> </root> </configuration> ``` 上述代码片段展示了如何设置控制台和文件两种类型的 appender，并利用滚动策略按日期归档日志文件[^4]。 #### 特殊场景下的优化建议 为了适应更复杂的应用需求，可以进一步扩展配置逻辑： - **多环境适配**：借助 `<springProfile>` 标签实现针对开发、测试或生产环境的不同日志级别与路径设定。 ```xml <springProfile name="dev"> <root level="debug"> <appender-ref ref="CONSOLE"/> </root> </springProfile> <springProfile name="prod"> <root level="warn"> <appender-ref ref="FILE"/> </root> </springProfile> ``` - **权限校验**：确保指定的日志目录存在且应用程序对该目录拥有写入权限。 #### 总结 通过合理设计 `logback-spring.xml` 文件结构以及灵活运用其内置特性，能够显著提升项目的可维护性和运行效率。务必注意实际部署环境中可能存在的差异性因素，比如操作系统类型或者磁盘空间限制等问题的影响。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值