Python（logging.getLogger().addHandler()）

• 1. 函数定义
• 2. 示例代码
• 3. 常见用途
• 4. 重要特性
• 5. 使用 removeHandler() 清理处理器
• 6. 常用处理器类型

logging.getLogger().addHandler() 是 Python logging 模块中的一个方法，用于将日志处理器（handler）添加到日志记录器（logger）上。addHandler() 使得一个日志记录器可以输出日志到多个目标位置，比如控制台、文件、远程服务器等。

通过添加不同的 Handler 实例，日志记录器可以在不同的场景中灵活地管理日志输出。例如，控制台可以输出简洁的日志信息，而文件记录详细的日志信息。

1. 函数定义

addHandler() 的主要作用是将一个处理器附加到日志记录器上，使日志记录器能够将日志消息发送到该处理器指定的目标位置（如控制台或文件）。

logging.getLogger().addHandler(handler)

参数：

• handler：Handler 对象，是 logging 模块中的处理器实例，用于定义日志的输出位置和格式。常见的 Handler 类包括：
  • StreamHandler：将日志输出到控制台或任意文件对象。
  • FileHandler：将日志输出到文件。
  • RotatingFileHandler：将日志输出到大小限制的文件，当达到指定大小时自动轮转。
  • TimedRotatingFileHandler：将日志输出到按时间间隔轮转的文件。
  • SocketHandler：将日志发送到网络地址。
  • HTTPHandler：将日志作为 HTTP 请求发送。

返回值：

addHandler() 是一个无返回值的函数。它将处理器附加到日志记录器对象，但不会返回任何内容。

2. 示例代码

以下示例展示了如何使用 logging.getLogger().addHandler() 添加多个处理器，将日志分别输出到控制台和文件：

import logging

# 创建日志记录器
logger = logging.getLogger("example_logger")
logger.setLevel(logging.DEBUG)  # 设置最低日志级别

# 创建控制台处理器
console_handler = logging.StreamHandler()
console_formatter = logging.Formatter("%(levelname)s - %(message)s")
console_handler.setFormatter(console_formatter)

# 创建文件处理器
file_handler = logging.FileHandler("app.log", encoding="utf-8")
file_formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
file_handler.setFormatter(file_formatter)

# 将控制台和文件处理器添加到日志记录器
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 记录日志，日志会同时输出到控制台和文件
logger.debug("This is a debug message.")
logger.info("This is an info message.")
logger.warning("This is a warning message.")

运行后，会产生以下结果：

• 控制台输出：

  DEBUG - This is a debug message.
  INFO - This is an info message.
  WARNING - This is a warning message.
  

• app.log 文件内容：

  2024-11-04 12:00:01 - example_logger - DEBUG - This is a debug message.
  2024-11-04 12:00:02 - example_logger - INFO - This is an info message.
  2024-11-04 12:00:03 - example_logger - WARNING - This is a warning message.
  

3. 常见用途

• 多目标日志输出：可以将日志输出到多个目标位置，如控制台、文件、远程服务器等。
• 不同格式的日志输出：可以为不同的处理器设置不同的格式化器，实现不同的日志格式。
• 多级别日志输出：可以为不同的处理器设置不同的日志级别。例如，控制台显示 INFO 级别及以上的日志，而文件记录所有级别的日志。

4. 重要特性

• 灵活性：允许添加多个处理器，为不同的场景配置不同的日志输出。
• 日志格式化：每个处理器可以应用不同的 Formatter，实现个性化的日志格式。
• 日志级别控制：可以为每个处理器单独设置日志级别，控制日志输出的详细程度。

5. 使用 removeHandler() 清理处理器

如果需要清理处理器，可以使用 removeHandler() 方法：

# 移除控制台处理器
logger.removeHandler(console_handler)

6. 常用处理器类型

• StreamHandler：用于控制台日志输出。
• FileHandler：用于文件日志输出。
• RotatingFileHandler 和 TimedRotatingFileHandler：用于日志轮转管理。

通过 logging.getLogger().addHandler()，用户可以灵活定义日志的输出方式，以适应不同的日志管理需求。