前言

在現(xiàn)代軟件開發(fā)中，日志是一項(xiàng)至關(guān)重要的工具，它記錄了應(yīng)用程序運(yùn)行過程中的關(guān)鍵信息，當(dāng)程序運(yùn)行出現(xiàn)錯(cuò)誤的時(shí)候，可以幫助開發(fā)人員快速識(shí)別和解決存在的問題。通過合理的日志記錄，能夠幫助我們更好地了解應(yīng)用程序的運(yùn)行情況，從而提高應(yīng)用程序的穩(wěn)定性和可維護(hù)性。

本文的主要內(nèi)容就是深入探討日志在 Spring Boot 項(xiàng)目中的使用。主要介紹了日志的類型、自定義日志的定義，日志等級(jí)以及對(duì)輸出日志的持久化。此外，還包括使用 Lombok 更簡單高效的去輸出日志信息。

一、日志文件的作用

日志文件在軟件開發(fā)和運(yùn)維中起著至關(guān)重要的作用，它記錄了系統(tǒng)、應(yīng)用程序或服務(wù)在運(yùn)行過程中所產(chǎn)生的各種事件、狀態(tài)和錯(cuò)誤信息。日志文件的作用如下：

1. 故障排查與問題定位：日志文件是排查故障和定位問題的重要工具。當(dāng)系統(tǒng)或應(yīng)用程序出現(xiàn)異常、錯(cuò)誤或崩潰時(shí)，日志文件中記錄的詳細(xì)信息可以幫助開發(fā)人員或運(yùn)維人員追蹤問題的來源，并幫助快速定位和解決問題。

2. 性能分析與優(yōu)化：通過分析日志文件，可以了解系統(tǒng)或應(yīng)用程序的性能表現(xiàn)。識(shí)別瓶頸、耗時(shí)操作和資源消耗，從而進(jìn)行優(yōu)化和改進(jìn)，提高系統(tǒng)的響應(yīng)速度和性能。

3. 監(jiān)控與預(yù)警：監(jiān)控日志文件可以實(shí)時(shí)監(jiān)測系統(tǒng)運(yùn)行狀態(tài)。通過設(shè)置特定的日志規(guī)則和報(bào)警機(jī)制，可以在系統(tǒng)發(fā)生異?；蛱囟ㄊ录l(fā)生時(shí)，及時(shí)通知相關(guān)人員進(jìn)行處理。

4. 安全審計(jì)與合規(guī)性：日志文件記錄了系統(tǒng)的行為和操作，可用于安全審計(jì)和合規(guī)性檢查。這對(duì)于滿足安全標(biāo)準(zhǔn)和法規(guī)要求，以及保護(hù)敏感信息非常重要。

5. 數(shù)據(jù)備份與還原：日志文件記錄了系統(tǒng)的歷史狀態(tài)和操作，可以用于數(shù)據(jù)備份和還原，恢復(fù)到特定時(shí)間點(diǎn)的狀態(tài)。

6. 追溯歷史記錄：日志文件是系統(tǒng)運(yùn)行過程中的重要?dú)v史記錄，對(duì)于了解系統(tǒng)使用情況、用戶行為和交互過程等具有重要價(jià)值。

總體而言，日志文件是系統(tǒng)運(yùn)行和維護(hù)的重要工具，能夠提供豐富的信息和數(shù)據(jù)，幫助開發(fā)人員、運(yùn)維人員和管理員監(jiān)控和維護(hù)系統(tǒng)的健康運(yùn)行，及時(shí)發(fā)現(xiàn)和解決問題，優(yōu)化系統(tǒng)性能，并滿足安全和合規(guī)性要求。因此，良好的日志記錄和管理是一個(gè)高質(zhì)量的軟件和系統(tǒng)的重要組成部分。

二、Spring Boot 中的日志

Spring Boot 提供了強(qiáng)大的日志功能，可以方便地查看輸出的日志信息并靈活配置日志格式。

2.1 查看輸出的日志信息

Spring Boot 默認(rèn)使用 Logback 作為日志框架，可以將日志輸出到控制臺(tái)（Console）和日志文件中。在開發(fā)和調(diào)試過程中，我們可以直接查看控制臺(tái)上輸出的日志信息。

例如，啟動(dòng) Spring Boot 項(xiàng)目時(shí)輸出的日志信息：

以上日志信息包含了時(shí)間戳、日志級(jí)別、進(jìn)程 ID、線程信息、類名和日志內(nèi)容等。不同的日志級(jí)別對(duì)應(yīng)不同的顏色，如 INFO 是綠色，WARN 是黃色，ERROR 是紅色，便于區(qū)分日志的嚴(yán)重程度。

2.2 日志格式

二、Spring Boot 中的日志

Spring Boot 提供了強(qiáng)大的日志功能，可以方便地查看輸出的日志信息并靈活配置日志格式。下面將介紹如何查看輸出的日志信息以及日志的格式配置。

2.1 查看輸出的日志信息

Spring Boot 默認(rèn)使用 Logback 作為日志框架，可以將日志輸出到控制臺(tái)（Console）和日志文件中。在開發(fā)和調(diào)試過程中，我們可以直接查看控制臺(tái)上輸出的日志信息。

例如，我們可以在 Spring Boot 應(yīng)用程序的控制臺(tái)輸出中，看到類似以下的日志信息：

2023-08-06 15:30:00.123  INFO 12345 --- [main] com.example.Application : Starting Application on localhost with PID 12345 (D:\workspace\project\target\classes started by user in D:\workspace\project)
2023-08-06 15:30:00.456  INFO 12345 --- [main] com.example.Application : Started Application in 2.345 seconds (JVM running for 3.456)

以上日志信息包含了時(shí)間戳、日志級(jí)別、進(jìn)程 ID、線程信息、類名和日志內(nèi)容等。不同的日志級(jí)別對(duì)應(yīng)不同的顏色，如 INFO 是綠色，WARN 是黃色，ERROR 是紅色，便于區(qū)分日志的嚴(yán)重程度。

2.2 日志格式

Spring Boot 允許我們對(duì)日志的輸出格式進(jìn)行靈活配置。日志的格式配置通常通過在 application.yml 或 application.properties 中添加相應(yīng)的配置來實(shí)現(xiàn)。

例如，我們可以在 application.yml 中添加如下配置：

logging:
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} : %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} : %msg%n"

以上配置分別設(shè)置了控制臺(tái)輸出和日志文件輸出的日志格式。%d 表示時(shí)間戳，%thread 表示線程信息，%-5level 表示日志級(jí)別（左對(duì)齊，占5個(gè)字符寬度），%logger{36} 表示類名（只顯示類名的后36個(gè)字符，防止類名過長），%msg 表示日志內(nèi)容，%n 表示換行。

通過配置不同的日志格式，我們可以自定義日志的輸出內(nèi)容和樣式，滿足不同的需求。

需要注意的是，日志配置不僅限于上述兩種輸出格式，Spring Boot 還支持更多的日志配置選項(xiàng)，如日志文件路徑、日志滾動(dòng)策略、日志級(jí)別等?？梢愿鶕?jù)實(shí)際需求，在 application.yml 或 application.properties 中添加對(duì)應(yīng)的日志配置，以滿足不同的日志輸出和管理需求。

三、自定義日志輸出

在 Spring Boot 中，我們可以自定義日志輸出，包括選擇不同的日志框架、獲取日志對(duì)象并使用日志對(duì)象打印日志。下面分別介紹這三個(gè)方面。

3.1 日志框架

日志門面（Logging Facades）和日志實(shí)現(xiàn)是 Java 應(yīng)用中常用的兩種日志相關(guān)的組件。

• 日志門面是一種接口或抽象層，提供了統(tǒng)一的日志接口，允許應(yīng)用程序使用統(tǒng)一的方式記錄日志，而不依賴于特定的日志實(shí)現(xiàn)。
• 而日志實(shí)現(xiàn)則是具體的日志框架，實(shí)現(xiàn)了日志門面定義的接口，并負(fù)責(zé)將日志信息輸出到相應(yīng)的目的地，如控制臺(tái)或日志文件。

在 Java 生態(tài)系統(tǒng)中，有多個(gè)日志門面和日志實(shí)現(xiàn)可供選擇。其中，常見的日志門面有 commons-logging 和 SLF4J，常見的日志實(shí)現(xiàn)有 log4j 1/2、JUL（Java Util Logging）以及 logback。

1. Commons-Logging：是 Apache Commons Logging 組件，是 JDK 日志的一個(gè)簡單封裝。它為開發(fā)者提供了一種統(tǒng)一的接口來記錄日志，可以透明地切換不同的日志實(shí)現(xiàn)，但在實(shí)際使用中并不常見，因?yàn)樗墓δ茌^為有限且發(fā)展相對(duì)較早。

2. SLF4J（Simple Logging Facade for Java）：是目前較為廣泛使用的日志門面。它提供了一套簡單的抽象接口，使開發(fā)者能夠以統(tǒng)一的方式記錄日志。與 Commons-Logging 不同，SLF4J 設(shè)計(jì)更為優(yōu)雅且功能更全面，它成為了許多 Java 應(yīng)用的首選日志門面。

在選擇日志門面后，我們需要選擇相應(yīng)的日志實(shí)現(xiàn)來實(shí)際輸出日志信息。常見的日志實(shí)現(xiàn)有：

1. Log4j 1：是 Apache Log4j 1.x 版本，是較早的日志實(shí)現(xiàn)，功能強(qiáng)大且配置靈活。不過由于版本較舊，有些特性在現(xiàn)代的應(yīng)用中可能顯得有些過時(shí)。

2. Log4j 2：是 Apache Log4j 2.x 版本，是 Log4j 1 的升級(jí)版，擁有更多的功能和性能優(yōu)化。Log4j 2 同時(shí)支持 SLF4J，因此可以無縫地與 SLF4J 集成。

3. JUL（Java Util Logging）：是 JDK 自帶的日志實(shí)現(xiàn)，相對(duì)簡單，無需額外依賴，但功能較為有限。由于不需要額外的庫，有些 Java 庫和框架會(huì)使用 JUL 作為默認(rèn)日志實(shí)現(xiàn)。

4. Logback：是由 Log4j 1 的原始作者設(shè)計(jì)的日志實(shí)現(xiàn)，旨在替代 Log4j。Logback 是性能優(yōu)越且功能強(qiáng)大的日志框架，與 SLF4J 高度集成，因此在配合 SLF4J 使用時(shí)效果非常好。

在選擇日志框架時(shí)，推薦使用 SLF4J 作為日志門面，并結(jié)合相應(yīng)的日志實(shí)現(xiàn)，如 Logback 或 Log4j 2。這樣可以保持日志輸出的靈活性，并且能夠在不改變應(yīng)用代碼的情況下切換到其他的日志實(shí)現(xiàn)，同時(shí)兼顧性能和功能的需求。

3.2 日志對(duì)象的獲取

在 Spring Boot 組件類中，我們可以使用 LoggerFactory 類的靜態(tài)方法 getLogger(Class) 來獲取日志對(duì)象。通常，我們會(huì)將日志對(duì)象作為類的成員變量，以便在類的各個(gè)方法中使用。

@RestController
public class LoggerController {
    private Logger logger = LoggerFactory.getLogger(LoggerController.class);
    
    @RequestMapping("/log")
    public void logging(){
        logger.trace("i am trace");
        logger.debug("i am debug");
        logger.info("i am info");
        logger.warn("i am warn");
        logger.error("i am error");
    }
}

3.3 使用日志對(duì)象打印日志

運(yùn)行啟動(dòng)類，然后在瀏覽器中輸入localhost:8080/log 觸發(fā)日志信息的打?。?/p>

此時(shí)就能夠在控制臺(tái)看到打印出的日志信息，但是我們發(fā)現(xiàn)只打印了INFO、WARN、ERROR這三個(gè)日志，而 TRACE 和 DEBUG 卻沒有打印，其原因和日志的級(jí)別有關(guān)。

四、日志級(jí)別

日志級(jí)別是指日志信息的重要程度或嚴(yán)重程度，不同級(jí)別的日志信息對(duì)應(yīng)不同的事件和狀態(tài)。在 Spring Boot 中，日志級(jí)別用于控制日志輸出的詳細(xì)程度，可以通過設(shè)置不同的日志級(jí)別來控制哪些日志信息會(huì)被記錄和輸出，從而靈活地控制日志的量和內(nèi)容。

由于 Spring Boot 默認(rèn)輸出的日志級(jí)別是 INFO，因此只能看到INFO及更高基本的日志信息。

4.1 日志級(jí)別的作用

• 日志級(jí)別的作用在于幫助開發(fā)人員在不同的場景下過濾和定位日志信息。通過設(shè)置適當(dāng)?shù)娜罩炯?jí)別，可以在開發(fā)階段記錄較為詳細(xì)的日志信息，幫助調(diào)試和排查問題；

• 而在生產(chǎn)環(huán)境中，可以設(shè)置較低的日志級(jí)別，只記錄重要的信息，避免過多的日志輸出對(duì)系統(tǒng)性能造成影響。

4.2 日志級(jí)別的分類

常見的日志級(jí)別（從低到高）包括：

1. TRACE（最低級(jí)別）：最詳細(xì)的日志信息，用于追蹤程序的運(yùn)行過程，通常在開發(fā)和調(diào)試階段使用。

2. DEBUG：調(diào)試級(jí)別的日志信息，用于輸出調(diào)試相關(guān)的信息，便于排查問題。

3. INFO：一般的信息級(jí)別，用于輸出程序運(yùn)行狀態(tài)的一般信息。

4. WARN：警告級(jí)別，用于記錄可能會(huì)導(dǎo)致問題的情況，但不影響程序正常運(yùn)行。

5. ERROR：錯(cuò)誤級(jí)別，用于記錄錯(cuò)誤信息，表示程序發(fā)生了錯(cuò)誤。

6. FATAL（最高級(jí)別）：最嚴(yán)重的錯(cuò)誤級(jí)別，用于記錄致命錯(cuò)誤，表示程序無法繼續(xù)運(yùn)行。

日志級(jí)別可以按照從低到高的順序分為兩類：

1. 調(diào)試級(jí)別：包括 TRACE 和 DEBUG，用于輸出程序運(yùn)行過程中的詳細(xì)信息，通常在開發(fā)和調(diào)試階段使用。

2. 運(yùn)行級(jí)別：包括 INFO、WARN、ERROR 和 FATAL，用于輸出程序運(yùn)行狀態(tài)和潛在問題，可以在生產(chǎn)環(huán)境中使用。

4.3 通過配置文件設(shè)置日志級(jí)別

在 Spring Boot 中，可以通過配置文件來設(shè)置日志級(jí)別。默認(rèn)情況下，Spring Boot 使用 application.yml 或 application.properties 中的配置來控制日志級(jí)別。

以下是在 application.yml 中設(shè)置日志級(jí)別的示例：

logging:
  level:
    root: INFO  # 根日志級(jí)別為 INFO，即默認(rèn)情況下的日志級(jí)別
    com:
      example:
        controller: DEBUG  # com.example.controller 包及其子包的日志級(jí)別為 DEBUG
        component: ERROR  # com.example.component 包及其子包的日志級(jí)別為 ERROR

在上述示例中，我們?cè)O(shè)置了三個(gè)不同包的日志級(jí)別：根日志級(jí)別為 INFO，com.example.controller 包及其子包的日志級(jí)別為 DEBUG，com.example.component 包及其子包的日志級(jí)別為 ERROR。

通過設(shè)置不同的日志級(jí)別，可以在不同的場景下靈活控制日志輸出的詳細(xì)程度，幫助開發(fā)人員更好地調(diào)試和監(jiān)控應(yīng)用程序。

五、日志持久化

五、日志持久化

在應(yīng)用程序運(yùn)行期間，產(chǎn)生的日志信息通常需要進(jìn)行持久化，以便后續(xù)的日志審計(jì)、問題排查和性能分析等目的。日志持久化是將日志信息保存到持久化存儲(chǔ)介質(zhì)，如日志文件、數(shù)據(jù)庫或遠(yuǎn)程日志服務(wù)器等的過程。在 Spring Boot 中，常見的日志持久化方式包括：

5.1 日志輸出到文件

Spring Boot 默認(rèn)情況下會(huì)將日志輸出到控制臺(tái)（Console），但通常為了更好地管理和維護(hù)日志，我們希望將日志輸出到文件。通過在 application.yml 或 application.properties 中添加相應(yīng)的配置，可以將日志輸出到文件。

例如，在 application.yml 中添加以下配置：

logging:
  file:
    name: myapp.log  # 設(shè)置日志文件的名稱，可以是任意文件名

上述配置將會(huì)將日志以追加的方式輸出到名為 myapp.log 的文件中。日志文件會(huì)被保存在應(yīng)用程序的工作目錄下，通常是項(xiàng)目的根目錄。

5.2 日志輸出到數(shù)據(jù)庫

有時(shí)候，我們希望將日志信息存儲(chǔ)到數(shù)據(jù)庫中，以便更方便地查詢和分析。Spring Boot 可以通過日志框架來實(shí)現(xiàn)將日志輸出到數(shù)據(jù)庫的功能。

首先，我們需要?jiǎng)?chuàng)建一個(gè)用于保存日志信息的數(shù)據(jù)庫表。可以根據(jù)實(shí)際需求設(shè)計(jì)數(shù)據(jù)庫表結(jié)構(gòu)，例如，包括日志級(jí)別、時(shí)間戳、日志內(nèi)容、類名、方法名等字段。

然后，我們可以使用合適的日志框架來配置將日志信息輸出到數(shù)據(jù)庫。對(duì)于 Logback，可以使用其提供的 DBAppender 來實(shí)現(xiàn)日志輸出到數(shù)據(jù)庫。

六、使用 Lombok 實(shí)現(xiàn)更簡單的日志輸出

Lombok 是一款Java庫，它通過注解自動(dòng)為Java類生成一些通用的代碼，從而簡化了Java開發(fā)過程。在日志輸出方面，Lombok可以幫助我們更方便地使用日志對(duì)象，避免了手動(dòng)定義日志變量的繁瑣過程。

6.1 通過 EditStarts 插件添加 Lombok 依賴

首先，我們需要在項(xiàng)目的構(gòu)建文件（如pom.xml）中添加 Lombok 依賴，以便在項(xiàng)目中使用 Lombok。如果 Spring Boot 項(xiàng)目在創(chuàng)建的時(shí)候沒有勾選 Lombok 依賴，則可以通過 IDEA 中的 EditStarts 插件添加 Lombok 依賴：

1. 安裝 EditStarts 插件

2. 在 pom.xml 文件中點(diǎn)擊右鍵選擇 Generate。

3. 選擇 Edit Starters，如果沒有則說明沒有安裝成功。

4. 點(diǎn)擊后出現(xiàn)如下界面，點(diǎn)擊 OK 。

5. 然后出現(xiàn)以下界面，在 Search 中搜索需要的依賴添加即可。

6.2 輸出日志

使用 Lombok 來簡化日志輸出非常簡單。我們只需要在類上添加 @Slf4j 注解，Lombok 就會(huì)自動(dòng)為我們生成一個(gè)名為 log 的日志對(duì)象。

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class LoggerController {

    @RequestMapping("/log")
    public void logging(){
        log.trace("i am trace");
        log.debug("i am debug");
        log.info("i am info");
        log.warn("i am warn");
        log.error("i am error");
    }
}

在上述示例中，我們使用 @Slf4j 注解在類上，Lombok 會(huì)為 LoggerController 類生成一個(gè)名為 log 的日志對(duì)象。之后我們就可以直接使用 log 對(duì)象來輸出不同級(jí)別的日志信息，而不需要手動(dòng)定義日志對(duì)象。

通過 Lombok 的簡化，我們可以更加便捷地實(shí)現(xiàn)日志輸出，避免了手動(dòng)定義日志對(duì)象和導(dǎo)入日志框架包的麻煩，提高了代碼的可讀性和簡潔性。文章來源地址http://www.zghlxwxcb.cn/news/detail-628779.html

到了這里，關(guān)于【Spring Boot】（三）深入理解 Spring Boot 日志的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！