Spring Boot日誌配置

支援日誌框架：Java Util Logging, Log4J2 and Logback，預設是使用logback  
配置方式：預設配置檔案配置和引用外部配置檔案配置

1、預設配置檔案配置

• 不建議使用：不夠靈活，對log4j2等不夠友好

  # 日誌檔名，比如：roncoo.log，或者是 /var/log/roncoo.loglogging.file=roncoo.log # 日誌級別配置，比如： logging.level.org.springframework=DEBUGlogging.level.*=infologging.level.org.springframework=DEBUG

2、配置logback

• 引用外部配置檔案

  spring boot預設會載入classpath:logback-spring.xml或者classpath:logback-spring.groovy。  
  使用自定義配置檔案，配置方式為：logging.config=classpath:logback-roncoo.xml；注意：不要使用logback這個來命名，否則spring boot將不能完全例項化。

  ① 使用基於spring boot的配置

  <?xml version="1.0" encoding="UTF-8"?><configuration><include resource="org/springframework/boot/logging/logback/base.xml"/><logger name="org.springframework.web" level="DEBUG"/></configuration>

  ② 自定義配置

  <?xml version="1.0" encoding="UTF-8"?><configuration>    <!-- 檔案輸出格式 -->    <property name="PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />    <!-- test檔案路徑 -->    <property name="TEST_FILE_PATH" value="logs/info" />    <!-- pro檔案路徑 -->    <property name="PRO_FILE_PATH" value="logs/warn" />    <!-- 開發環境 -->    <springProfile name="dev">        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">            <encoder>                <pattern>${PATTERN}</pattern>            </encoder>        </appender>        <logger name="com.roncoo.education" level="debug"/>        <root level="info">            <appender-ref ref="CONSOLE" />        </root>    </springProfile>    <!-- 測試環境 -->    <springProfile name="test">        <!-- 每天產生一個檔案 -->        <appender name="TEST-FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">            <!-- 檔案路徑 -->            <file>${TEST_FILE_PATH}</file>            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">                <!-- 檔名稱 -->                <fileNamePattern>${TEST_FILE_PATH}.%d{yyyy-MM-dd}.log</fileNamePattern>                <!-- 檔案最大儲存歷史數量 -->                <MaxHistory>100</MaxHistory>            </rollingPolicy>            <layout class="ch.qos.logback.classic.PatternLayout">                <pattern>${PATTERN}</pattern>            </layout>        </appender>        <root level="info">            <appender-ref ref="TEST-FILE" />        </root>    </springProfile>    <!-- 生產環境 -->    <springProfile name="prod">        <appender name="PROD_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">            <file>${PRO_FILE_PATH}</file>            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">                <fileNamePattern>${PRO_FILE_PATH}.%d{yyyy-MM-dd}.log</fileNamePattern>                <MaxHistory>100</MaxHistory>            </rollingPolicy>            <layout class="ch.qos.logback.classic.PatternLayout">                <pattern>${PATTERN}</pattern>            </layout>        </appender>        <root level="warn">            <appender-ref ref="PROD_FILE" />        </root>    </springProfile></configuration>

3、配置log4j

• 引用外部配置檔案

  去除logback的依賴包，新增log4j2的依賴包

  <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><!-- 使用log4j2 --><dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-log4j2</artifactId></dependency>

  ① 在classpath新增log4j2.xml或者log4j2-spring.xml（spring boot 預設載入）

  ② 自定義配置檔案

  <?xml version="1.0" encoding="utf-8"?><configuration>    <properties>        <!-- 檔案輸出格式 -->        <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} |-%-5level [%thread] %c [%L] -| %msg%n</property>    </properties>    <appenders>        <Console name="CONSOLE" target="system_out">            <PatternLayout pattern="${PATTERN}" />        </Console>    </appenders>    <loggers>        <logger name="com.roncoo.education" level="debug" />        <root level="info">            <appenderref ref="CONSOLE" />        </root>    </loggers></configuration>

4、比較

• 效能比較：Log4J2 和 Logback 都優於 log4j（不推薦使用）

• 配置方式：Logback最簡潔，spring boot預設，推薦使用

5、配置logging

• 參考文件

6、致謝名單

• 馮永偉