【Springboot总结】日志文件logback.xml

本文详细解析了Logback配置文件的各项属性,如scan、scanPeriod、debug等,以及如何配置控制台输出、滚动文件输出、日志级别和格式。通过实例展示了如何实现日志按时间和大小滚动,以及日志文件的归档策略。

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

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="atguigu-springboot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式:
			%d表示日期时间,
			%thread表示线程名,
			%-5level:级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符,否则按照句点分割。 
			%msg:日志消息,
			%n是换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
        TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动 
            %i:当文件大小超过maxFileSize时,按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动,
            且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是,
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式: -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象,也可以定义日志类型、级别
		name:表示匹配的logger类型前缀,也就是包的前半部分
		level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出,
		false:表示只用当前logger的appender-ref,true:
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.atguigu" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>



    <!-- 
    root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,
    要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration> 

 

### 配置SpringBoot项目在Linux环境中正确加载logback.xml 为了使Spring Boot项目能够在Linux环境下正确加载`logback.xml`文件,需遵循以下原则: #### 1. 文件路径与命名规则 Spring Boot官方建议优先使用带有`-spring`后缀的文件名来配置日志(如`logback-spring.xml`)。如果希望继续使用`logback.xml`作为日志配置文件,则需要将其放置于类路径下的`resources`目录中[^1]。 ```bash src/main/resources/logback.xml ``` 当Spring Boot应用启动时,默认会查找`logback-spring.xml`或`logback.xml`。如果没有找到这些文件,它将回退到默认的日志配置[^2]。 --- #### 2. 自定义日志配置文件位置 如果需要指定其他名称或路径的日志配置文件,可以在`application.properties`或`application.yml`中通过`logging.config`属性设置自定义路径[^3]。 ##### 使用 `application.properties` ```properties logging.config=classpath:custom-logback.xml ``` ##### 使用 `application.yml` ```yaml logging: config: classpath:custom-logback.xml ``` 注意:这里的路径应相对于项目的类路径(`classpath:`),或者是一个绝对路径(如`/etc/myapp/custom-logback.xml`)。 --- #### 3. Linux环境中的注意事项 在Linux系统中部署Spring Boot应用程序时,需要注意以下几个方面以确保`logback.xml`能够被正确加载: - **文件权限** 确保`logback.xml`文件具有适当的读取权限。可以通过以下命令检查并修改权限: ```bash ls -l src/main/resources/logback.xml chmod 644 src/main/resources/logback.xml ``` - **路径区分大小写** Linux文件系统是区分大小写的,因此务必确认文件名为`logback.xml`而非其他变体(如`Logback.xml`或`LOGBACK.XML`)。 - **打包后的资源访问** 如果是以JAR包形式运行Spring Boot应用,那么`logback.xml`会被打包进JAR文件内部。此时,Spring Boot仍然可以从JAR内的`resources`目录中加载该文件[^4]。 --- #### 4. 测试日志配置是否生效 为了验证`logback.xml`是否成功加载,可以查看应用启动时的日志输出。正常情况下,应该能看到类似于以下的信息: ```plaintext 18:34:58,011 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Found resource [logback.xml] at [...] ``` 如果未发现上述信息,可能是因为: - 文件不存在或路径错误; - 文件权限不足; - 应用程序未能识别指定的配置文件。 --- #### 5. 示例代码 以下是完整的`logback.xml`示例配置以及如何在Linux环境中运行Spring Boot应用的方法。 ##### logback.xml 示例 ```xml <configuration> <!-- 控制台输出 --> <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.FileAppender"> <file>/var/logs/app.log</file> <append>true</append> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <!-- 设置根日志级别 --> <root level="info"> <appender-ref ref="CONSOLE"/> <appender-ref ref="FILE"/> </root> </configuration> ``` ##### 运行Spring Boot应用 假设已构建好可执行的JAR包,可通过以下方式运行: ```bash nohup java -jar my-app.jar > /dev/null 2>&1 & ``` --- ### 总结 通过以上方法,在Linux环境下配置Spring Boot项目以正确加载`logback.xml`的关键在于: - 将`logback.xml`置于正确的类路径下; - 确认文件权限和路径无误; - 利用`logging.config`属性灵活调整日志配置文件的位置。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值