python3 logging日志封装实例

1. 简介

在Python开发中，日志是一项非常重要的功能。它可以记录程序的运行状态、错误信息等，帮助开发者快速定位问题并进行调试。Python内置的logging模块提供了强大的日志功能，本文将介绍如何使用Python3的logging模块进行日志封装。

2. logging模块简介

Python的logging模块是一个标准库，可以用于创建灵活的日志记录系统。它提供了灵活的配置选项，可以将日志输出到控制台、文件、网络等不同的目标中。我们可以通过调整日志级别来控制日志的详细程度。

3. 日志封装

为了方便使用logging模块，我们可以进行日志的封装。封装后，我们只需要简单地调用封装好的函数即可完成日志记录。

3.1. 封装思路

我们可以将日志封装成一个类，并提供不同的方法来记录不同级别的日志。同时，我们可以在封装的过程中设置日志的格式、输出目标、日志级别等。

3.2. 封装实现

下面是一个简单的日志封装实例：

import logging
class MyLogger:
    def __init__(self, name='default', level=logging.DEBUG, log_file=None):
        self.logger = logging.getLogger(name)
        self.logger.setLevel(level)
        
        formatter = logging.Formatter('[%(levelname)s] [%(asctime)s] [%(name)s] - %(message)s')
        
        if log_file:
            file_handler = logging.FileHandler(log_file)
            file_handler.setFormatter(formatter)
            self.logger.addHandler(file_handler)
        
        console_handler = logging.StreamHandler()
        console_handler.setFormatter(formatter)
        self.logger.addHandler(console_handler)
    
    def debug(self, message):
        self.logger.debug(message)
    
    def info(self, message):
        self.logger.info(message)
    
    def warning(self, message):
        self.logger.warning(message)
    
    def error(self, message):
        self.logger.error(message)
    
    def critical(self, message):
        self.logger.critical(message)
# 使用示例
logger = MyLogger('example', level=logging.DEBUG, log_file='example.log')
logger.debug('This is a debug message')
logger.info('This is an info message')
logger.warning('This is a warning message')

在上述代码中，我们定义了一个名为MyLogger的日志封装类。它接受三个可选参数：name，用于指定日志的名称；level，用于指定日志的级别，默认为DEBUG；log_file，用于指定日志输出到文件的路径，默认为None表示输出到控制台。

在封装类的初始化方法中，我们使用logging.getLogger(name)来获取一个名为name的logger对象，并通过logger.setLevel(level)来设置日志级别。

我们定义了一个日志格式的formatter并分别为文件处理器和控制台处理器设置了格式。当log_file不为None时，我们创建一个文件处理器设置文件路径并添加到logger中。

封装类还定义了debug、info、warning、error和critical等方法，用来记录不同级别的日志。这些方法内部调用了logger对象的相应方法来输出日志。

在使用示例中，我们创建了一个名为example的logger对象，并将日志输出到文件example.log。接着分别使用不同级别的方法记录了不同的日志信息。

4. 总结

通过对Python3 logging模块的封装，我们可以以简单的方式记录不同级别的日志信息。日志封装可以使我们的代码更加易读、易用，并且可以灵活配置日志的输出目标和日志级别。

在实际开发中，我们可以根据项目的需要对日志进行定制化封装，以满足不同的需求。同时，我们还可以将封装类进行进一步的封装，以增加一些常用的功能，如日志的分割、异步输出等。

在进行日志的封装时，我们需要根据具体的项目需求来选择合适的日志级别和格式。同时，我们还需要注意控制日志的输出量，避免导致磁盘空间不足或日志信息混乱。