SpringBoot學習筆記（五）- 日誌

1. slf4j與logback、log4j的關係
   （1）關係：
   首先談到日誌,我們可能聽過log4j logback slf4j這三個名詞，那麼它們之間的關係是怎麼樣的呢？SLF4J，即簡單日誌門面（Simple Logging Facade for JAVA），不需要另加依賴，不是具體的日誌解決方案，不會生成日誌文件，它只服務於各種各樣的日誌系統。一般來說，slf4j配合log4j、logback進行使用，可以理解爲slf4j是標準，log4j和logback是實現，我們可以根據自己的需求進行選擇具體的日誌系統。
   這裏推薦使用logback,因爲logback更快的執行速度，logback-classic 非常自然的實現了SLF4J，官方也推薦使用logback作爲日誌系統。
   （2）配置logback：
   logback-spring.xml>>>>
   spring boot會默認加載此文件，直接放在resources目錄下就生效，爲什麼不配置logback.xml,因爲logback.xml會先application.properties加載，而logback-spring.xml會後於application.properties加載，這樣我們在application.properties文中設置日誌文件名稱和文件路徑才能生效。

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置爲WARN，則低於WARN的信息都不會輸出 -->
<!-- scan:當此屬性設置爲true時，配置文檔如果發生改變，將會被重新加載，默認值爲true -->
<!-- scanPeriod:設置監測配置文檔是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。
                 當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。 -->
<!-- debug:當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。 -->
<configuration  scan="true" scanPeriod="10 seconds">
    <contextName>logback</contextName>

    <!-- name的值是變量的名稱，value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義後，可以使“${}”來使用變量。 -->
    <property name="log.path" value="G:/logs/mavenTest" />

    <!--0. 日誌格式和顏色渲染 -->
    <!-- 彩色日誌依賴的渲染類 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 彩色日誌格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

    <!--1. 輸出到控制檯-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日誌appender是爲開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--2. 輸出到文檔-->
    <!-- 2.1 level爲 DEBUG 日誌，時間滾動輸出  -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文檔的路徑及文檔名 -->
        <file>${log.path}/web_debug.log</file>
        <!--日誌文檔輸出格式-->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset> <!-- 設置字符集 -->
        </encoder>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日誌歸檔 -->
            <fileNamePattern>${log.path}/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!--文件達到 最大100MB時會被壓縮和切割 -->
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文檔保留天數-->
            <maxHistory>15</maxHistory>
            <!--達到這個，就刪除-->
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <!-- 此日誌文檔只記錄debug及其以上級別的 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>
    <!--
        root節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個level屬性
        level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設置爲INHERITED或者同義詞NULL。默認是DEBUG
        可以包含零個或多個元素，標識這個appender將會添加到這個logger。
    -->

    <!-- 4. 最終的策略，使用4.1還是4.2取決於properties文件選擇的是什麼環境，若spring.profiles.active=dev，則會選擇springProfile name="dev" -->
    <!-- 4.1 開發環境:打印控制檯-->
    <springProfile name="dev">
        <logger name="com.sdcm.pmp" level="debug"/>
    </springProfile>

    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="DEBUG_FILE" />
    </root>

    <!-- 4.2 生產環境:輸出到文檔 -->
    <springProfile name="prod">
        <root level="info">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="DEBUG_FILE" />
        </root>
    </springProfile>

</configuration>

（3）測試：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ErrorController {
	public static final Logger logger = LoggerFactory.getLogger(ErrorController.class);
	@RequestMapping("/ErrorRes")
	public String ErrorRes(int i){
		int j = 2;
		try {
			j = 1/i;
		} catch (Exception e) {
			logger.info("系統錯誤!!");
			return "系統錯誤";
		}
		return "Success"+j;
	}
}

（4）lombok插件：
在這裏，發現這樣每個類裏都需要聲名一個日誌對象，推薦使用lombok插件，安裝下載方式就不多說，講講好處:
a）首先，引入依賴：

<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>

b）其次，傳統日誌聲名方法，是在每個類裏聲名一個logger對象
public static final Logger logger = LoggerFactory.getLogger(ErrorController.class);
使用lombook，可以直接使用註解@Slf4j，直接使用log.info()即可
c) 還有，成員屬性的set和get方法，也可用@Setter 和 @Getter註解代替，寫在類名上面
d) lombok還有其他註解，參考地址：https://blog.csdn.net/motui/article/details/79012846

(5) 使用AOP通知方式生成定式日誌，可以減少很多log.info（）的書寫，只在有其他需求是增加info（）:
切入點的範圍寫法，參考：https://blog.csdn.net/kkdelta/article/details/7441829

// 切入點
@Pointcut("execution(* com.gxl.gree..*.*(..))")
	public void excudeLogService() {
	}
@Before("excudeLogService()")
	public void doBefore() {
		ServletRequestAttributes attributes = (ServletRequestAttributes) 					  RequestContextHolder.getRequestAttributes();
		HttpServletRequest request = attributes.getRequest();
		log.info("URL: " + request.getRequestURL().toString());
		log.info("Method: " + request.getMethod());
		log.info("IP: " + request.getRemoteAddr());
		Enumeration<String> enu = request.getParameterNames();
		while(enu.hasMoreElements()){
			String name = (String) enu.nextElement();
			log.info("name:{},value:{}", name, request.getParameter(name));
		}
	}