腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

Spring Boot日志的打印與持久化詳細(xì)解析

更新時間：2022年07月19日 10:23:48 作者：偷偷敲代碼的青花瓷

Spring Boot默認(rèn)使用SLF4J+Logback 記錄日志，并提供了默認(rèn)配置，即使我們不進(jìn)行任何額外配，也可以使用SLF4J+Logback進(jìn)行日志輸出

1. 日志有什么用

日志是程序的重要組成部分，想象一下，如果程序報錯了，不讓你打開控制臺看日志，那么你能找到報錯的原因嗎？

答案是否定的，寫程序不是買彩票，不能完全靠猜，因此日志對應(yīng)我們來說，最重要的用途就是排除和定位問題。

除了發(fā)現(xiàn)和定位問題之外，我們還可以通過日志實現(xiàn)以下功能：

記錄用戶登錄日志，方便分析用戶正常登錄還是惡意破解用戶
記錄系統(tǒng)的操作日志，方便數(shù)據(jù)恢復(fù)和定位操作人
記錄程序的執(zhí)行實現(xiàn)，方便以后優(yōu)化程序提供數(shù)據(jù)支持

2. 日志怎么用

Spring Boot 項目在啟動的時候默認(rèn)就有日志輸出，如下圖所示：

以上內(nèi)容就是 Spring Boot 輸出的控制臺日志信息。

通過上述日志信息我們可以發(fā)現(xiàn)以下3個問題：

Spring Boot 內(nèi)置了日志框架（不然也輸出不了日志）
默認(rèn)情況下，輸出的?志并?是開發(fā)者定義和打印的，那開發(fā)者怎么在程序中?定義打印?志呢？
?志默認(rèn)是打印在控制臺上的，?控制臺的?志是不能被保存的，那么怎么把?志永久的保存下來呢？

下面我們一起來找尋這些問題的答案。

3. Spring Boot 自定義日志的打印

在一個類中先獲取到打印日志對象（日志框架提供的日志對象，而日志框架默認(rèn)已經(jīng)集成到 Spring Boot 里了）
使用日志對象提供的方法實現(xiàn)日志的打印

3.1 先獲取到打印日志對象

在程序中獲取日志對象需要使用日志工廠 LoggerFactory,如下代碼所示：

 // 1.先得到日志對象（來自 slf4j）
    private static final Logger log =
            LoggerFactory.getLogger(UserController.class);

日志工廠需要將每個類的類型傳遞進(jìn)去，這樣我們才知道日志的歸屬類，才能更方便，更直觀的定位到問題類。

注意：Logger 對象是屬于 org.slf4j 包下的，不要導(dǎo)入錯誤。

因為 Spring Boot 中內(nèi)置了日志框架 slf4j，所以咋們可以直接在程序中調(diào)用 slf4j 來輸出日志

3.2 使用日志對象打印日志

日志對象的打印方法有很多，我們可以先使用 info（）方法來輸出日志，如下代碼所示：

// 2.使用日志對象提供的打印方法進(jìn)行日志打印
log.trace("我是 trace");
log.debug("我是 debug");
log.info("我是 info");
log.warn("我是 warn");
log.error("我是 error");

打印效果展示：

3.3 日志格式說明

4. 日志級別

5. 日志持久化(將日志永久的保存到磁盤的某個位置)

以上的?志都是輸出在控制臺上的，然?在?產(chǎn)環(huán)境上咱們需要將?志保存下來，以便出現(xiàn)問題之后追溯問題，把?志保存下來的過程就叫做持久化。

想要將?志進(jìn)?持久化，只需要在配置?件中指定?志的存儲?錄或者是指定?志保存?件名之后， Spring Boot 就會將控制臺的?志寫到相應(yīng)的?錄或?件下了。

設(shè)置日志的保存路徑

在配置文件中，輸入如下代碼：

# 設(shè)置日志的保存路徑
# 正確設(shè)置日志路徑的方式1
logging.file.path=D:/JavaCode/
# 正確設(shè)置日志路徑的方式2
logging.file.path=D:\\JavaCode\\

保存后：

注意：

logging.file.path=D:\JavaCode\

這種寫法，Spring Boot 會認(rèn)為是一個特殊字符，而非目錄，所以日志持久化不會成功。

6. 更簡單的日志輸出—lombok

每次都使用 LoggerFactory.getLogger(xxx.class) 很繁瑣，而且每個類都要添加一遍，也很麻煩，這里有種更好的日志輸出方式，使用 lombok 來更簡單的輸出。

添加 lombok 框架支持
使用 @slf4j 注解輸出日志

6.1 添加 lombok 到當(dāng)前項目

1.在 pom.xml 中先刪除已有的 lombok 依賴

2.下載插件

下載好之后，手動引入 lombok 依賴

6.2 使用 @Slf4j 得到日志對象 log

@Controller
@ResponseBody
@Slf4j // 替代了之前需要通過 LoggerFactory.getLogger 操作
public class UserService {
        @RequestMapping("/sayhi2")
        public void sayHi2() {
                log.trace("我是 trace");
                log.debug("我是 debug");
                log.info("我是 info");
                log.warn("我是 warn");
                log.error("我是 error");
        }
}

控制臺打印結(jié)果如下：

總結(jié)

?志是程序中的重要組成部分，使??志可以快速的發(fā)現(xiàn)和定位問題，Spring Boot 內(nèi)容了?志框架，默認(rèn)情況下使?的是 info ?志級別將?志輸出到控制臺的，我們可以通過 lombok 提供的 @Slf4j 注解和 log 對象快速的打印?定義?志，?志包含 6 個級別：