Springboot内外部logback多环境配置

Springboot内外部logback多环境配置

一、概述

• SpringBoot官方文档
• Springboot 默认读取的是项目内的 resources 中 logback 配置文件。
• 如果 classpath（resources） 下有logback-test.xml会优先生效，并且会和其他logback文件同时生效。
• Springboot 默认日志级别是DEBUG，所以在logback初始化之前，会有DEBUG日志输出。

二、项目内外配置

注意：logback-{xxx}.xml不能直接放在resources目录下，否则logback-test.xml会优先生效。

• 1.application.yml指定 activeprofiles

  # Spring配置
  spring:
    profiles:
      active: test
  

• 2.activeprofiles指定logback-{xxx}.xml

  ########## logback-{xxx}.xml 文件打包在项目内部 ##########
  logging:
     config: classpath:logback/logback-test.xml
  
  ########## logback-{xxx}.xml 文件打包在项目外部（去掉classpath） ##########
  logging:
    config: /Users/wangfugui/Downloads/logback/logback-test.xml
  

• 3.logback-{xxx}.xml

  <?xml version="1.0" encoding="UTF-8"?>
  <configuration>
      <!--************************** 测试环境 ****************************-->
      <!-- 日志根路径(绝对路径) -->
      <!--    <property name="log.basePath" value="/Users/wangfugui/Downloads/appname"/>-->
      <!-- 日志根路径(相对路径)，如果使用外部 tomcat，则日志会在bin目录，需要加../ -->
      <property name="log.basePath" value="logs-test"/>
      <!-- 日志存放路径 -->
      <property name="log.path" value="/" />
      <!-- 不同的appender，统一日志输出格式 -->
      <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />
  
      <!-- 控制台输出 -->
      <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
          <encoder>
              <pattern>${log.pattern}</pattern>
          </encoder>
      </appender>
  
      <!-- INFO日志输出 -->
      <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
          <file>${log.basePath}/${log.path}/sys-info.log</file>
          <!-- 循环政策：基于时间创建日志文件 -->
          <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
              <!-- 日志文件名格式 -->
              <fileNamePattern>${log.basePath}/${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
              <!-- 日志最大的历史 60天 -->
              <maxHistory>60</maxHistory>
          </rollingPolicy>
          <encoder>
              <pattern>${log.pattern}</pattern>
          </encoder>
          <filter class="ch.qos.logback.classic.filter.LevelFilter">
              <!-- 过滤的级别 -->
              <level>INFO</level>
              <!-- 匹配时的操作：接收（记录） -->
              <onMatch>ACCEPT</onMatch>
              <!-- 不匹配时的操作：拒绝（不记录） -->
              <onMismatch>DENY</onMismatch>
          </filter>
      </appender>
  
      <!-- ERROR日志输出 -->
      <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
          <file>${log.basePath}/${log.path}/sys-error.log</file>
          <!-- 循环政策：基于时间创建日志文件 -->
          <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
              <!-- 日志文件名格式 -->
              <fileNamePattern>${log.basePath}/${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern>
              <!-- 日志最大的历史 60天 -->
              <maxHistory>60</maxHistory>
          </rollingPolicy>
          <encoder>
              <pattern>${log.pattern}</pattern>
          </encoder>
          <filter class="ch.qos.logback.classic.filter.LevelFilter">
              <!-- 过滤的级别 -->
              <level>ERROR</level>
              <!-- 匹配时的操作：接收（记录） -->
              <onMatch>ACCEPT</onMatch>
              <!-- 不匹配时的操作：拒绝（不记录） -->
              <onMismatch>DENY</onMismatch>
          </filter>
      </appender>
  
      <!-- 自定义appender：用户访问日志输出  -->
      <appender name="sys-user" class="ch.qos.logback.core.rolling.RollingFileAppender">
          <file>${log.basePath}/${log.path}/sys-user.log</file>
          <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
              <!-- 按天回滚 daily -->
              <fileNamePattern>${log.basePath}/${log.path}/sys-user.%d{yyyy-MM-dd}.log</fileNamePattern>
              <!-- 日志最大的历史 60天 -->
              <maxHistory>60</maxHistory>
          </rollingPolicy>
          <encoder>
              <pattern>${log.pattern}</pattern>
          </encoder>
      </appender>
  
      <!-- 自定义appender ：日志级别控制 -->
      <logger name="sys-user" level="info">
          <appender-ref ref="sys-user"/>
      </logger>
  
      <!-- 当前系统全局 ：日志级别控制  -->
      <logger name="com.example" level="info" />
  
      <!-- 第三方系统：Spring日志级别控制  -->
      <logger name="org.springframework" level="warn" />
      <!-- 第三方系统：关闭kafka日志 -->
      <!--<logger name="org.apache.kafka" level="off"/>-->
  
      <!-- 单独指定控制台打印级别 -->
      <root level="info">
          <appender-ref ref="console" />
      </root>
  
      <!-- 指定上面appender的日志打印级别 -->
      <root level="info">
          <appender-ref ref="file_info" />
          <appender-ref ref="file_error" />
      </root>
  </configuration>
  

三、使用自定义appender

• 使用Lombok
  Lombok 内置 @Slf4j 、@Log4j2 两种日志注解。

@Log4j2(topic = "sys-user")
@Slf4j(topic = "sys-user")

• 不使用Lombok

Logger logger = LoggerFactory.getLogger("sys-user");

四、logback查找配置源码

org.springframework.boot.logging.logback.LogbackLoggingSystem

    protected String[] getStandardConfigLocations() {
        return new String[]{"logback-test.groovy", "logback-test.xml", "logback.groovy", "logback.xml"};
    }

五、案例源码

github : https://github.com/duke147/springboot-logback.git