python 如何对logging日志封装-猿码集

1. 概述

在Python中使用logging模块记录日志是一个很常见的需求。logging模块提供了各种功能来控制日志的格式、输出位置和级别。但是，在实际开发中，我们往往会封装一个通用的日志模块，以便在整个项目中统一管理和使用日志。

2. 日志封装的优势

封装日志模块的好处不言而喻：

统一管理：将所有的日志操作集中到一个模块中，方便统一管理和修改。

简化调用：封装后的日志模块可以提供简洁的调用接口，避免在每个模块中都重复编写类似的日志设置代码。

提供默认配置：封装的日志模块可以设置一些默认配置，例如日志级别、日志格式等，简化使用过程。

3. 日志封装的实现

3.1 创建一个Logger对象

首先，我们需要创建一个Logger对象，用于处理日志记录。Logger对象是logging模块的核心，负责发送日志消息到不同的目的地。

import logging
logger = logging.getLogger('my_logger')

在创建Logger对象时，一般会指定一个名称。名称可以是任意字符串，用于区分不同的日志记录器。如果名称相同，则返回同一个Logger实例。

3.2 设置日志级别

日志级别是决定哪些日志消息可以被输出的标准。logging模块定义了多个日志级别，从高到低分别为：CRITICAL、ERROR、WARNING、INFO和DEBUG。通过设置日志级别，我们可以控制日志输出的详细程度。

logger.setLevel(logging.DEBUG)

上述代码将日志级别设置为DEBUG，这意味着除了DEBUG级别的日志外，其他级别的日志也会被输出。

3.3 设置日志格式

设置日志格式可以影响日志输出的内容和样式。格式字符串可以包含特定的占位符，表示不同的日志信息，例如时间、日志级别、日志消息等。

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

上述代码定义了一个日志格式，其中包含了时间、日志级别和日志消息。可以根据需要自定义日志格式。

3.4 创建日志处理器

日志处理器负责将日志信息发送到不同的目的地，比如文件、终端、邮件等。我们可以根据需要创建多个日志处理器。

3.4.1 创建文件处理器

创建一个文件处理器，用于将日志写入到文件中。

file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.ERROR)
file_handler.setFormatter(formatter)
logger.addHandler(file_handler)

上述代码创建了一个FileHandler对象，将日志写入到名为'app.log'的文件中。还设置了日志级别为ERROR，并应用了前面定义的日志格式。

3.4.2 创建终端处理器

创建一个终端处理器，用于将日志打印到终端。

console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
console_handler.setFormatter(formatter)
logger.addHandler(console_handler)

上述代码创建了一个StreamHandler对象，将日志打印到终端。同样设置了日志级别和格式。

3.5 记录日志

最后，我们可以使用Logger对象记录日志信息。

logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

在上述代码中，记录了不同级别的日志信息。根据前面设置的日志级别，只有WARNING级别及以上的日志会被输出到文件和终端。

4. 封装一个日志模块

将上述代码封装成一个通用的日志模块，可以方便地在项目中使用。

import logging
def create_logger(name, level=logging.DEBUG, log_file=None):
    # 创建Logger对象
    logger = logging.getLogger(name)
    logger.setLevel(level)
    # 创建日志格式
    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
    # 创建文件处理器
    if log_file:
        file_handler = logging.FileHandler(log_file)
        file_handler.setLevel(level)
        file_handler.setFormatter(formatter)
        logger.addHandler(file_handler)
    # 创建终端处理器
    console_handler = logging.StreamHandler()
    console_handler.setLevel(level)
    console_handler.setFormatter(formatter)
    logger.addHandler(console_handler)
    return logger
# 使用示例
logger = create_logger('my_logger', level=logging.DEBUG, log_file='app.log')
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')
logger.error('This is an error message')
logger.critical('This is a critical message')

上述代码定义了一个名为create_logger的函数，用于创建一个配置好的Logger对象。可以通过指定名称、日志级别和日志文件来创建不同的Logger实例。

使用这个封装的日志模块，我们可以在项目的任何地方使用同一个日志记录器，方便地管理和输出日志。

5. 总结

通过封装logging模块，我们可以方便地统一管理和使用日志功能。封装的好处在于简化调用、提供默认配置、统一管理和灵活扩展。

在实际项目中，根据需求可以进一步定制化封装，并加入其他功能，比如日志分级、日志轮转、异常堆栈信息等。

根据项目需求和团队规范，合理地封装和使用日志功能，可以提高开发效率和代码质量。

python 如何对logging日志封装