日志,通常不會在需求階段作為一個功能單獨提出來,也不會在產品方案中看到它的細節。但是,這絲毫不影響它在任何一個系統中的重要的地位。
為了保證服務的高可用,發現問題一定要即使,解決問題一定要迅速,所以生產環境一旦出現問題,預警系統就會通過郵件、短信甚至電話的方式實施多維轟炸模式,確保相關負責人不錯過每一個可能的bug。
預警系統判斷疑似bug大部分源於日志。比如某個微服務接口由於各種原因導致頻繁調用出錯,此時調用端會捕獲這樣的異常並打印ERROR級別的日志,當該錯誤日志達到一定次數出現的時候,就會觸發報警。
try { 調用某服務 } catch(Exception e) { LOG.error("錯誤信息", e); }
所以日志至關重要,這篇就來介紹下在Spring Boot如何配置日志。
Spring Boot默認日志系統
Spring Boot默認使用LogBack日志系統,如果不需要更改為其他日志系統如Log4j2等,則無需多余的配置,LogBack默認將日志打印到控制台上。
如果要使用LogBack,原則上是需要添加dependency依賴的
<groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId></pre>
但是因為新建的Spring Boot項目一般都會引用spring-boot-starter
或者spring-boot-starter-web
,而這兩個起步依賴中都已經包含了對於spring-boot-starter-logging
的依賴,所以,無需額外添加依賴。
我們基於《沒做過大項目,但我會建大項目》中創建的項目,啟動springboot-demo項目,可以看到打印的日志信息如下。
以上至默認配置啟動下的日志顯示情況,如果需要做一些定制的日志配置比如將日志存儲到文件等應該如何配置,下面就通過幾個小問題來看看Spring Boot下是如何解決這些問題的。
如何在項目中打印日志
新建一個配置類LogConfig,注入一個Bean,並在方法中打印日志
package com.jackie.springbootdemo.config;
import com.jackie.springbootdemo.model.Person; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class LogConfig { private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class); @Bean public Person logMethod() { LOG.info("==========print log=========="); return new Person(); } }
運行SpringBootDemoApplication,可以看到控制台的日志
Spring Boot默認的日志級別為INFO,這里打印的是INFO級別的日志所以可以顯示。
很多開發者在日常寫private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class);
總覺得后面的LogConfig.class可有可無,因為隨便寫個其他類也不會報錯,但是准確編寫class信息能夠提供快速定位日志的效率。
我們看到打印的日志內容左側就是對應的類名稱,這個是通過private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class);
實現的。
如果將LogConfig.class換成xxx.class,輸出日志就會顯示對應的xxx類名。這樣聲明的好處就是方便定位日志。
如何將日志信息存儲到文件
在本機環境,我們習慣在控制台看日志,但是線上我們還是要通過將日志信息保存到日志文件中,查詢日志文件即可。
那么應該如何配置才能將日志信息保存到文件呢?
在我們創建的springboot-demo項目中,resources目錄下有個application.properties文件(如果是application.yml文件也是同樣的道理,只是采用的不同的編寫風格而已)。添加如下配置
logging:
path:(和file二寫一) file:springbootdemo.log
logging.path
該屬性用來配置日志文件的路徑
logging.file
該屬性用來配置日志文件名,如果該屬性不配置,默認文件名為spring.log
運行SpringBootDemoApplication
可以看到在指定路徑下生成了springbootdemo.log文件,該文件內容和控制台打印內容一致。
如果注釋logging.file=springbootdemo.log
則生成默認文件名spring.log
如何設置日志級別
日志級別總共有TRACE < DEBUG < INFO < WARN < ERROR < FATAL ,且級別是逐漸提供,如果日志級別設置為INFO,則意味TRACE和DEBUG級別的日志都看不到。
上例中我們打印了一個INFO級別的日志,因為Spring Boot默認級別就是INFO,如果我們改為WARN,是否還能看到這行日志信息。
logging.level
該屬性用於配置日志級別。
在applicaition.properties中添加
logging.level.root=warn
這里是用的root級別,即項目的所有日志,我們也可以使用package級別,即指定包下使用相應的日志級別,下面再看。
啟動SpringBootDemoApplication
你沒看錯,這個項目是成功啟動了,但是幾乎沒有內容,這是因為之前打印的日志級別都是INFO,這里設置為WARN,所以INFO級別的日志都不顯示。
這里我們可以改動root還是INFO級別,將指定包下的日志級別設置為WARN
logging.level.root=INFO
logging.level.com.jackie.springbootdemo.config=WARN
啟動SpringBootDemoApplication
可以看到除了LogConfig類中的INFO級別的日志沒有打印出來,其他的INFO級別的日志都正常輸出了。
如何定制自己的日志格式
在application.properties中添加
logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n
logging.pattern.console
該屬性用於定制日志輸出格式。
上述配置的編碼中,對應符號的含義如下
%d{HH:mm:ss.SSS}——日志輸出時間 %thread——輸出日志的進程名字,這在Web應用以及異步任務處理中很有用 %-5level——日志級別,並且使用5個字符靠左對齊 %logger- ——日志輸出者的名字 %msg——日志消息 %n——平台的換行符
啟動SpringBootDemoApplication