Spring Boot 配置多环境logback

Spring Boot自带Commons logging日志打印功能,添加logback-spring.xml配置文件可实现日志打印。目标是实现多环境log配置,本地输出到控制台,生产、测试输出到文件。同时提到logback配置中若不做特定处理,会出现创建log文件但日志仍在控制台输出的问题。

spring boot 配置logback

spring boot自带了log打印功能,使用的是Commons logging 具体可以参考spring boot log 
因此,我们只需要在resources中添加一个logback-spring.xml的logback的配置文件就可以实现正常的日志打印了。然而我们的目标是要实现多环境log配置,即本地输出到控制台,生产,测试输出到文件。 
logback-spring.xml

 

?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <logger name="org.springframework.web" level="INFO" />

    <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
        <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>
    </appender>

    <springProfile name="prod">
        <!-- 注意这里一定要放到springProfile里, 否则在你本机执行的时候还是会去找相应的文件 -->
        <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!--日志文件输出的文件名-->
                <FileNamePattern>/services/logs/spring-boot-example.%d{yyyy-MM-dd}.log</FileNamePattern>
                <!--日志文件保留天数-->
                <maxHistory>15</maxHistory>
                <totalSizeCap>30GB</totalSizeCap>
            </rollingPolicy>
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <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>10MB</MaxFileSize>
            </triggeringPolicy>
        </appender>

        <appender name="asyncFileAppender" class="ch.qos.logback.classic.AsyncAppender">
            <discardingThreshold>0</discardingThreshold>
            <queueSize>500</queueSize>
            <appender-ref ref="FILE" />
        </appender>
    </springProfile>

    <springProfile name="dev">
        <root level="INFO">
            <appender-ref ref="consoleAppender" />
        </root>
    </springProfile>

    <springProfile name="junit">
        <root level="INFO">
            <appender-ref ref="consoleAppender" />
            <appender-ref ref="asyncFileAppender" />
        </root>
    </springProfile>
    <springProfile name="test">
        <root level="INFO">
            <appender-ref ref="asyncFileAppender" />
        </root>
    </springProfile>
    <springProfile name="pro">
        <root level="INFO">
            <appender-ref ref="asyncFileAppender" />
        </root>
    </springProfile>

</configuration>

 

application.yaml

 

spring:
  profiles:
    active: dev
---
server:
  port: 8001
spring:
  profiles: dev
  output:
    ansi:
      enabled: detect #配置输出console的ide中的配色,并没有什么用
---
server:
  port: 8009
spring:
  profiles: test
---
server:
  port: 8008
spring:
  profiles: prod

 

注意在logback-spring.xml的配置中,如果不把<appender name="FILE></append>放到<springPofile></springPofile>中,就算你只是输出到console, 还是会去创建FILE中设置的log文件

当然日志还是在控制台输出,并不会写到log文件中。这个问题并不仅仅出现在spring boot 中,是logback本身的问题,就算不用spring也会出现这种问题

Spring Boot 项目中,Logback 是默认的日志实现框架,并通过 SLF4J 提供统一的日志门面。Logback 支持多种日志输出方式,包括控制台、文件等,并且可以根据不同环境配置灵活的日志策略。 ### 配置 Logback 的方式 Spring Boot 允许通过 `application.yml` 或 `application.properties` 指定日志配置文件的位置。例如,可以在 `application.yml` 中指定使用自定义的 `logback-spring.xml` 文件: ```yaml logging: config: classpath:logback-spring.xml ``` 该配置指示 Spring Boot 使用指定路径下的 Logback 配置文件来初始化日志系统 [^4]。 ### 编写 Logback 配置文件 Logback 的核心配置文件通常命名为 `logback.xml` 或 `logback-spring.xml`,后者支持 Spring 的 Profile 配置,便于根据不同环境(如开发、测试、生产)动态切换日志输出策略。 以下是一个基础的 `logback-spring.xml` 示例,展示了如何配置控制台和文件日志输出: ```xml <?xml version="1.0" encoding="UTF-8"?> <configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>logs/app.log</file> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <root level="info"> <appender-ref ref="STDOUT"/> <appender-ref ref="FILE"/> </root> </configuration> ``` 此配置定义了两个 Appender:一个用于将日志输出到控制台,另一个用于写入本地文件。Root Logger 设置为 `info` 级别,表示只记录 `info` 及以上级别的日志 [^1]。 ### 使用 SLF4J 记录日志 在 Java 代码中,推荐使用 SLF4J API 来记录日志。以下是一个典型的日志记录示例: ```java import org.slf4j.Logger; import org.slf4j.LoggerFactory; @RestController public class MyController { private static final Logger logger = LoggerFactory.getLogger(MyController.class); @GetMapping("/log") public String log() { logger.info("日志记录"); int a = 12344; logger.info("打印a值:{}", a); return "Logged message!"; } } ``` 上述代码展示了如何在控制器中引入 Logger 并记录信息级别的日志 [^4]。 ### 日志滚动与异步记录 为了管理日志文件大小并避免磁盘空间耗尽,Logback 提供了 `RollingFileAppender`,可以按时间或文件大小自动滚动日志文件。例如: ```xml <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> <!-- 保留30天的历史记录 --> <maxHistory>30</maxHistory> </rollingPolicy> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> ``` 此外,若需提升性能,可使用 `AsyncAppender` 实现异步日志记录: ```xml <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender"> <appender-ref ref="ROLLING_FILE"/> </appender> ``` ### 多环境日志配置 借助 Spring 的 Profile 功能,可以在 `logback-spring.xml` 中定义不同环境的日志行为。例如: ```xml <springProfile name="dev"> <root level="debug"> <appender-ref ref="STDOUT"/> </root> </springProfile> <springProfile name="prod"> <root level="warn"> <appender-ref ref="FILE"/> </root> </springProfile> ``` 上述配置表示,在 `dev` 环境下启用 `debug` 级别的日志并输出到控制台;而在 `prod` 环境下仅记录 `warn` 及以上级别日志并写入文件 [^1]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值