1. 程式人生 > >springboot乾貨——(四)日誌配置及分析

springboot乾貨——(四)日誌配置及分析

<!--輸出到檔案-->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${log.path}</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
		<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
		<totalSizeCap>1GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

其中重要的是rollingPolicy的定義,上例中<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>定義了日誌的切分方式——把每一天的日誌歸檔到一個檔案中,<maxHistory>30</maxHistory>表示只保留最近30天的日誌,以防止日誌填滿整個磁碟空間。同理,可以使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日誌切分方式。<totalSizeCap>1GB</totalSizeCap>用來指定日誌檔案的上限大小,例如設定為1GB的話,那麼到了這個值,就會刪除舊的日誌。

子節點二<root>

root節點是必選節點,用來指定最基礎的日誌輸出級別,只有一個level屬性。

  • level:用來設定列印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設定為INHERITED或者同義詞NULL。
    預設是DEBUG。
    可以包含零個或多個元素,標識這個appender將會新增到這個loger。
<root level="debug">
    <appender-ref ref="console" />
    <appender-ref ref="file" />
</root>

子節點三<loger>

<loger>用來設定某一個包或者具體的某一個類的日誌列印級別、以及指定<appender><loger>僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。

  • name:用來指定受此loger約束的某一個包或者具體的某一個類。
  • level:用來設定列印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。如果未設定此屬性,那麼當前loger將會繼承上級的級別。
  • addtivity:是否向上級loger傳遞列印資訊。預設是true。

loger在實際使用的時候有兩種情況
先來看一看程式碼中如何使用

package com.dudu.controller;
@Controller
public class LearnController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping(value = "/login",method = RequestMethod.POST)
    @ResponseBody
    public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){
        //日誌級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設定為WARN,則低於WARN的資訊都不會輸出。
        logger.trace("日誌輸出 trace");
        logger.debug("日誌輸出 debug");
        logger.info("日誌輸出 info");
        logger.warn("日誌輸出 warn");
        logger.error("日誌輸出 error");
        Map<String,Object> map =new HashMap<String,Object>();
        String userName=request.getParameter("userName");
        String password=request.getParameter("password");
        if(!userName.equals("") && password!=""){
            User user =new User(userName,password);
            request.getSession().setAttribute("user",user);
            map.put("result","1");
        }else{
            map.put("result","0");
        }
        return map;
    }
}

這是一個登入的判斷的方法,我們引入日誌,並且列印不同級別的日誌,然後根據logback-spring.xml中的配置來看看列印了哪幾種級別日誌。

第一種:帶有loger的配置,不指定級別,不指定appender

1
<logger name="com.dudu.controller"/>

<logger name="com.dudu.controller" />將控制controller包下的所有類的日誌的列印,但是並沒用設定列印級別,所以繼承他的上級的日誌級別“info”;
沒有設定addtivity,預設為true,將此loger的列印資訊向上級傳遞;
沒有設定appender,此loger本身不列印任何資訊。
<root level="info">將root的列印級別設定為“info”,指定了名字為“console”的appender。

當執行com.dudu.controller.LearnController類的login方法時,LearnController 在包com.dudu.controller中,所以首先執行<logger name="com.dudu.controller"/>,將級別為“info”及大於“info”的日誌資訊傳遞給root,本身並不列印;
root接到下級傳遞的資訊,交給已經配置好的名為“console”的appender處理,“console”appender將資訊列印到控制檯;

列印結果如下:

1
16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.dudu.controller.LearnController - 日誌輸出 info
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日誌輸出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日誌輸出 error

第二種:帶有多個loger的配置,指定級別,指定appender

1
2
3
4
<!--logback.LogbackDemo:類的全路徑 -->
<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
    <appender-ref ref="console"/>
</logger>

控制com.dudu.controller.LearnController類的日誌列印,列印級別為“WARN”;
additivity屬性為false,表示此loger的列印資訊不再向上級傳遞;
指定了名字為“console”的appender;

這時候執行com.dudu.controller.LearnController類的login方法時,先執行<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">,
將級別為“WARN”及大於“WARN”的日誌資訊交給此loger指定的名為“console”的appender處理,在控制檯中打出日誌,不再向上級root傳遞列印資訊。
列印結果如下:

1
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日誌輸出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日誌輸出 error

當然如果你把additivity=”false”改成additivity=”true”的話,就會列印兩次,因為列印資訊向上級傳遞,logger本身列印一次,root接到後又列印一次。

多環境日誌輸出

據不同環境(prod:生產環境,test:測試環境,dev:開發環境)來定義不同的日誌輸出,在 logback-spring.xml中使用 springProfile 節點來定義,方法如下:

檔名稱不是logback.xml,想使用spring擴充套件profile支援,要以logback-spring.xml命名

1
2
3
4
5
6
7
8
<!-- 測試環境+開發環境. 多個使用逗號隔開. -->
<springProfile name="test,dev">
    <logger name="com.dudu.controller" level="info" />
</springProfile>
<!-- 生產環境. -->
<springProfile name="prod">
    <logger name="com.dudu.controller" level="ERROR" />
</springProfile>

可以啟動服務的時候指定 profile (如不指定使用預設),如指定prod 的方式為:
java -jar xxx.jar –spring.profiles.active=prod