在 Spring Boot 中,日志配置是开发和生产环境的关键部分。以下是 Spring Boot 日志配置的完整指南,涵盖默认配置、自定义配置、日志框架切换(Logback/Log4j2)及高级用法。
1. 默认日志配置
Spring Boot 默认使用 Logback 作为日志框架,并自动配置以下行为:
• 控制台输出:日志级别为 INFO
及以上。
• 日志文件:默认不生成文件(需手动配置)。
• 彩色输出:终端支持时启用彩色日志。
2. 基础配置(application.properties
/application.yml
)
(1)设置日志级别
# 设置全局日志级别
logging.level.root=INFO
# 设置特定包或类的日志级别
logging.level.org.springframework=WARN
logging.level.com.example.service=DEBUG
(2)输出到文件
# 输出到指定文件(默认路径为项目根目录)
logging.file.name=logs/app.log
# 或指定目录(自动生成 spring.log)
logging.file.path=logs/
(3)日志格式
# 控制台日志格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
# 文件日志格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
3. 高级配置(Logback 扩展)
Spring Boot 支持通过 logback-spring.xml
自定义配置(优先于默认配置)。
(1)创建 logback-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- 控制台输出 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %highlight(%-5level) %cyan(%logger{36}) - %msg%n</pattern>
</encoder>
</appender>
<!-- 文件输出(按天滚动) -->
<appender name="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>
<maxHistory>30</maxHistory> <!-- 保留30天日志 -->
</rollingPolicy>
<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>
<!-- 环境敏感配置(如开发环境启用 DEBUG) -->
<springProfile name="dev">
<logger name="com.example" level="DEBUG"/>
</springProfile>
</configuration>
(2)启用 Profile 特定配置
在 application.properties
中激活 Profile:
spring.profiles.active=dev
4. 切换至 Log4j2
(1)排除 Logback,引入 Log4j2
<!-- Maven 配置 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
(2)配置 log4j2-spring.xml
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"/>
</Console>
<RollingFile name="File" fileName="logs/app.log"
filePattern="logs/app-%d{yyyy-MM-dd}.log">
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
</Policies>
<DefaultRolloverStrategy max="30"/>
</RollingFile>
</Appenders>
<Loggers>
<Root level="INFO">
<AppenderRef ref="Console"/>
<AppenderRef ref="File"/>
</Root>
<Logger name="com.example" level="DEBUG"/>
</Loggers>
</Configuration>
5. 日志配置最佳实践
• 环境区分:通过 Profile 为开发、生产环境配置不同日志级别。
• 日志滚动:按时间或大小滚动日志文件,避免单个文件过大。
• 敏感信息过滤:在日志模式中排除敏感数据(如密码)。
• 异步日志:在高并发场景下使用异步 Appender 提升性能(Logback/Log4j2 均支持)。
<!-- Logback 异步日志示例 -->
<appender name="ASYNC_FILE" class="ch.qos.logback.classic.AsyncAppender">
<appender-ref ref="FILE"/>
</appender>
6. 常用命令和调试
• 动态调整日志级别(无需重启):
curl -X POST http://localhost:8080/actuator/loggers/com.example -H 'Content-Type: application/json' -d '{"configuredLevel":"DEBUG"}'
• 查看日志端点(需 spring-boot-actuator
):
management.endpoints.web.exposure.include=loggers
通过以上配置,你可以灵活控制 Spring Boot 应用的日志行为,适应不同场景需求。