Spring Boot日志內建

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支援屬性配置日志參數，這個不是很靈活，不細講。

參考配置：

1. # LOGGING

2. logging.config= # Location of the logging configuration file. For instance `classpath:logback.xml` for Logback

3. logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions.

4. logging.file= # Log file name. For instance `myapp.log`

5. logging.level.*= # Log levels severity mapping. For instance `logging.level.org.springframework=DEBUG`

6. logging.path= # Location of the log file. For instance `/var/log`

7. logging.pattern.console= # Appender pattern for output to the console. Only supported with the default logback setup.

8. logging.pattern.file= # Appender pattern for output to the file. Only supported with the default logback setup.

9. logging.pattern.level= # Appender pattern for log level (default %5p). Only supported with the default logback setup.

10. logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.

如：

1. logging.level.root=DEBUG

2. logging.level.org.springframework.web=DEBUG

3. logging.level.org.hibernate=ERROR

自定義日志檔案

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

Logging System	Customization
Logback	logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

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

1. <?xml version="1.0" encoding="UTF-8"?>

2. <configuration debug="false">

3.    <springProperty scope="context" name="APP_NAME" source="spring.application.name"/>

4.    <springProperty scope="context" name="APP_PORT" source="server.port"/>

5.    <springProperty scope="context" name="DEFAULT_APP_PORT" source="spring.application.port"/>

6.    <property name="OS_NAME" value="${os.name}"/>

7.    <if condition='property("OS_NAME").contains("Windows")'>

8.        <then>

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

10.        </then>

11.        <else>

12.            <property name="LOG_PATH" value="${LOG_PATH:-/log}" />

13.        </else>

14.    </if>      

15.    <property name="LOG_DIR" value="${APP_NAME:-system}" />

16.    <property name="APP_PORT" value="${APP_PORT:-${DEFAULT_APP_PORT:-0}}" />

17.    <if condition='!property("APP_PORT").equals("0")'>

18.        <then>

19.            <property name="LOG_DIR" value="${LOG_DIR}-${APP_PORT}" />

20.        </then>

21.    </if>

22.    <!-- 控制台輸出 -->

23.    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

24.        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

25.            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級别從左顯示5個字元寬度，%msg：日志消息，%n是換行符 -->

26.            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>

27.        </encoder>

28.    </appender>

29.    <!-- 按照每天生成日志檔案 -->

30.    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

31.        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">

32.            <level>INFO</level>

33.        </filter>

34.        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

35.            <!--日志檔案輸出的檔案名 -->

36.            <FileNamePattern>${LOG_PATH}/${LOG_DIR}/info.log.%d{yyyy-MM-dd}.log</FileNamePattern>

37.            <!--日志檔案保留天數 -->

38.            <MaxHistory>30</MaxHistory>

39.        </rollingPolicy>

40.        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

41.            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級别從左顯示5個字元寬度%msg：日志消息，%n是換行符 -->

42.            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>

43.        </encoder>

44.        <!--日志檔案最大的大小 -->

45.        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">

46.            <MaxFileSize>10MB</MaxFileSize>

47.        </triggeringPolicy>

48.    </appender>

49.    <!-- 按照每天生成日志檔案 error級别 -->

50.    <appender name="FILE-ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">

51.        <filter class="ch.qos.logback.classic.filter.LevelFilter">

52.            <level>ERROR</level>

53.            <onMatch>ACCEPT</onMatch>

54.            <onMismatch>DENY</onMismatch>

55.        </filter>  

56.        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

57.            <!--日志檔案輸出的檔案名 -->

58.            <FileNamePattern>${LOG_PATH}/${LOG_DIR}/error.log.%d{yyyy-MM-dd}.log</FileNamePattern>

59.            <!--日志檔案保留天數 -->

60.            <MaxHistory>30</MaxHistory>

61.        </rollingPolicy>

62.        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

63.            <!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級别從左顯示5個字元寬度%msg：日志消息，%n是換行符 -->

64.            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>

65.        </encoder>

66.        <!--日志檔案最大的大小 -->

67.        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">

68.            <MaxFileSize>10MB</MaxFileSize>

69.        </triggeringPolicy>

70.    </appender>

71.    <!--myibatis log configure -->

72.    <logger name="com.apache.ibatis" level="TRACE" />

73.    <logger name="java.sql.Connection" level="DEBUG" />

74.    <logger name="java.sql.Statement" level="DEBUG" />

75.    <logger name="java.sql.PreparedStatement" level="DEBUG" />

76.    <!-- 日志輸出級别 -->

77.    <root level="INFO">

78.        <appender-ref ref="STDOUT" />

79.        <appender-ref ref="FILE" />

80.        <appender-ref ref="FILE-ERROR" />

81.    </root>

82. </configuration>

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

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

讀取系統環境屬性：

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

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

1. <springProperty scope="context" name="fluentHost" source="myapp.fluentd.host"

2.        defaultValue="localhost"/>

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

1. <springProfile name="staging">

2.    <!-- configuration to be enabled when the "staging" profile is active -->

3. </springProfile>

4. <springProfile name="dev, staging">

5.    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->

6. </springProfile>

7. <springProfile name="!production">