快捷導(dǎo)航

Java中Logger定義的3種方式及最佳實(shí)踐

更新時(shí)間：2025年02月18日 09:51:40 作者：兮動(dòng)人

這篇文章主要介紹了Java中三種常見(jiàn)的Logger定義方式及其優(yōu)缺點(diǎn),同時(shí)文章還討論了Logger的命名和訪問(wèn)修飾符的最佳實(shí)踐,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下

1. 常見(jiàn)的 Logger 定義方式

以下是三種常見(jiàn)的 Logger 定義方式：

1.1 使用 private static final 并指定類名

private static final Logger LOGGER = LoggerFactory.getLogger(xxx.class);

使用類名作為日志記錄器的上下文，通常推薦的寫法。
定義為 static 表明這是類級(jí)別的日志記錄器，不隨實(shí)例化變化。
final 確保引用不會(huì)被重新賦值。

優(yōu)點(diǎn)：

性能最佳。日志記錄器在類加載時(shí)只初始化一次，減少運(yùn)行時(shí)開銷。

清晰直觀，日志記錄器的名稱與當(dāng)前類綁定。

是多數(shù) Java 開發(fā)團(tuán)隊(duì)的最佳實(shí)踐，符合常見(jiàn)編碼規(guī)范。

缺點(diǎn)：

只能在當(dāng)前類中使用，如果子類需要日志功能，需要重新定義自己的日志記錄器。

1.2 使用 private final 并指定類名

private final Logger LOGGER = LoggerFactory.getLogger(xxx.class);

非靜態(tài)變量，意味著每次創(chuàng)建類實(shí)例時(shí)都會(huì)初始化日志記錄器。
定義為 final，但生命周期與類實(shí)例綁定。

優(yōu)點(diǎn)：
如果日志需要綁定到類的實(shí)例，而非類本身（極少見(jiàn)），可以考慮這種方式。
適用于極少數(shù)特定需求，比如動(dòng)態(tài)代理或依賴注入。

缺點(diǎn)：
每次實(shí)例化都會(huì)重新創(chuàng)建日志記錄器，性能開銷大，通常不推薦。
不符合日志記錄器與類綁定的慣例，大多數(shù)團(tuán)隊(duì)不會(huì)采用。

1.3 使用 this.getClass() 動(dòng)態(tài)獲取類名

private static final Logger LOGGER = LoggerFactory.getLogger(this.getClass());

動(dòng)態(tài)獲取當(dāng)前類的名稱作為日志記錄器的上下文。
通常在基類中定義，以便子類可以復(fù)用同一個(gè)代碼邏輯而獲取自己的類名。

優(yōu)點(diǎn)：
基類定義日志記錄器時(shí)，子類無(wú)需重復(fù)聲明，減少代碼冗余。
動(dòng)態(tài)適配子類的名稱，方便統(tǒng)一管理日志輸出。

缺點(diǎn)：
this.getClass() 是運(yùn)行時(shí)操作，性能稍差。
如果子類與基類日志內(nèi)容強(qiáng)耦合，可能導(dǎo)致調(diào)試?yán)щy。

2. Logger 定義中的其他考量

2.1 Logger 的命名：大寫還是小寫？

推薦使用全大寫（如 LOGGER），符合 static final 常量的命名規(guī)范。
小寫（如 logger）雖然可以使用，但在團(tuán)隊(duì)合作中可能造成代碼風(fēng)格不一致的問(wèn)題。

2.2 Logger 的訪問(wèn)修飾符：private 還是 protected？

1、private：
日志記錄器是類的內(nèi)部實(shí)現(xiàn)細(xì)節(jié)，通常不需要對(duì)子類暴露，推薦使用 private。
每個(gè)類有自己的日志記錄器，便于區(qū)分日志來(lái)源。
2、 protected：在需要共享日志記錄器的場(chǎng)景下（如基類和子類高度相關(guān)），可以考慮使用 protected。

使用時(shí)要小心，避免子類濫用父類日志記錄器，造成日志內(nèi)容混亂。

3. 推薦的最佳實(shí)踐

從性能、可讀性和維護(hù)性出發(fā)，推薦如下寫法：

private static final Logger LOGGER = LoggerFactory.getLogger(xxx.class);

符合日志記錄器與類綁定的習(xí)慣。
性能最佳，日志記錄器只初始化一次。
明確日志來(lái)源，便于日志排查和維護(hù)。
特殊場(chǎng)景：如果存在父類與子類共享日志邏輯的需求，可以使用 this.getClass() 動(dòng)態(tài)適配子類名稱，但需要權(quán)衡性能和復(fù)雜性。