Python Logging模块使用详解和案例分享

一、Log的作用及Python Logging模块简介

在程序开发中，日志是开发者必不可少的一部分。它可以记录程序运行的一些状态及出现的错误，便于后续的排查和优化。而Python Logging模块则是Python自带的一个内置日志管理模块，它可以方便地记录日志并对日志进行分类处理，同时还支持自定义日志格式、日志级别等功能。

Python Logging模块中常用的四个组件分别为：Logger、Handler、Formatter、Filter。Logger代表着一个日志记录器，用于记录日志，在Logger中可以设定日志的级别、输出目标以及日志记录器的名称等；Handler则是用于将日志信息输出到特定的位置，如控制台、文件等，一个Logger可以同时绑定多个Handler；Formatter则是定义的日志输出格式，可以包括时间、日志级别、线程ID、日志内容等；Filter则是对日志记录进行过滤，只有符合过滤条件的才能输出，否则忽略此记录。

下面是一个简单的Python Logging模块使用示例：

import logging

# 创建Logger对象
logger = logging.getLogger('example_logger')
logger.setLevel(logging.DEBUG)

# 创建FileHandler对象
file_handler = logging.FileHandler('example.log')
file_handler.setLevel(logging.INFO)

# 创建Formatter对象
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)

# 绑定Handler
logger.addHandler(file_handler)

# 输出日志
logger.info('Info message')
logger.debug('Debug message')
logger.warning('Warning message')

二、Python Logging模块高级功能

Python Logging模块除了基本的日志记录外，还支持一些高级功能，如：

1、日志轮替

在日志记录中，如果一直向同一个文件输出日志，那么文件大小会不停增大，不方便后续的查看和管理。因此，日志轮替可以实现定时或按日志文件大小生成新的日志文件并写入日志信息。

日志轮替有两种方式，一种是根据时间轮替，另一种是根据日志文件大小轮替。以下是一个根据时间轮替的示例：

import logging
import logging.handlers

# 创建TimeRotatingFileHandler对象
file_handler = logging.handlers.TimedRotatingFileHandler('example.log', when='midnight', interval=1, backupCount=5)

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)

logger = logging.getLogger('example_logger')
logger.addHandler(file_handler)

logger.info('Info message')
logger.debug('Debug message')
logger.warning('Warning message')

2、日志回滚

在日志记录中，如果出现程序异常导致日志输出被打断，那么在之后的日志记录中将无法继续写入原来的日志文件中，因此，可以使用日志回滚功能，将程序异常中断前未写入的日志记录存储到本地的其他文件中以保证日志记录的完整性。

以下是一个根据程序异常回滚的示例：

import logging
import logging.handlers

# 创建RotatingFileHandler对象
file_handler = logging.handlers.RotatingFileHandler('example.log', maxBytes=100, backupCount=5)

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)

logger = logging.getLogger('example_logger')
logger.addHandler(file_handler)

try:
    # 执行程序代码
except Exception as e:
    logger.error('Exception occurred: %s', e, exc_info=True)

logger.info('Info message')
logger.debug('Debug message')
logger.warning('Warning message')

三、Python Logging模块案例分享

下面是一个模拟银行交易系统的Python Logging模块案例：

import logging
from logging.handlers import TimedRotatingFileHandler

class BankSystemLogging:

    def __init__(self, logger_name):

        self.logger = logging.getLogger(logger_name)
        self.logger.setLevel(logging.DEBUG)

        # 定义日志格式
        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

        # 控制台输出日志
        console_handler = logging.StreamHandler()
        console_handler.setLevel(logging.WARNING)
        console_handler.setFormatter(formatter)

        # 按天轮替日志文件
        file_handler = TimedRotatingFileHandler('bank_transaction.log', when='midnight', interval=1, backupCount=5, encoding='utf-8')
        file_handler.setLevel(logging.DEBUG)
        file_handler.setFormatter(formatter)

        self.logger.addHandler(console_handler)
        self.logger.addHandler(file_handler)

    # 记录交易日志
    def transaction(self, account, amount):
        self.logger.info('Transaction: account=%s, amount=%s', account, amount)

    # 记录异常日志
    def exception(self, msg):
        self.logger.error(msg, exc_info=True)

# 使用示例
logger = BankSystemLogging('bank_system')
try:
    # 执行银行交易代码
except Exception as e:
    logger.exception('Exception occurred: %s', str(e))

四、总结

Python Logging模块是Python自带的一个内置日志管理模块，可以方便地记录日志并对日志进行分类处理，同时支持自定义日志格式、日志级别等高级功能。在程序开发中，合理利用Python Logging模块可以提高程序的开发效率。