Logback-spring.xml 配置屏蔽特定路径的日志

在 Spring Boot 项目中，使用 logback-spring.xml 配置屏蔽特定路径的日志有两种常用方式：

方案一：基础配置（直接关闭目标路径日志）

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 屏蔽 com.example.sensitive 包及其子包的所有日志 -->
    <logger name="com.example.sensitive" level="OFF" />

    <!-- 若需精确屏蔽特定类 -->
    <logger name="com.example.service.SensitiveService" level="OFF" />
    
    <!-- Spring Boot 默认控制台输出 -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

方案二：结合 Spring Profile 按环境屏蔽

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <springProfile name="prod">
        <!-- 生产环境屏蔽指定包日志 -->
        <logger name="com.example.debug" level="OFF" />
    </springProfile>

    <springProfile name="dev,test">
        <!-- 开发/测试环境保留全部日志 -->
        <logger name="com.example.debug" level="DEBUG" />
    </springProfile>
    
    <!-- 公共配置 -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

关键配置说明：

1. ​精准路径屏蔽​

   <logger name="完整的包或类路径" level="OFF" />

   • name 属性：支持包路径（如 com.example.util）或全限定类名（如 com.example.util.CryptoUtils）
   • 包路径会屏蔽该包及其所有子包下的日志

2. ​避免日志传递​（可选）
   添加 additivity="false" 防止日志事件向上传递：

   <logger name="com.example.noisy" level="OFF" additivity="false" />

3. ​使用 Spring Profile​
   <springProfile> 标签支持基于环境变量动态控制：

   <!-- 多环境控制示例 -->
   <springProfile name="!prod">  <!-- 非生产环境生效 -->
        <logger name="com.example.temp" level="DEBUG" />
   </springProfile>

验证生效：

1. ​检查路径匹配​：

   • 包路径：com.example.sensitive 会屏蔽：
     • com.example.sensitive.Service
     • com.example.sensitive.util.Helper
     • 等所有子包中的类

2. ​测试日志输出​：

   // 被屏蔽的类
   package com.example.sensitive;
   
   public class SecureService {
       private static final Logger log = LoggerFactory.getLogger(SecureService.class);
       
       public void process() {
           log.debug("这条日志应该被隐藏"); // 不会输出
           log.error("这条日志也会被隐藏"); // OFF 级别会屏蔽所有级别
       }
   }

常见问题解决：

1. ​屏蔽不生效​：

   • 检查路径是否正确（区分大小写）
   • 确保没有其他配置覆盖（如根 logger 设置）
   • 确认配置位置：src/main/resources/logback-spring.xml

2. ​部分屏蔽​：

   • 若需保留错误日志：

     <logger name="com.example.large" level="ERROR" /> <!-- 只显示 ERROR 及以上 -->

3. ​环境变量控制​：

   • 启动时指定 Profile：

     java -jar app.jar --spring.profiles.active=prod

提示：Spring Boot 会自动加载 logback-spring.xml 并支持热更新（默认扫描间隔 30 秒），无需重启应用即可生效。