AVt天堂网 手机版,亚洲va久久久噜噜噜久久4399,天天综合亚洲色在线精品,亚洲一级Av无码毛片久久精品

當前位置:首頁 > 科技  > 軟件

使用@Log和@Slf4j裝飾器提升Spring Boot的日志功能

來源: 責編: 時間:2023-10-08 07:05:28 229觀看
導讀一、介紹Spring Boot作為開發(fā)企業(yè)級應用程序的熱門選擇,因其易用性和豐富的功能而備受青睞。然而,在構建應用程序時,經(jīng)常被忽視但卻很重要的一個方面是日志記錄。日志記錄對于問題追蹤、系統(tǒng)監(jiān)測和應用程序流程理解至關

一、介紹

Spring Boot作為開發(fā)企業(yè)級應用程序的熱門選擇,因其易用性和豐富的功能而備受青睞。然而,在構建應用程序時,經(jīng)常被忽視但卻很重要的一個方面是日志記錄。日志記錄對于問題追蹤、系統(tǒng)監(jiān)測和應用程序流程理解至關重要。Spring Boot提供了一套內置的日志記錄工具,并借助Lombok庫的幫助,開發(fā)人員可以使用諸如@Log和@Slf4j等注解進一步簡化日志記錄的過程。本文介紹這些注解,以及如何在Spring Boot應用程序中有效地利用它們。ZBj28資訊網(wǎng)——每日最新資訊28at.com

ZBj28資訊網(wǎng)——每日最新資訊28at.com

二、Spring Boot中日志記錄的基礎知識

在使用Spring Boot時,開發(fā)人員可以獲得一個功能強大且可配置的日志記錄系統(tǒng)。本節(jié)旨在提供對該系統(tǒng)的基本要素和基礎知識的概述。ZBj28資訊網(wǎng)——每日最新資訊28at.com

1.Spring Boot的默認日志記錄框架

Spring Boot默認包含了Java的簡單日志門面(Simple Logging Facade for Java,SLF4J)以及Logback。SLF4J充當抽象層,意味著您可以在部署時插入首選的日志記錄框架,而Logback則作為默認實現(xiàn)。這種組合為開發(fā)人員提供了靈活且高度可配置的日志記錄設置。ZBj28資訊網(wǎng)——每日最新資訊28at.com

2. 理解日志記錄級別

在日志記錄領域,不是所有的消息都是相等的。消息按嚴重程度或重要性進行分類,稱為日志記錄級別。Spring Boot支持標準級別,包括:ZBj28資訊網(wǎng)——每日最新資訊28at.com

  • ERROR:表示出現(xiàn)了錯誤,應用程序可能無法繼續(xù)運行。
  • WARN:表示可能存在問題,可能不會立即影響功能,但需要關注。
  • INFO:提供有關應用程序操作的一般信息。通常用于確認應用程序按預期工作。
  • DEBUG:為開發(fā)人員提供詳細的洞察以診斷問題或理解流程。
  • TRACE:提供比DEBUG更詳細的細節(jié),通常包括迭代或重復的過程。

每個級別都包含其上面的級別。例如,如果將級別設置為WARN,則還將看到ERROR消息,但不會看到INFO、DEBUG或TRACE消息。ZBj28資訊網(wǎng)——每日最新資訊28at.com

3. 在application.properties中配置日志記錄

Spring Boot允許開發(fā)人員使用application.properties(或application.yml)文件配置日志記錄系統(tǒng)。以下是一些常見的配置:ZBj28資訊網(wǎng)——每日最新資訊28at.com

設置全局日志記錄級別: 為所有記錄器設置基本級別:ZBj28資訊網(wǎng)——每日最新資訊28at.com

logging.level.root=WARN

設置特定日志記錄級別: 為特定的包或類定義特定級別:ZBj28資訊網(wǎng)——每日最新資訊28at.com

logging.level.org.springframework.web=DEBUGlogging.level.com.myapp.service=INFO

日志文件輸出: 默認情況下,日志輸出到控制臺。如果要將其保存到文件中:ZBj28資訊網(wǎng)——每日最新資訊28at.com

logging.file.name=myapp.log

日志文件輪轉: 對于較大的應用程序,日志可能會快速增長。為了管理大小,Spring Boot可以進行日志輪轉:ZBj28資訊網(wǎng)——每日最新資訊28at.com

logging.file.max-size=10MBlogging.file.max-history=10

4. 日志格式自定義

Spring Boot的默認日志輸出簡潔且對開發(fā)人員友好。但是,對于特定要求,您可能希望自定義日志模式。使用logging.pattern.console和logging.pattern.file,可以分別定義控制臺和文件輸出的自定義模式。ZBj28資訊網(wǎng)——每日最新資訊28at.com

例如:ZBj28資訊網(wǎng)——每日最新資訊28at.com

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} - %logger{36} - %msg%n

此模式包括時間戳、記錄器名稱(最多36個字符)和實際消息。ZBj28資訊網(wǎng)——每日最新資訊28at.com

三、Lombok和日志記錄注解介紹

當涉及到減少樣板代碼時,Project Lombok對Java開發(fā)人員來說是一個福音。雖然Java的冗長對于理解程序邏輯可能是一個優(yōu)勢,但對于像日志設置這樣的常見任務來說,它可能成為一個負擔。這就是Lombok發(fā)揮作用的地方。ZBj28資訊網(wǎng)——每日最新資訊28at.com

1. 什么是Lombok?

Lombok是一個編譯時注解處理器。你不需要編寫重復的代碼,也不需要依賴你的IDE生成代碼,Lombok提供了注解來指示編譯器代替你生成代碼。這不僅使你的代碼庫更清潔,而且使開發(fā)過程更快速、更少出錯。ZBj28資訊網(wǎng)——每日最新資訊28at.com

2. Lombok的日志注解

雖然Lombok提供了各種注解來處理不同的任務,比如@Data用于生成getter、setter和其他常用方法,本文重點關注日志注解:ZBj28資訊網(wǎng)——每日最新資訊28at.com

@Slf4j: 這是Spring Boot應用中最常用的日志注解。當應用于一個類時,它會自動創(chuàng)建一個名為log的靜態(tài)SLF4J記錄器實例,指向SLF4J日志門面。ZBj28資訊網(wǎng)——每日最新資訊28at.com

@Slf4jpublic class MyService {    public void someServiceMethod() {        log.info("使用@Slf4j調用的服務方法");    }}

@Log: 這個注解用于依賴于java.util.logging框架的應用程序。與@Slf4j類似,它提供了一個名為log的靜態(tài)日志記錄器實例。ZBj28資訊網(wǎng)——每日最新資訊28at.com

@Logpublic class LegacyService {    public void legacyMethod() {        log.info("使用@Log記錄的舊方法");    }}

3. 使用Lombok日志注解的好處

  • 一致性:使用注解可以確保應用程序中的日志設置是一致的。有一種標準的方法來為任何類引入日志記錄。
  • 減少樣板代碼:不再需要在每個類中手動實例化日志記錄器。這減少了代碼行數(shù),使應用程序更易于維護。
  • 專注于業(yè)務邏輯:通過消除重復的任務,開發(fā)人員可以專注于業(yè)務邏輯,從而提高代碼質量和開發(fā)速度。
  • 重構簡便:當類名發(fā)生變化時,無需調整日志記錄器的聲明。Lombok會在編譯過程中自動處理這個問題。

4. 將Lombok與Spring Boot集成

要在Spring Boot中使用Lombok,只需將Lombok依賴項添加到項目的構建文件中:ZBj28資訊網(wǎng)——每日最新資訊28at.com

對于Maven:ZBj28資訊網(wǎng)——每日最新資訊28at.com

<dependency>    <groupId>org.projectlombok</groupId>    <artifactId>lombok</artifactId>    <version>CheckLatestVersion</version>    <scope>provided</scope></dependency>

對于Gradle:ZBj28資訊網(wǎng)——每日最新資訊28at.com

implementation 'org.projectlombok:lombok:CheckLatestVersion'annotationProcessor 'org.projectlombok:lombok:CheckLatestVersion'

注意:在添加依賴項時,請確保檢查最新的Lombok版本。ZBj28資訊網(wǎng)——每日最新資訊28at.com

四、使用@Log vs. @Slf4j

在探索日志記錄領域時,特別是在Spring Boot生態(tài)系統(tǒng)中,兩個Lombok注解經(jīng)常出現(xiàn)在前臺:@Log和@Slf4j。盡管這兩個注解都通過消除樣板代碼來簡化日志記錄,但了解它們之間的區(qū)別可以幫助開發(fā)人員選擇適合他們應用程序的正確注解。ZBj28資訊網(wǎng)——每日最新資訊28at.com

1. 起源和框架

@Slf4j:ZBj28資訊網(wǎng)——每日最新資訊28at.com

  • 起源: SLF4J是Simple Logging Facade for Java的縮寫。
  • 框架目標: 這個注解專門為SLF4J日志門面設計。由于SLF4J為各種日志框架提供了簡單的抽象,使用@Slf4j可以確保靈活性。如果將來決定從Logback(Spring Boot的默認框架)切換到另一個框架,如Log4j2,SLF4J可以實現(xiàn)平滑過渡。

@Log:ZBj28資訊網(wǎng)——每日最新資訊28at.com

  • 起源: 此注解直接來自java.util.logging包,通常縮寫為JUL。
  • 框架目標: @Log專為java.util.logging框架量身定制,該框架是Java的內置日志機制。盡管在Spring生態(tài)系統(tǒng)中,它不如SLF4J流行和多功能,但在傳統(tǒng)或特定的Java應用程序中,使用內置的日志機制是有優(yōu)勢的。

2. 使用場景

@Slf4j:ZBj28資訊網(wǎng)——每日最新資訊28at.com

  • 現(xiàn)代Spring Boot應用程序: 考慮到Spring Boot默認使用SLF4J和Logback,@Slf4j是大多數(shù)Spring Boot項目的首選注解。
  • 互操作性需求: 如果存在切換日志框架的潛在需求,由@Slf4j支持的SLF4J門面機制可確保平滑過渡。

@Log:ZBj28資訊網(wǎng)——每日最新資訊28at.com

  • 傳統(tǒng)應用程序: 在傳統(tǒng)的Java應用程序中,java.util.logging深深扎根,引入@Log可以為代碼提供一些現(xiàn)代化的便利性。
  • 內置Java環(huán)境: 對于需要最小化外部依賴的項目,依靠Java的內置日志機制,并輔以@Log的幫助可能是有益的。

3. 實施方法

對于這兩個注解,實施非常簡單。確保Lombok已與項目集成后,只需對類進行注解:ZBj28資訊網(wǎng)——每日最新資訊28at.com

對于@Slf4j:ZBj28資訊網(wǎng)——每日最新資訊28at.com

@Slf4jpublic class OrderService {    public void placeOrder() {        log.info("使用SLF4J成功下單");    }}

對于@Log:ZBj28資訊網(wǎng)——每日最新資訊28at.com

@Logpublic class InventoryChecker {    public void checkStock() {        log.info("使用java.util.logging檢查庫存");    }}

在這兩種情況下,Lombok會為您創(chuàng)建一個名為log的靜態(tài)記錄器實例。ZBj28資訊網(wǎng)——每日最新資訊28at.com

五、@Slf4j和日志記錄的最佳實踐

有效地進行日志記錄既與技巧有關,也與工具有關。盡管@Slf4j可以消除樣板代碼并簡化記錄器實例化過程,但理解和遵循最佳實踐是充分利用它的關鍵。ZBj28資訊網(wǎng)——每日最新資訊28at.com

1. 記錄有意義的消息

確保每條日志消息都提供上下文,并且對于對代碼不熟悉的人來說足夠清晰。應避免模棱兩可的消息,如“發(fā)生錯誤”。ZBj28資訊網(wǎng)——每日最新資訊28at.com

@Slf4jpublic class PaymentService {    public void processPayment(Payment payment) {        if (payment == null) {            log.error("由于空的付款對象,支付處理失敗。");        }        // ...    }}

2. 使用適當?shù)娜罩炯墑e

錯誤使用日志級別可能導致關鍵信息丟失或日志膨脹。確保使用正確的級別:ZBj28資訊網(wǎng)——每日最新資訊28at.com

  • ERROR:用于可能阻止應用程序繼續(xù)運行的嚴重問題。
  • WARN:用于潛在問題,但不會停止操作。
  • INFO:關于應用程序狀態(tài)的一般操作消息。
  • DEBUG:用于調試有用的消息,但對于一般日志來說太冗長。
  • TRACE:非常詳細的消息,通常用于復雜的調試。

3. 避免記錄敏感信息

永遠不要記錄像密碼、信用卡號或個人身份信息(PII)這樣的敏感信息。這是一項安全最佳實踐,并且在許多司法管轄區(qū)中是法律要求。ZBj28資訊網(wǎng)——每日最新資訊28at.com

4. 使用參數(shù)化日志記錄

使用SLF4J提供的參數(shù)化日志記錄,而不是字符串連接。這種方法高效,并且可以防止不必要的字符串創(chuàng)建。ZBj28資訊網(wǎng)——每日最新資訊28at.com

String orderId = "O12345";log.info("正在處理ID為{}的訂單", orderId);

5. 正確處理異常

在記錄異常時,關鍵是記錄完整的堆棧跟蹤以診斷根本原因。SLF4J使此變得容易:ZBj28資訊網(wǎng)——每日最新資訊28at.com

try {    // 可能會拋出異常的一些代碼} catch (Exception ex) {    log.error("處理時發(fā)生錯誤", ex);}

6. 不要僅僅依賴日志進行監(jiān)控

雖然日志在診斷中非常有價值,但它們不應該是唯一的監(jiān)控工具。應該與指標、警報和其他監(jiān)控工具結合使用。ZBj28資訊網(wǎng)——每日最新資訊28at.com

7. 輪轉和歸檔日志

確保日志系統(tǒng)設置了日志輪轉,防止任何單個文件過大,并確保舊的日志文件歸檔以備將來分析。可以使用Spring Boot中的logging.file.max-size和logging.file.max-history配置來實現(xiàn)。ZBj28資訊網(wǎng)——每日最新資訊28at.com

8. 避免在緊密循環(huán)內記錄日志

在循環(huán)內部,尤其是緊密循環(huán)內部記錄日志會嚴重減慢應用程序的速度并生成巨大的日志文件。在循環(huán)內部記錄日志時要謹慎,特別是在DEBUG或TRACE級別。ZBj28資訊網(wǎng)——每日最新資訊28at.com

9. 保持一致性

在應用程序中保持日志模式的一致性。這有助于可讀性,并確保自動化工具可以有效解析日志。ZBj28資訊網(wǎng)——每日最新資訊28at.com

10. 定期審查和修剪日志

日志常常包含“日志噪聲”——曾經(jīng)有用但現(xiàn)在只是干擾日志的消息。定期審查和修剪這些消息,確保日志仍然是有價值的資源。ZBj28資訊網(wǎng)——每日最新資訊28at.com

六、總結

日志記錄是任何應用程序不可或缺的重要組成部分。盡管Spring Boot已經(jīng)提供了一個強大的日志系統(tǒng),但通過利用Lombok庫中的@Log和@Slf4j等注解,可以進一步簡化和增強日志記錄的體驗。通過減少樣板代碼并提供直觀的消息記錄方式,開發(fā)人員能夠將精力集中在最重要的任務上:構建功能完備和高效的應用程序。請務必遵循最佳實踐,這樣你的Spring Boot應用程序的日志記錄將始終為你所用。ZBj28資訊網(wǎng)——每日最新資訊28at.com

本文鏈接:http://www.tebozhan.com/showinfo-26-12307-0.html使用@Log和@Slf4j裝飾器提升Spring Boot的日志功能

聲明:本網(wǎng)頁內容旨在傳播知識,若有侵權等問題請及時與本網(wǎng)聯(lián)系,我們將在第一時間刪除處理。郵件:2376512515@qq.com

上一篇: Vite也要用Rust重寫了,推薦一波開源的 Rust 學習資源!

下一篇: Astro是2023年最好的web框架,原因如下

標簽:
  • 熱門焦點
  • 6月安卓手機好評榜:魅族20 Pro蟬聯(lián)冠軍

    性能榜和性價比榜之后,我們來看最后的安卓手機好評榜,數(shù)據(jù)來源安兔兔評測,收集時間2023年6月1日至6月30日,僅限國內市場。第一名:魅族20 Pro好評率:95%5月份的時候魅族20 Pro就是
  • SpringBoot中使用Cache提升接口性能詳解

    環(huán)境:springboot2.3.12.RELEASE + JSR107 + Ehcache + JPASpring 框架從 3.1 開始,對 Spring 應用程序提供了透明式添加緩存的支持。和事務支持一樣,抽象緩存允許一致地使用各
  • 一篇聊聊Go錯誤封裝機制

    %w 是用于錯誤包裝(Error Wrapping)的格式化動詞。它是用于 fmt.Errorf 和 fmt.Sprintf 函數(shù)中的一個特殊格式化動詞,用于將一個錯誤(或其他可打印的值)包裝在一個新的錯誤中。使
  • 分享六款相見恨晚的PPT模版網(wǎng)站, 祝你做出精美的PPT!

    1、OfficePLUSOfficePLUS網(wǎng)站旨在為全球Office用戶提供豐富的高品質原創(chuàng)PPT模板、實用文檔、數(shù)據(jù)圖表及個性化定制服務。優(yōu)點:OfficePLUS是微軟官方網(wǎng)站,囊括PPT模板、Word模
  • 如何通過Python線程池實現(xiàn)異步編程?

    線程池的概念和基本原理線程池是一種并發(fā)處理機制,它可以在程序啟動時創(chuàng)建一組線程,并將它們置于等待任務的狀態(tài)。當任務到達時,線程池中的某個線程會被喚醒并執(zhí)行任務,執(zhí)行完任
  • JavaScript學習 -AES加密算法

    引言在當今數(shù)字化時代,前端應用程序扮演著重要角色,用戶的敏感數(shù)據(jù)經(jīng)常在前端進行加密和解密操作。然而,這樣的操作在網(wǎng)絡傳輸和存儲中可能會受到惡意攻擊的威脅。為了確保數(shù)據(jù)
  • Python異步IO編程的進程/線程通信實現(xiàn)

    這篇文章再講3種方式,同時講4中進程間通信的方式一、 Python 中線程間通信的實現(xiàn)方式共享變量共享變量是多個線程可以共同訪問的變量。在Python中,可以使用threading模塊中的L
  • 華為HarmonyOS 4升級計劃公布:首批34款機型今日開啟公測

    8月4日消息,今天下午華為正式發(fā)布了HarmonyOS 4系統(tǒng),在更流暢的前提下,還帶來了不少新功能,UI設計也有變化,會讓手機煥然一新。華為宣布,首批機型將會在
  • 朋友圈可以修改可見范圍了 蘋果用戶可率先體驗

    近日,iOS用戶迎來微信8.0.27正式版更新,除了可更換二維碼背景外,還新增了多項實用功能。在新版微信中,朋友圈終于可以修改可見范圍,簡單來說就是已發(fā)布的朋友圈
Top