<think>我们将详细讲解Python的logging模块，包括其用法、日志的用处以及何时使用。 采用由浅入深的方式，并使用费曼学习法（即用简单的语言和例子来解释概念）来阐述。 1. 日志的用处： - 记录程序运行状态，便于监控和调试。 - 帮助开发者了解程序运行流程，特别是在生产环境中，当无法直接调试时。 - 记录错误信息，便于排查问题。 - 记录用户操作或系统事件，用于审计。 2. 什么时候该用日志？ - 调试信息：在开发阶段，记录详细信息帮助调试。 - 程序运行状态：记录程序正常运行的关键步骤。 - 警告信息：记录可能的问题，但程序还能继续运行。 - 错误信息：记录错误，但程序可能还能运行（如某个操作失败）。 - 严重错误：记录导致程序无法继续运行的错误。 3. logging模块的层次结构： - 日志级别（从低到高）： DEBUG: 详细信息，通常用于调试。 INFO: 确认程序按预期运行。 WARNING: 表示一些意外情况，或者即将发生的问题（如磁盘空间不足），但程序还在运行。 ERROR: 由于更严重的问题，程序某些功能已经不能正常执行。 CRITICAL: 严重的错误，程序可能无法继续运行。 - 日志记录器（Logger）：用于记录日志的接口。 - 处理器（Handler）：将日志记录发送到不同的地方（如控制台、文件等）。 - 过滤器（Filter）：提供更细粒度的日志过滤。 - 格式器（Formatter）：指定日志记录的输出格式。 4. 基本使用步骤： - 创建或获取日志记录器（Logger）。 - 设置日志记录器的级别。 - 创建处理器（Handler）并设置级别。 - 创建格式器（Formatter）并添加到处理器。 - 将处理器添加到日志记录器。 5. 一个简单的例子（控制台日志）： </think> ### Python `logging` 模块详解 #### **日志的作用与使用场景（费曼法解释）** 1. **是什么** `logging` 是 Python 内置的日志记录工具，用于**记录程序运行时的状态、错误和事件**。就像飞机的“黑匣子”，它不会改变程序行为，但会忠实记录发生了什么。 2. **为什么需要日志** - **调试**：当程序出错时，通过日志追溯问题（比 `print` 更结构化）。 - **监控**：在生产环境中实时监控程序健康状态（如错误频率）。 - **审计**：记录关键操作（如用户登录、支付）。 - **数据分析**：统计请求量、性能瓶颈等。 3. **何时使用** - `DEBUG`：开发阶段追踪细节（如变量值）。 - `INFO`：记录常规事件（如服务启动）。 - `WARNING`：潜在问题（如低磁盘空间）。 - `ERROR`：处理失败但程序仍运行（如文件未找到）。 - `CRITICAL`：致命错误（如数据库崩溃）。 --- #### **由浅入深：4 个核心概念** ##### 1. **日志级别（Level）** 重要性排序：`DEBUG < INFO < WARNING < ERROR < CRITICAL` 设置级别后，只会记录该级别及以上的日志。 ##### 2. **日志记录器（Logger）** 负责创建日志记录的对象。通常按模块命名： ```python logger = logging.getLogger("my_module") ``` ##### 3. **处理器（Handler）** 决定日志输出到哪里： - 控制台：`logging.StreamHandler()` - 文件：`logging.FileHandler("app.log")` - 邮件/HTTP 等（需自定义）。 ##### 4. **格式器（Formatter）** 定义日志的排版样式： ```python formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') ``` --- #### **代码示例与详解** ##### 示例 1：基础控制台日志 ```python import logging # 配置基础日志（默认输出到控制台） logging.basicConfig( level=logging.DEBUG, # 设置记录的最低级别 format="%(asctime)s [%(levelname)s] %(message)s", datefmt="%Y-%m-%d %H:%M:%S" ) # 使用日志 logging.debug("调试信息") # 开发时查看 logging.info("程序已启动") # 常规信息 logging.warning("磁盘空间不足") # 潜在问题 logging.error("文件未找到") # 错误但程序可继续 logging.critical("数据库崩溃") # 致命错误 ``` **输出示例**： ``` 2023-10-05 14:30:00 [INFO] 程序已启动 2023-10-05 14:30:01 [WARNING] 磁盘空间不足 ``` ##### 示例 2：进阶用法（Logger + Handler + Formatter） ```python import logging # 1. 创建记录器 logger = logging.getLogger("my_app") logger.setLevel(logging.DEBUG) # 记录器级别 # 2. 创建控制台处理器 console_handler = logging.StreamHandler() console_handler.setLevel(logging.INFO) # 处理器级别（只输出INFO及以上） # 3. 创建文件处理器 file_handler = logging.FileHandler("app.log") file_handler.setLevel(logging.DEBUG) # 文件记录所有DEBUG+日志 # 4. 创建格式器 formatter = logging.Formatter( "%(asctime)s - %(name)s - %(levelname)s - %(message)s", datefmt="%Y-%m-%d %H:%M:%S" ) console_handler.setFormatter(formatter) file_handler.setFormatter(formatter) # 5. 将处理器添加到记录器 logger.addHandler(console_handler) logger.addHandler(file_handler) # 使用记录器 logger.debug("内部变量: x=42") # 仅写入文件 logger.info("用户登录成功") # 同时输出控制台和文件 ``` **关键点**： - 记录器级别 (`setLevel`) 是总开关。 - 处理器级别决定不同输出的过滤条件。 - 日志传递：先经过记录器级别过滤，再经过处理器级别过滤。 --- #### **日志的进阶技巧** 1. **按时间/大小分割日志文件** 使用 `RotatingFileHandler`（按大小分割）或 `TimedRotatingFileHandler`（按时间分割）： ```python from logging.handlers import RotatingFileHandler handler = RotatingFileHandler("app.log", maxBytes=5*1024*1024, backupCount=3) # 5MB/文件，保留3个备份 ``` 2. **捕获异常栈轨迹** 使用 `logger.exception()` 自动记录错误堆栈： ```python try: 1 / 0 except Exception: logger.exception("发生除零错误") # 自动添加堆栈信息 ``` 3. **禁用第三方库日志** 降低依赖库的日志级别： ```python logging.getLogger("requests").setLevel(logging.WARNING) # 只记录WARNING及以上 ``` 4. **日志过滤（Filter）** 自定义过滤规则（例如只记录含特定关键词的日志）： ```python class KeywordFilter(logging.Filter): def filter(self, record): return "important" in record.getMessage() logger.addFilter(KeywordFilter()) ``` --- #### **何时选择 `logging` 而非 `print`？** | 场景 | `print` | `logging` | |-------------------|---------|-----------| | 临时调试 | ✅ | ❌ | | 生产环境监控 | ❌ | ✅ | | 长期日志存储/分析 | ❌ | ✅ | | 多级别日志分类 | ❌ | ✅ | ---