轻松管理日志：使用 AppLogger 自定义日志记录类

轻松管理日志：使用 AppLogger 自定义日志记录类

在软件开发过程中，日志记录是不可或缺的一部分。它不仅帮助我们追踪程序的运行状态，还能在出现问题时提供有用的调试信息。然而，标准的 Python 日志库 logging 使用起来可能稍显复杂，尤其是在配置和管理日志记录器时。为了解决这个问题，我们可以创建一个自定义的日志记录类——AppLogger。本文将介绍如何使用 AppLogger 来简化日志记录的工作。

1. 介绍 AppLogger

AppLogger 是一个自定义的日志记录类，旨在简化 Python 项目的日志记录工作。它不仅将日志信息输出到指定的日志文件，还会在控制台中显示日志信息。AppLogger 支持多个日志级别，并允许用户根据需要调整日志记录的详细程度。

1.1 类的功能

• 日志级别控制: 允许设置不同的日志级别，包括 DEBUG、INFO、WARNING、ERROR 和CRITICAL。
• 双重输出: 日志信息同时记录到文件和控制台，确保日志的持久性和实时性。
• 格式化: 提供自定义的日志格式，包含时间戳、日志级别、日志消息等信息。

2. 如何使用 AppLogger

2.1 安装和导入

首先，将 AppLogger 类保存到一个 Python 文件中，例如 app_logger.py。在你的项目中导入该文件：

from app_logger import AppLogger

2.2 创建 AppLogger 实例

在创建 AppLogger 实例时，你需要提供日志记录器的名称和日志级别。日志级别通过数字表示，分别对应不同的日志类型：

• 1: DEBUG
• 2: INFO
• 3: WARNING
• 4: ERROR
• 5: CRITICAL

例如，创建一个记录所有级别日志的实例（DEBUG）：

logger = AppLogger(name='MyAppLogger', level=1)

2.3 记录日志信息

使用 AppLogger 实例可以记录不同级别的日志信息。可用的方法包括 debug(), info(), warning(), error(), 和 critical()：

logger.debug('这是调试信息')    # 记录调试级别的信息
logger.info('这是普通信息')     # 记录普通信息级的信息
logger.warning('这是警告信息')  # 记录警告级别的信息
logger.error('这是错误信息')    # 记录错误级别的信息
logger.critical('这是严重错误信息')  # 记录严重错误级别的信息

2.4 设置日志级别

你可以在运行时更改日志级别，以便记录不同详细程度的日志信息。使用 set_log_level() 方法来调整日志级别：

logger.set_log_level(3)  # 设置日志级别为 WARNING

2.5 完整示例

以下是一个完整的示例，展示了如何创建和使用 AppLogger 实例：

from app_logger import AppLogger

# 创建 AppLogger 实例，设置日志级别为 DEBUG
logger = AppLogger(name='MyAppLogger', level=1)

# 记录不同级别的日志信息
logger.debug('这是调试信息')
logger.info('这是普通信息')
logger.warning('这是警告信息')
logger.error('这是错误信息')
logger.critical('这是严重错误信息')

# 更改日志级别
logger.set_log_level(3)  # 设置为 WARNING 级别

# 记录新的日志信息
logger.debug('这条调试信息不会被记录')  # 因为当前级别为 WARNING
logger.warning('这条警告信息会被记录')

3. 注意事项

• 日志文件位置: AppLogger 会在当前工作目录下创建一个以名称命名的日志文件。例如，如果名称为 ‘MyAppLogger’，则日志文件名为 ‘MyAppLogger.log’。
• 日志级别: 确保选择适合你项目需求的日志级别，以便高效地记录和筛选日志信息。

4.资源

https://download.csdn.net/download/qq_52429717/89665345?spm=1001.2014.3001.5503