Python案例如何保存日志到文件？

wen python案例 2026-06-09 13

Python案例：如何高效保存日志到文件？从入门到实战详解

📚 目录导读

为什么需要将日志保存到文件？
Python日志模块基础：logging库详解
实战案例：将日志写入文件的5种方式
日志文件管理技巧：轮转、压缩与归档
常见问题FAQ
总结与最佳实践

为什么需要将日志保存到文件？

在Python开发中，print()语句虽然方便，但一旦程序部署到生产环境或长时间运行，将日志输出到文件就成为刚需,原因包括：

Python案例如何保存日志到文件？

持久化记录：控制台输出会随终端关闭而丢失,文件日志可长期保存。
故障排查：当程序异常崩溃（如try/except未捕获的异常）,文件日志能提供关键上下文。
性能分析：通过记录执行时间、错误频率等,定位性能瓶颈。
合规与审计：金融、医疗等行业要求保留操作日志。

核心问题：如何用Python高效、安全、可配置地实现日志文件存储？

Python日志模块基础：logging库详解

Python内置的logging模块是行业标准方案，比第三方库更轻量且无需额外安装,其核心组件包括：

1 日志级别（Level）

级别	数值	用途
DEBUG	10	调试信息，生产环境通常关闭
INFO	20	正常操作确认（如“用户登录成功”）
WARNING	30	意外但允许运行（如“磁盘空间不足90%”）
ERROR	40	严重错误，功能不可用
CRITICAL	50	致命错误，程序可能无法继续

2 三大核心对象

Logger：记录器的入口,负责产生日志消息。
Handler：决定日志去向（文件、控制台、网络等）。
Formatter：定义日志内容的格式（时间、级别、消息等）。

代码示例（基础配置）：

import logging
# 创建logger
logger = logging.getLogger('my_app')
logger.setLevel(logging.DEBUG)
# 创建文件handler
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.INFO)
# 定义格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler.setFormatter(formatter)
# 添加handler到logger
logger.addHandler(file_handler)
# 使用
logger.info('程序启动成功')
logger.error('数据库连接失败')

实战案例：将日志写入文件的5种方式

1 基础文件日志（单文件）

最简单的方案,适合小型脚本：

import logging
logging.basicConfig(
    filename='app.log',
    level=logging.INFO,
    format='%(asctime)s - %(levelname)s - %(message)s'
)
logging.info('This is an info message')

注意：basicConfig只能调用一次,后续配置会失效。

2 按时间轮转日志（RotatingFileHandler）

生产环境文件会越来越大,需要自动切割：

from logging.handlers import RotatingFileHandler
handler = RotatingFileHandler(
    'app.log', maxBytes=1024*1024,  # 1MB
    backupCount=5  # 保留5个备份文件
)
handler.setFormatter(logging.Formatter('%(asctime)s - %(message)s'))
logger = logging.getLogger('my_app')
logger.addHandler(handler)

效果：当app.log达到1MB，自动重命名为app.log.1,并创建新文件。

3 按日期轮转日志（TimedRotatingFileHandler）

更适合按天/小时切割：

import logging.handlers
handler = logging.handlers.TimedRotatingFileHandler(
    'daily.log', when='midnight', interval=1, backupCount=7
)
# when可选：'S'(秒), 'M'(分), 'H'(小时), 'D'(天), 'midnight'

场景：微服务、API服务器日志,按日期归档便于检索。

4 带编码处理的日志文件（避免中文乱码）

handler = logging.FileHandler('app.log', encoding='utf-8')
handler.setFormatter(logging.Formatter('%(asctime)s - %(message)s'))
logger.addHandler(handler)

关键点：指定encoding='utf-8',避免中文或其他Unicode字符乱码。

5 多Handler组合：文件+控制台双输出

import logging
logger = logging.getLogger('multi')
logger.setLevel(logging.DEBUG)
# 文件handler
file_h = logging.FileHandler('app.log', encoding='utf-8')
file_h.setLevel(logging.WARNING)
# 控制台handler
console_h = logging.StreamHandler()
console_h.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
file_h.setFormatter(formatter)
console_h.setFormatter(formatter)
logger.addHandler(file_h)
logger.addHandler(console_h)
# 测试
logger.debug('debug info')     # 仅控制台输出
logger.warning('warning info') # 文件+控制台

日志文件管理技巧：轮转、压缩与归档

1 日志文件轮转（Rotation）

按大小轮转：使用RotatingFileHandler，设置maxBytes和backupCount。
按时间轮转：TimedRotatingFileHandler，支持midnight、W0（每周一）等。

2 日志压缩与清理

生产环境日志文件会占用大量磁盘,建议配合日志清理策略：

import logging.handlers
import gzip
import os
class CompressedRotatingHandler(logging.handlers.RotatingFileHandler):
    def doRollover(self):
        super().doRollover()
        # 压缩旧日志文件
        if os.path.exists(f"{self.baseFilename}.1"):
            with open(f"{self.baseFilename}.1", 'rb') as f_in:
                with gzip.open(f"{self.baseFilename}.1.gz", 'wb') as f_out:
                    f_out.writelines(f_in)
            os.remove(f"{self.baseFilename}.1")

3 避免日志重复记录

当同一个Logger被多次添加Handler时，日志会重复输出,解决方案：

# 检查是否已有handler
if not logger.handlers:
    logger.addHandler(file_handler)

或在创建Logger时使用getLogger并确保单例模式。

常见问题FAQ

Q1：为什么我的日志文件为空？
A：检查三点：① 是否设置了level（默认为WARNING）；② Handler级别是否低于Logger级别；③ 文件路径是否有写入权限。

Q2：如何捕获异常并记录完整栈跟踪？
A：使用logger.exception()：

try:
    1/0
except ZeroDivisionError:
    logger.exception("除零错误发生")  # 自动记录异常信息

Q3：多线程/多进程下日志安全吗？
A：RotatingFileHandler在多线程下安全；多进程建议使用SocketHandler或QueueHandler避免文件锁冲突。

Q4：如何动态修改日志级别？
A：运行时修改：

logger.setLevel(logging.DEBUG)  # 全开
# 或仅修改特定Handler
file_handler.setLevel(logging.ERROR)

Q5：日志文件内容出现乱码？
A：在FileHandler中添加encoding='utf-8',并确保日志格式字符串中无特殊字符。

总结与最佳实践

选择正确的日志级别：生产环境建议设为INFO或WARNING；开发调试用DEBUG。
务必使用文件轮转：防止单个日志文件无限增长（推荐RotatingFileHandler+备份数3-7）。
配置日志格式：包含时间戳、级别、模块名,便于自动化分析。
集中管理日志配置：通过logging.config.dictConfig()加载YAML/JSON配置文件。
避免在生产中使用print()：改用logging,并支持远程日志收集。

最终建议：对于重要生产环境，建议结合logging + 日志分析工具（如ELK Stack、Splunk），对于小型应用,以上案例已完全满足需求。

提示：完整的日志配置可参考Python官方文档：docs.python.org/3/library/logging.html （请将域名替换为实际可用链接）。