Spring Boot日誌框架

Spring Boot支援Java Util Logging,Log4j2,Lockback作為日誌框架，如果你使用starters啟動器，Spring Boot將使用Logback作為預設日誌框架。無論使用哪種日誌框架，Spring Boot都支援配置將日誌輸出到控制檯或者檔案中。

spring-boot-starter啟動器包含spring-boot-starter-logging啟動器並集成了slf4j日誌抽象及Logback日誌框架。

屬性配置日誌

Spring Boot支援屬性配置日誌引數，這個不是很靈活，不細講。

參考配置：

# LOGGING
logging.config= # Location of the logging configuration file. For instance `classpath:logback.xml` for Logback
logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions.
logging.file= # Log file name. For instance `myapp.log`
logging.level.*= # Log levels severity mapping. For instance `logging.level.org.springframework=DEBUG`
logging.path= # Location of the log file. For instance `/var/log`
logging.pattern.console= # Appender pattern for output to the console. Only supported with the default logback setup.
logging.pattern.file= # Appender pattern for output to the file. Only supported with the default logback setup.
logging.pattern.level= # Appender pattern for log level (default %5p). Only supported with the default logback setup.
logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.
 

如：

logging.level.root=DEBUG
logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR

自定義日誌檔案

根據不同的日誌框架，預設載入的日誌配置檔案的檔名，放在資源根目錄下，其他的目錄及檔名不能被載入。

既然預設自帶了Logback框架，Logback也是最優秀的日誌框架，在資源目錄下建立一個logback-spring.xml即可，下面是一個參考配置檔案。

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
   <springProperty scope="context" name="APP_NAME" source="spring.application.name"/>
   <springProperty scope="context" name="APP_PORT" source="server.port"/>
   <springProperty scope="context" name="DEFAULT_APP_PORT" source="spring.application.port"/>
   <property name="OS_NAME" value="${os.name}"/>
   <if condition='property("OS_NAME").contains("Windows")'>
       <then>
           <property name="LOG_PATH" value="${LOG_PATH:-E:/logs}" />
       </then>
       <else>
           <property name="LOG_PATH" value="${LOG_PATH:-/log}" />
       </else>
   </if>      
   <property name="LOG_DIR" value="${APP_NAME:-system}" />
   <property name="APP_PORT" value="${APP_PORT:-${DEFAULT_APP_PORT:-0}}" />
   <if condition='!property("APP_PORT").equals("0")'>
       <then>
           <property name="LOG_DIR" value="${LOG_DIR}-${APP_PORT}" />
       </then>
   </if>

   <!-- 控制檯輸出 -->
   <appender name="STDOUT" 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>

   <!-- 按照每天生成日誌檔案 -->
   <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
       <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
           <level>INFO</level>
       </filter>
       <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           <!--日誌檔案輸出的檔名 -->
           <FileNamePattern>${LOG_PATH}/${LOG_DIR}/info.log.%d{yyyy-MM-dd}.log</FileNamePattern>
           <!--日誌檔案保留天數 -->
           <MaxHistory>30</MaxHistory>
       </rollingPolicy>
       <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>

       <!--日誌檔案最大的大小 -->
       <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
           <MaxFileSize>10MB</MaxFileSize>
       </triggeringPolicy>
   </appender>

   <!-- 按照每天生成日誌檔案 error級別 -->
   <appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
       <filter class="ch.qos.logback.classic.filter.LevelFilter">
           <level>ERROR</level>
           <onMatch>ACCEPT</onMatch>
           <onMismatch>DENY</onMismatch>
       </filter>  
       <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           <!--日誌檔案輸出的檔名 -->
           <FileNamePattern>${LOG_PATH}/${LOG_DIR}/error.log.%d{yyyy-MM-dd}.log</FileNamePattern>
           <!--日誌檔案保留天數 -->
           <MaxHistory>30</MaxHistory>
       </rollingPolicy>
       <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>
       <!--日誌檔案最大的大小 -->
       <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
           <MaxFileSize>10MB</MaxFileSize>
       </triggeringPolicy>
   </appender>

   <!--myibatis log configure -->
   <logger name="com.apache.ibatis" level="TRACE" />
   <logger name="java.sql.Connection" level="DEBUG" />
   <logger name="java.sql.Statement" level="DEBUG" />
   <logger name="java.sql.PreparedStatement" level="DEBUG" />

   <!-- 日誌輸出級別 -->
   <root level="INFO">
       <appender-ref ref="STDOUT" />
       <appender-ref ref="FILE" />
       <appender-ref ref="FILE-ERROR" />
   </root>
</configuration>

強烈推薦使用logback-spring.xml作為檔名，因為logback.xml載入太早。

日誌初始化在ApplicationContext建立之前，所以@PropertySources載入的配置是讀取不到的，系統環境變數、Spring Environment及application,bootstrap配置檔案中的資訊可以讀取到。

讀取系統環境屬性：

<property name="LOG_PATH" value="${LOG_PATH:-E:/logs}" />

讀取當前應用Environment中的屬性：

<springProperty scope="context" name="fluentHost" source="myapp.fluentd.host" defaultValue="localhost"/>

Spring Boot也支援通過springProfile來載入不同profiles下的配置。

<springProfile name="staging">
   <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

<springProfile name="dev, staging">
   <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
   <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>