Spring Boot 输出日志到文件(简单配置或使用 logback.xml 文件)

1. 简单配置

如果不需要进行复杂的日志配置，则在配置文件中进行简单的日志配置即可，默认情况下，SpringBoot日志只记录到控制台，不写日志文件。如果希望在控制台输出之外编写日志文件，则需要在 application.yml 配置文件中进行配置

logging:
  file:
    name:  D:/Projects/spring-test.log  # 日志文件绝对路径及名称
  level:
    root: info #日志级别 root表示所有包，也可以单独配置具体包 fatal>error>warn>info>debug>trace>off

注意: Spring Boot中的logging.path和logging.file这2个属性，只需要配置其中之一即可，如果同时配置，则使用logging.file属性。

当配置了loggin.path属性时，将在该路径下生成spring.log文件，即：此时使用默认的日志文件名spring.log
当配置了loggin.file属性时，将在指定路径下生成指定名称的日志文件。默认为项目相对路径，可以为logging.file指定绝对路径

2. 使用 logback.xml 文件扩展配置

Spring Boot包含许多Logback扩展，可以帮助进行高级配置。您可以在您的logback-spring.xml配置文件中使用这些扩展。如果需要比较复杂的配置，建议使用扩展配置的方式

2.1 在 application.yml 中配置

logging:
  config: classpath:logback-spring.xml

2.2 logback.xml 相关配置示例

以下是项目常见的完整logback-spring.xml，SpringBoot默认扫描classpath下面的logback.xml、logback-spring.xml，所以不需要再指定spring.logging.config, 一般我们将 logback.xml 文件放到 resource目录下

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址, 这里设置为项目的根目录-->
    <property name="LOG_HOME" value="log" />
    <!--日志文件名称：这里spring.application.name表示工程名称-->
    <springProperty scope="context" name="APP_NAME" source="spring.application.name"/>
    <!--默认配置-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <!--配置控制台(Console)-->
    <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>

    <!-- 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的目录及文件名-->
            <FileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>15</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>100MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 多环境配置 按照active profile选择分支 -->
    <springProfile name="local">
        <!--root节点 全局日志级别，用来指定最基础的日志输出级别-->
        <root level="INFO">
            <!-- 将日志输出到文件-->
            <appender-ref ref="FILE" />
            <!-- 将日志输出到控制台-->
            <appender-ref ref="CONSOLE"/>
        </root>
        <!-- 子节点向上级传递 局部(包级)日志级别-->
        <logger level="WARN" name="org.springframework"/>
        <logger level="WARN" name="com.netflix"/>
        <logger level="DEBUG" name="org.hibernate.SQL"/>
    </springProfile>

    <springProfile name="onlinepre">
        <root level="INFO">
            <appender-ref ref="FILE" />
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
</configuration>

以上配置会在项目根目录的同级目录下生成 log/{日期}.log 的日志文件, 若打成 .jar包运行, 则日志文件会生成在 . jar 文件的同级目录下

3. Logback日志路径保存配置

3.1 配置1

<!--定义日志文件的存储地址, 这里设置为项目的根目录, 勿在LogBack的配置中使用相对路径-->
<property name="LOG_HOME" value="log" />

1. 若项目未打成.jar文件, 运行项目, 日志文件会保存在项目的根目录下
2. 若项目打成.jar文件, 运行.jar文件, 日志文件会保存在.jar文件同级目录下

3.2 配置2

<property name="log.dir" value="${LOG_PATH:-../log}"/>

1. 若项目未打成.jar文件, 运行项目, 日志文件会保存在项目的根目录的同级目录下
2. 若项目打成.jar文件, 运行.jar文件, 日志文件会保存在.jar文件的上级目录下

参考:

SpringBoot系列——Logback日志，输出到文件以及实时输出到web页面

logback的使用和logback.xml详解，在Spring项目中使用log打印日志

使用Logback日志保存到相对路径记录