引言

在軟件開發(fā)中，日志（Logging）是不可或缺的工具。它幫助我們追蹤程序執(zhí)行流程、診斷錯誤、監(jiān)控系統(tǒng)狀態(tài)，是調(diào)試、運維和分析用戶行為的關(guān)鍵。Python 內(nèi)置的 logging 模塊功能強大且靈活，遠超簡單的 print 語句。

一、logging對比print

你可能習(xí)慣用 print() 輸出信息，但 logging 模塊提供了 print 無法比擬的優(yōu)勢：

• 日志級別（Levels）：支持 DEBUG, INFO, WARNING, ERROR, CRITICAL 等級別，可以方便地控制不同環(huán)境（開發(fā)、測試、生產(chǎn)）輸出的信息量。
• 靈活的輸出目標（Handlers）：日志可以同時輸出到控制臺、文件、網(wǎng)絡(luò)、郵件、數(shù)據(jù)庫等，而 print 只能輸出到標準輸出。
• 豐富的格式化（Formatters）：可以自定義日志的輸出格式，包含時間、模塊名、行號、日志級別等信息。
• 性能：在生產(chǎn)環(huán)境中，可以將日志級別設(shè)為 WARNING，此時 debug() 調(diào)用幾乎不消耗性能（因為消息不會被格式化），而 print 語句即使注釋掉也需要手動操作。
• 結(jié)構(gòu)化與可維護性：logging 提供了清晰的架構(gòu)，易于配置和管理，適合大型項目。

二、基本使用方法

2.1 導(dǎo)入 logging 模塊

import logging

2.2 日志級別介紹

日志級別用于控制日志的詳細程度。logging 模塊提供了以下幾種日志級別：

注意：默認日志級別是 WARNING，即低于 WARNING 的日志不會被輸出。

需要設(shè)置日志顯示的最低顯示級別。如顯示所有日志，設(shè)置為最低級別DEBUG：

logging.basicConfig(level=logging.DEBUG)

2.3 簡單使用示例

快速使用日志的完整功能示例：

import logging
logging.basicConfig(level=logging.INFO)

logging.debug("這是一條調(diào)試信息")
logging.info("這是一條普通信息")
logging.warning("這是一條警告信息")
logging.error("這是一條錯誤信息")
logging.critical("這是一條嚴重錯誤信息")

運行結(jié)果：

三、logging 模塊的核心組件

logging 模塊基于一個經(jīng)典的 生產(chǎn)者-過濾器-處理器 模型，主要由四個核心對象構(gòu)成：

3.1 Logger (記錄器)

角色：應(yīng)用程序的接口。你通過 Logger 對象調(diào)用 debug(), info(), warning(), error(), critical() 方法來記錄日志。

關(guān)鍵屬性：

• 名稱（Name）：通常使用 logging.getLogger(__name__) 創(chuàng)建，__name__ 是模塊的全名（如 myapp.module），這有助于組織日志層次結(jié)構(gòu)。
• 級別（Level）：Logger 有一個日志級別。只有級別大于或等于此級別的日志記錄才會被處理。如果 Logger 本身沒有設(shè)置級別，它會向上傳遞到父 Logger（最終到根 Logger）。

層級結(jié)構(gòu)：Logger 按名稱形成樹狀結(jié)構(gòu)。myapp 是 myapp.module 的父 Logger。日志消息會沿著這個層級向上傳播，除非設(shè)置了 propagate=False。

3.2 Handler (處理器)

角色：決定日志消息的最終去向。一個 Logger 可以有多個 Handler。

常見 Handler：

• StreamHandler：輸出到流（如 sys.stdout, sys.stderr）。
• FileHandler：輸出到文件。
• RotatingFileHandler：輸出到文件，并在文件達到一定大小時輪轉(zhuǎn)。
• TimedRotatingFileHandler：按時間（如每天）輪轉(zhuǎn)日志文件。
• SMTPHandler：通過郵件發(fā)送日志。
• SocketHandler / DatagramHandler：通過網(wǎng)絡(luò)發(fā)送日志。

• 關(guān)鍵屬性：

  • 級別（Level）：Handler 也有自己的級別。即使 Logger 接受了一條日志，Handler 也會根據(jù)自己的級別再次過濾。例如，Logger 級別是 DEBUG，Handler 級別是 INFO，那么 DEBUG 級別的日志不會被這個 Handler 處理。

  • Formatter：關(guān)聯(lián)一個 Formatter 來格式化日志消息。

3.3 Formatter (格式化器)

• 角色：定義日志消息的最終輸出格式。

• 格式：使用類似 %(asctime)s - %(name)s - %(levelname)s - %(message)s 的字符串。

• 可以為不同的 Handler 設(shè)置不同的 Formatter。例如，文件日志包含詳細信息（時間、行號），而控制臺日志只顯示簡潔信息。

Formatter 常用格式字段如下:

3.4 Filter (過濾器)

• 角色：提供更精細的日志過濾機制，可以基于 Logger 名稱、日志級別或其他屬性進行過濾。
• 使用場景：相對較少直接使用，Logger 和 Handler 的級別通常足夠。但可以用于實現(xiàn)復(fù)雜邏輯，比如只記錄特定用戶的日志。

3.5 核心組件快速使用示例

import logging

# 1. 獲取一個 Logger 實例（通常使用模塊名）
logger = logging.getLogger(__name__)

# 2. 設(shè)置 Logger 級別
logger.setLevel(logging.DEBUG)

# 3. 創(chuàng)建 Handler (例如，輸出到控制臺)
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO) # Handler 級別

# 4. 創(chuàng)建 Formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)

# 5. 將 Handler 添加到 Logger
logger.addHandler(console_handler)

# 6. 記錄日志
logger.debug("調(diào)試信息")
logger.info("普通信息")
logger.warning("警告信息")
logger.error("錯誤信息")
logger.critical("嚴重錯誤")

運行結(jié)果：

四、高級用法與最佳實踐

1、配置分離：將日志配置獨立出來

將配置放在單獨的文件中，是大型項目的標準做法。推薦使用 dictConfig。

# logging_config.py
import logging
from logging.config import dictConfig
?
LOGGING_CONFIG = {
    "version": 1,
    "disable_existing_loggers": False,  # 避免禁用第三方庫日志
    "formatters": {
        "detailed": {
            "format": "%(asctime)s - %(name)s - %(levelname)s - %(filename)s:%(lineno)d - %(message)s"
        },
        "simple": {
            "format": "%(name)s - %(levelname)s - %(message)s"
        }
    },
    "handlers": {
        "file": {
            "class": "logging.handlers.RotatingFileHandler", # 輪轉(zhuǎn)文件
            "level": "DEBUG",
            "formatter": "detailed",
            "filename": "app.log",
            "maxBytes": 10485760,  # 10MB
            "backupCount": 5,      # 保留 5 個備份
            "encoding": "utf-8"
        },
        "console": {
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple"
        }
    },
    "loggers": {
        "myapp": {  # 為你的應(yīng)用定義 logger
            "level": "DEBUG",
            "handlers": ["file", "console"],
            "propagate": False
        }
    }
}
?
dictConfig(LOGGING_CONFIG)
logger = logging.getLogger("myapp") # 創(chuàng)建全局 logger 實例

在其他模塊中使用：

# main.py
from logging_config import logger
?
logger.info("應(yīng)用啟動")

2、RotatingFileHandler 分割日志文件

FileHandler 會無限增長文件。使用 RotatingFileHandler 或 TimedRotatingFileHandler 可以自動管理日志文件大小和數(shù)量。

3、捕獲異常信息

try:
    result = 1 / 0
except Exception as e:
    logger.error("發(fā)生異常", exc_info=True) # exc_info=True 會自動記錄 traceback
    # 或者使用
    # logger.exception("發(fā)生異常") # 等價于 logger.error(..., exc_info=True)

4、在多模塊項目中使用name

# myapp/utils.py
import logging
logger = logging.getLogger(__name__) # __name__ 是 'myapp.utils'
?
def some_function():
    logger.info("在 utils 模塊中執(zhí)行")

這樣日志會清晰地顯示來源 myapp.utils - INFO - 在 utils 模塊中執(zhí)行。

5、避免重復(fù)日志

問題：如果 Logger 的 propagate=True（默認）且父 Logger 也有 Handler，日志可能被多次輸出。

解決方案：在配置中為你的應(yīng)用 Logger 設(shè)置 "propagate": False。

處理中文 在 FileHandler 或 RotatingFileHandler 中指定 encoding="utf-8"。

總結(jié)

Python 的 logging 模塊是一個功能完備、設(shè)計精良的日志框架。掌握其核心組件（Logger, Handler, Formatter, Filter）的工作原理，是構(gòu)建可靠應(yīng)用的基礎(chǔ)。通過合理的配置（尤其是使用 dictConfig 分離配置），你可以輕松實現(xiàn)：

• 多環(huán)境適配：開發(fā)時輸出 DEBUG 信息，生產(chǎn)時只輸出 WARNING 及以上。
• 多目標輸出：同時將詳細日志寫入文件，將關(guān)鍵信息輸出到控制臺。
• 結(jié)構(gòu)化日志：包含時間、位置、級別等上下文信息，便于排查問題。
• 可維護性：配置集中管理，易于調(diào)整。

告別 print，擁抱 logging，讓你的應(yīng)用擁有清晰、可追溯的“生命日志”！

到此這篇關(guān)于python進階之logging日志模塊的使用的文章就介紹到這了,更多相關(guān)python logging日志 內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論