Python（logging.FileHandler()）
logging.FileHandler() 是 Python logging 模块中的一个类，专门用于将日志记录保存到文件中。它是日志处理器的一种类型，可以将格式化后的日志信息写入到指定文件，适用于需要持久化日志记录的场景，如应用程序的长期运行日志或调试信息记录。
1. 函数定义
logging.FileHandler() 的主要作用是将日志记录输出到一个文件中。它提供了一种简单的方式来将日志持久化到磁盘，以便后续分析、审计和调试。FileHandler 继承自 logging.Handler 基类，允许设置日志格式、日志级别和文件打开模式等。
logging.FileHandler(filename, mode='a', encoding=None, delay=False)
参数：
-
filename：日志文件的路径和文件名。可以是绝对路径或相对路径。此文件会存储生成的日志信息。 -
mode（可选）：文件的打开模式，默认为'a'（追加模式）。'a'：追加模式（默认）。新的日志记录会追加到文件末尾，不覆盖现有内容。'w'：写入模式。每次启动程序时会重写日志文件，清空之前的内容。
-
encoding（可选）：文件的编码方式。默认为None，使用系统默认编码。可以设置为'utf-8'等其他编码以支持不同的语言或字符集。 -
delay（可选）：指定是否延迟文件的创建。默认为False，即FileHandler实例化时立即创建和打开文件。如果设置为True，则文件会在首次写入日志时才创建和打开。
返回值：
logging.FileHandler() 返回一个 FileHandler 对象，用于将日志记录输出到指定文件。
2. 示例代码
以下示例展示了如何使用 logging.FileHandler 将日志信息保存到文件 app.log 中：
import logging
# 创建日志记录器
logger = logging.getLogger("file_logger")
logger.setLevel(logging.DEBUG) # 设置最低日志级别为 DEBUG
# 创建文件处理器并指定日志文件
file_handler = logging.FileHandler("app.log", mode="a", encoding="utf-8")
# 定义日志格式
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
# 为文件处理器指定格式
file_handler.setFormatter(formatter)
# 将文件处理器添加到日志记录器
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.")
运行后，日志会被追加到文件 app.log 中，内容格式如下：
2024-11-04 12:00:01 - file_logger - DEBUG - This is a debug message.
2024-11-04 12:00:02 - file_logger - INFO - This is an info message.
2024-11-04 12:00:03 - file_logger - WARNING - This is a warning message.
3. 常见用法
- 将日志持久化到文件：用于记录重要的应用程序事件、错误或调试信息，便于后续分析。
- 分离日志输出：结合
StreamHandler输出到控制台，FileHandler输出到文件，分别管理不同的日志流。 - 多文件日志：使用不同的
FileHandler实例输出不同类型的日志信息到不同的文件。
4. 重要特性
- 日志轮转：可以与
logging.handlers中的RotatingFileHandler或TimedRotatingFileHandler配合使用，实现日志文件的自动轮转和归档。 - 延迟创建文件：
delay=True可以延迟文件的创建，减少不必要的文件打开，适合可能不会触发日志写入的短时间运行程序。 - 自定义日志格式：结合
Formatter类，可为文件日志设置详细的格式，显示时间、级别、来源模块等信息。
5. 使用 RotatingFileHandler 和 TimedRotatingFileHandler
当日志文件可能会变得非常大时，可以使用 RotatingFileHandler（基于文件大小）或 TimedRotatingFileHandler（基于时间）来自动分割日志文件。
from logging.handlers import RotatingFileHandler
# 设置日志文件最大 1MB，最多保留 3 个日志文件
rotating_handler = RotatingFileHandler("app.log", maxBytes=1024 * 1024, backupCount=3)
rotating_handler.setFormatter(formatter)
logger.addHandler(rotating_handler)
6. 其他相关函数和类
logging.StreamHandler()：将日志输出到控制台。logging.handlers.RotatingFileHandler()：在文件达到指定大小时自动轮转日志文件。logging.handlers.TimedRotatingFileHandler()：在指定的时间间隔后自动轮转日志文件。
通过 logging.FileHandler() 可以将日志信息持久化保存，为调试、分析和监控应用程序提供可靠的日志记录方式。
