logback.xml配置文件怎么写 Spring Boot日志配置

Spring Boot 默认使用 Logback,推荐配置 logback-spring.xml 以支持 Profile 和变量绑定;基础配置含控制台与按天滚动文件日志,可按环境(dev/prod)差异化设置,支持异步、包级控制、敏感信息过滤等定制。

Spring Boot 默认使用 Logback 作为日志框架,只需在 src/main/resources 下添加 logback-spring.xml(推荐)或 logback.xml,就能覆盖默认配置。优先用 logback-spring.xml,它支持 Spring Profile、变量绑定等增强特性。

基础结构:一个可运行的 logback-spring.xml

以下是最小可用配置,支持控制台输出 + 按天滚动文件日志:



  
  
  

${LOG_FILE} %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n ${LOG_PATH}/app.%d{yyyy-MM-dd}.%i.log 100MB 30

按环境区分日志配置(用 springProfile)

利用 标签,不同 profile 加载不同设置:

  • 开发环境(dev):只输出到控制台,INFO 级别,带颜色
  • 生产环境(prod):关闭控制台,启用压缩归档,更严格级别(如 WARN)

示例片段:


  
    
  

常用自定义技巧

  • 动态日志路径:用 ${LOG_PATH:-./logs} 设置默认值,避免空值报错
  • 包级别日志控制:比如让 MyBatis 打印 SQL,在 root 下加:
    
    
  • 过滤敏感信息:用 PatternLayoutEncoder 配合自定义 converter,或用 Filter 拦截含密码的日志行
  • 异步写日志:对 FILE appender 包一层 AsyncAppender,降低 I/O 对主线程影响

注意事项与调试建议

  • 文件名必须是 logback-spring.xml 才能启用 Spring 扩展;叫 logback.xml 会跳过 profile 支持
  • 修改后重启应用才生效;开发时可加 debug="true" 到 configuration 标签查看 Logback 加载过程
  • 若日志没输出,检查 classpath 是否有多个 logback 配置,或是否被其他依赖(如 slf4j-simple)干扰
  • 线上禁用 CONSOLE appender,避免 stdout/stderr 冲突或丢失

基本上就这些。不复杂但容易忽略细节——比如 profile 名要和 spring.profiles.active 一致,路径权限要确保应用可写,滚动策略参数大小写敏感(maxFileSize 不是 MaxFileSize)。配好之后,日志就稳了。