SpringBoot 2.x 日志配置 (logback配置文件配置)

本文详细介绍SpringBoot项目中如何自定义日志配置,包括控制台和文件输出,日志级别控制,以及彩色日志显示。同时,文章还提供了完整的logback-spring.xml配置示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

img_44dff828ac6420c7a675cf132a4bd103.png
错误日志

相信同学们已经对日志相关的操作已经很熟悉了,从SSM过来的同学肯定非常怀念那些日志的配置文件。那么SpringBoot 2.x 如何来配置自己的日志文件的配置文件以及日志输入呢?


img_608948ff363c7e3e8629f9e14df75b53.png
Spring Boot 项目结构
再resources 下面新增日志配置文件

logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration  scan="true" scanPeriod="10 seconds">

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

    <contextName>logback</contextName>
    <!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。 -->
    <property name="log.path" value="D:/mylogs/logs" />

    <!-- 彩色日志 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>


    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!--输出到文件-->

    <!-- 时间滚动输出 level为 DEBUG 日志 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_debug.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志归档 -->
            <fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录debug级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 时间滚动输出 level为 INFO 日志 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_info.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 时间滚动输出 level为 WARN 日志 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_warn.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录warn级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!-- 时间滚动输出 level为 ERROR 日志 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>${log.path}/log_error.log</file>
        <!--日志文件输出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 此处设置字符集 -->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文件只记录ERROR级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--
        <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
        以及指定<appender>。<logger>仅有一个name属性,
        一个可选的level和一个可选的addtivity属性。
        name:用来指定受此logger约束的某一个包或者具体的某一个类。
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
              还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。
              如果未设置此属性,那么当前logger将会继承上级的级别。
        addtivity:是否向上级logger传递打印信息。默认是true。
    -->
    <!--<logger name="org.springframework.web" level="info"/>-->
    <!--<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->
    <!--
        使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
        第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
        第二种就是单独给dao下目录配置debug模式,代码如下,这样配置sql语句会打印,其他还是正常info级别:
     -->


    <!--
        root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
        level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
        不能设置为INHERITED或者同义词NULL。默认是DEBUG
        可以包含零个或多个元素,标识这个appender将会添加到这个logger。
    -->

    <!--开发环境:打印控制台-->
    <springProfile name="dev">
        <logger name="com.nmys.view" level="debug"/>
    </springProfile>

    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEBUG_FILE" />
        <appender-ref ref="INFO_FILE" />
        <appender-ref ref="WARN_FILE" />
        <appender-ref ref="ERROR_FILE" />
    </root>

    <!--生产环境:输出到文件-->
    <!--<springProfile name="pro">-->
    <!--<root level="info">-->
    <!--<appender-ref ref="CONSOLE" />-->
    <!--<appender-ref ref="DEBUG_FILE" />-->
    <!--<appender-ref ref="INFO_FILE" />-->
    <!--<appender-ref ref="ERROR_FILE" />-->
    <!--<appender-ref ref="WARN_FILE" />-->
    <!--</root>-->
    <!--</springProfile>-->

</configuration>
SpringBoot配置文件配置扫描日志文件与日志写出路径
img_d143bd5882879edd3c030d8fadb01500.png
配置文件
img_41932bfe0509bb600cec539983bacd54.png
日志输出路径

日志配置完成之后,下次启动项目所有的日志都会被记录在日志输出的文件夹中。

<think>首先,用户的问题是:“我想了解如何在SpringBoot的application.yml中配置以控制logback-spring.xml的日志优先级。”这涉及SpringBoot日志配置,特别是通过application.yml来控制logback-spring.xml的日志优先级。关键元素:-用户提到了引用[1]、[2]、[3]、[4],这些是关于日志配置SpringBoot加载配置文件的信息。-根据系统指令,我需要使用中文回答。-回答结构清晰,逐步解决问题。-确保回答真实可靠。-末尾添加引用标识,例如[^1],引用相关的段落。-最后生成相关问题。回忆系统级指令:1.行内数学表达式用$...$(但在这个问题中可能不适用)。2.独立公式用$$...$$(可能不相关)。3.LaTeX语法正确(可能不需要)。4.使用中文回答。5.生成相关问题。6.回答中引用的段落末尾自然地添加引用标识。问题核心:如何在application.yml中设置logback-spring.xml的日志优先级。优先级可能指日志级别(如DEBUG、INFO等)。引用内容回顾:-引用[1]:讨论使用logback-spring.xml优于logback.xml,因为它支持SpringBoot特有的配置。-引用[2]:解释如何在Spring项目中自动加载logback.xml,而在SpringBoot中加载logback-sping.xml(拼写错误,应为logback-spring.xml),SpringBoot如何加载它。-引用[3]:提到application.yml加载优先级,以及如何通过命令行指定配置位置。-引用[4]:关于application.yml配置大全的参考网址。用户问题:指定在application.yml中控制logback-spring.xml的日志优先级。这里的“优先级”可能是个误解。通常,在日志配置中,“优先级”可能是指日志级别(如DEBUG、INFO、WARN、ERROR),而不是配置文件的加载顺序。用户说“日志优先级”,我认为它指的是日志记录的级别优先级。在SpringBoot中,日志级别的配置可以直接在application.yml中设置,不必通过logback-spring.xml。但用户想控制logback-spring.xml的优先级,可能意味着在yml中覆盖或设置logback配置。最佳实践:-SpringBoot允许在application.properties或application.yml中配置日志级别。-对于logback,可以通过logging.level前缀在yml中设置特定包或类的日志级别。-同时,logback-spring.xml可以定义更详细的配置,但yml可以覆盖某些设置。根据SpringBoot文档:-使用logging.level.*在yml中设置日志级别,如:logging.level.com.example:DEBUG。-logback-spring.xml可以使用SpringBoot的环境变量,包括application.yml中的属性,但不是直接“控制优先级”;yml中的设置通常会覆盖logback配置,因为SpringBoot加载yml后用于配置日志。具体回答:1.解释如何在application.yml中配置日志级别。2.提到logback-spring.xml的角色,但它主要用于定义appenders、布局等;级别可以在yml中设置。3.参考用户提到的引用:特别是引用[1]和[3]。引用标识:-在相关地方添加引用,如当提到SpringBoot推荐使用logback-spring.xml时,添加[^1]。-当讨论加载位置时,提到[^3]。回答结构:-逐步解释:-介绍SpringBoot日志配置方式。-如何在application.yml中设置日志优先级(级别)。-关联logback-spring.xml。-代码示例在yml中配置。-用中文。-最后生成相关问题。生成相关问题:-根据系统指令,末尾生成相关问题,基于这个主题。最终回答框架:1.开头简述问题。2.解释核心概念。3.提供配置方法。4.给出例子。5.添加引用。6.结束并生成相关问题。示例代码用yml格式,不是Python。确保真实性:基于SpringBoot官方文档。</think> ### 在Spring Boot中配置logback日志优先级的方法 您的查询聚焦于如何在Spring Boot的`application.yml`文件中设置日志优先级(即日志级别,如DEBUG、INFO、WARN等)来控制`logback-spring.xml`的行为。日志优先级决定了日志信息的详细程度,例如,设置为DEBUG级别会输出所有详细信息,而ERROR级别仅输出错误信息。Spring Boot默认使用Logback作为日志框架,支持通过`application.yml`动态覆盖或扩展`logback-spring.xml`中的配置。我将一步步解释如何实现此目标,确保配置可靠且符合Spring Boot最佳实践。 #### 1. **理解Spring Boot日志配置机制** 在Spring Boot中,日志级别的优先级设置可以直接在`application.yml`中完成,而不必修改`logback-spring.xml`文件。原因如下: - **应用优先级规则**:Spring Boot会优先加载`application.yml`中的配置(位置优先级最高),然后结合`logback-spring.xml`文件。`application.yml`中的日志级别设置会覆盖`logback-spring.xml`中的相应定义,这使得动态调整级别变得非常灵活[^1]。 - 例如,如果您在`logback-spring.xml`中设置了一个日志级别的阈值,在`application.yml`中通过`logging.level`前缀重新指定时,Spring Boot会采用`application.yml`的值。 - **`logback-spring.xml`的作用**:该文件用于定义日志输出格式、appenders(如文件或控制台输出)和策略。但日志级别作为核心可变量,更适合在`application.yml`中设置,因为它支持环境变量和多环境配置(如dev/test/prod)[^1][^2]。 - **加载顺序**:Spring Boot启动时,会先解析`application.yml`,然后应用其日志配置Logback框架中。这确保了yml中的设置能有效控制优先级[^3]。 #### 2. **在application.yml中设置日志优先级的方法** 在`application.yml`中,您可以使用`logging.level`前缀来指定不同包或类的日志级别。以下是完整的设置步骤和示例: - **语法格式**:使用键值对形式,`logging.level.<包名或类名> = <级别>`。 - 级别包括:TRACE, DEBUG, INFO, WARN, ERROR, OFF。 - 通配符`*`表示根包名下的所有类。 - **示例配置**: ```yaml # application.yml中的日志优先级配置 logging: level: root: INFO # 设置根日志级别为INFO(默认优先级) com.example: DEBUG # 设置特定包(如com.example)的级别为DEBUG org.springframework.web: ERROR # 设置Spring Web包的级别为ERROR your.custom.package: WARN # 设置自定义包的级别 ``` - **解释**: - 上述配置将全局日志根级别设为INFO,这意味着所有日志默认输出INFO及以上级别的信息。 - 如果指定了包名(如`com.example`),该包下的所有日志会覆盖根级别,设置为DEBUG级别(例如,用于开发环境)。 - 此配置在启动时生效,无需修改`logback-spring.xml`;如果`logback-spring.xml`中定义了相同包的级别,yml设置会覆盖它[^1][^3]。 - **关联logback-spring.xml**: - 在`logback-spring.xml`中,您可以引用yml中的属性(通过Spring的`<springProperty>`标签),但优先级级别通常不在xml中硬编码,而是在yml中动态管理。 - 示例logback-spring.xml片段: ```xml <!-- 在logback-spring.xml中,yml优先级设置已自动生效 --> <configuration> <!-- 使用yml定义的级别 --> <root level="INFO"> <!-- 这个会被yml中的logging.level.root覆盖 --> <appender-ref ref="CONSOLE" /> </root> </configuration> ``` - 注意:yml中的`logging.level`设置优先级更高,所以xml中的`level`属性会被忽略或叠加。推荐在xml中仅定义输出策略,级别在yml中控制[^2]。 #### 3. **验证和调优配置** - **启动时检查**:在Spring Boot应用启动日志中,查找类似“Loaded Logback config from class path resource [logback-spring.xml]”的消息,确保yml配置已加载。 - **命令行覆盖**:如果您需要临时更改优先级(如测试环境中调试),可以通过命令行参数覆盖yml: ```bash java -jar your-app.jar --logging.level.com.example=TRACE ``` - 这种方法不需要修改yml文件,提高了灵活性,优先级继承自yml但可被覆盖[^3]。 - **最佳实践**: - 始终使用`logback-spring.xml`而非logback.xml,因为前者支持Spring Boot特有的占位符和环境变量,增强了与yml的互操作[^1]。 - 在yml中设置级别时,结合多环境配置(如使用`spring.profiles.active`),针对不同场景(如本地开发用DEBUG,生产用WARN)调整优先级。 - 参考官方文档(如引用[4]中的链接)获取完整属性列表,确保配置兼容最新版本[^4]。 #### 4. **常见问题处理** - **配置无效的情况**: - 检查yml文件是否正确加载:确保`application.yml`位于资源目录(如`src/main/resources`),且文件名正确。 - 冲突解决:如果yml和xml中都设置了级别,yml优先;如果多个yml文件(如application-dev.yml),优先级基于活动profile。 - 部署时加载顺序:在容器中部署时,优先加载jar包内的yml,但可通过`--spring.config.location`指定外部路径(如`java -jar app.jar --spring.config.location=file:/config/`),确保日志配置生效[^3]。 - **性能影响**:设置低级别(如DEBUG)会增加日志量,可能影响性能;仅在调试时启用,生产环境建议使用INFO或WARN。 ### 总结 通过在Spring Boot的`application.yml`中使用`logging.level`设置,您可以轻松控制logback-spring.xml的日志优先级(级别),实现动态管理和环境适应。核心是在yml中指定包名和级别配置,Spring Boot会自动将其应用到Logback框架中,覆盖xml中的定义。这简化了日志调优,并利用了Spring Boot的配置优先机制。如果您已有`logback-spring.xml`,yml设置将无缝集成[^1][^3]。 如果您需要更具体的yml配置示例或xml引用细节,请提供您的当前设置,我可以进一步优化。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值