Python日志记录配置详解

最推荐的方式是使用Python内置的logging模块，它通过Logger、Handler、Formatter组件实现灵活的日志分级、格式化和多目标输出，远优于print()。

Python代码进行日志记录最推荐且最灵活的方式是使用其内置的 logging 模块。它提供了一个强大且高度可配置的框架，能够有效地捕获、分类和输出日志消息到各种目标，从而在调试、监控和审计方面远优于简单的 print() 语句。

当谈到Python代码的日志记录，我个人觉得，跳过那些简单的 print() 语句直接拥抱 logging 模块，是每一个稍微复杂点项目都应该做的。它不仅仅是把信息打印出来，更是一个完整的体系，能让你精细地控制什么信息在什么时候、以什么格式、发送到哪里。

核心思想是：你创建 Logger 对象，然后往里面发消息。这些消息带着不同的级别（DEBUG, INFO, WARNING, ERROR, CRITICAL），表示它们的严重程度。Logger 不会直接处理这些消息，而是把它们交给 Handler。Handler 决定消息去哪里，比如控制台、文件、网络。Formatter 则负责把消息格式化成你想要的样子。

一个基本的配置流程大概是这样：

1. 获取 Logger 实例： 通常用 logging.getLogger(__name__)。__name__ 会让每个模块拥有自己的 Logger，便于追踪日志来源。
2. 设置 Logger 级别： logger.setLevel(logging.DEBUG) 决定了该 Logger 会处理哪个级别及以上的所有消息。
3. 创建 Handler： 比如 StreamHandler 用于控制台输出，FileHandler 用于文件。
4. 设置 Handler 级别： handler.setLevel(logging.INFO)。注意，Logger 和 Handler 都有级别，只有当消息的级别高于 Logger 和 Handler 的最低级别时，它才会被处理。
5. 创建 Formatter： 定义日志消息的格式，比如时间戳、级别、消息内容等。
6. 将 Formatter 添加到 Handler： handler.setFormatter(formatter)。
7. 将 Handler 添加到 Logger： logger.addHandler(handler)。

import logging

# 1. 获取 Logger 实例
# 推荐使用 __name__，这样日志中会显示模块名
logger = logging.getLogger(__name__) 
logger.setLevel(logging.DEBUG) # 设置Logger的最低处理级别

# 2. 创建一个 StreamHandler，用于输出到控制台
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.INFO) # 控制台只显示INFO及以上级别

# 3. 创建一个 FileHandler，用于输出到文件
# 'app.log' 是日志文件名，'a' 表示追加模式
file_handler = logging.FileHandler('app.log', mode='a', encoding='utf-8')
file_handler.setLevel(logging.DEBUG) # 文件记录所有DEBUG及以上级别

# 4. 创建 Formatter
# 定义日志消息的格式
formatter = logging.Formatter(
    '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S'
)

# 5. 将 Formatter 添加到 Handler
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

# 6. 将 Handler 添加到 Logger
logger.addHandler(console_handler)
logger.addHandler(file_handler)

# 7. 记录日志
logger.debug("这是一个调试信息，只会在文件中出现。")
logger.info("这是一个普通信息，控制台和文件都会出现。")
logger.warning("这是一个警告信息。")
logger.error("这是一个错误信息。")
logger.critical("这是一个严重错误，程序可能无法继续。")

# 尝试在另一个模块中记录
# 模拟在另一个文件里
def another_function():
    # 获取同一个logger实例，但它的名字是'another_module'
    # 如果没有配置'another_module'的logger，它会使用root logger或者父logger的配置
    # 更好的做法是在每个模块都获取并配置自己的logger，或者统一配置
    another_logger = logging.getLogger('another_module') 
    another_logger.info("这是来自另一个模块的信息。")

another_function()

这段代码展示了最基础的配置，但它已经能解决大部分场景了。你会发现，调试信息（DEBUG）只会写入文件，而不会污染控制台，这在开发和生产环境中非常有用。

为什么我们不应该只用 print() 来调试和记录日志？

这真是一个老生常谈的问题，但每次看到项目里充斥着 print() 语句，我都会忍不住想，这背后的成本到底有多大。 print() 最大的问题在于它太“原始”了。你没办法控制它的输出级别，不能说“生产环境只看错误，开发环境看所有”。它没有时间戳，没有模块来源，更不能方便地输出到文件或者其他系统。

想象一下，一个线上服务突然出了问题，你唯一的线索是散落在代码各处的 print() 输出。你得手动去改代码，添加更多的 print()，然后重新部署，这简直是噩梦。而且， print() 默认是输出到标准输出的，如果你的程序崩溃了，或者被守护进程托管了，这些信息可能就直接丢失了。

logging 模块则完全不同。它是一个成熟的框架，允许你：

• 分级管理： DEBUG, INFO, WARNING, ERROR, CRITICAL，一目了然，方便过滤。
• 灵活输出： 可以同时输出到控制台、文件、网络、邮件等。
• 格式化： 日志消息可以包含时间、模块名、文件名、行号、函数名、进程ID、线程ID等丰富上下文信息。
• 性能考量： 生产环境中可以轻易关闭低级别的日志，减少IO开销。
• 可维护性： 统一的日志接口，便于后期维护和故障排查。

所以，放弃 print() 吧，拥抱 logging 带来的便利和专业性，这会让你在项目维护上省下大量的时间和精力。这不仅仅是代码规范的问题，更是工程化思维的一种体现。

如何通过配置文件来管理 logging 模块的复杂配置？

直接在代码里写 logging 配置，对于小项目来说确实很直观，但当你的项目模块越来越多，日志需求越来越复杂（比如不同的模块需要不同的日志级别，或者需要输出到不同的文件），硬编码就会变得非常笨重且难以维护。这时候，通过配置文件来管理 logging 配置就显得尤为重要了。

logging 模块支持多种配置文件格式，最常用的是 dictConfig（字典配置）和 fileConfig（INI格式文件配置）。我个人更偏爱 dictConfig，因为它直接用Python字典来描述配置，与Python代码天然契合，也更具表现力。

使用 dictConfig 的基本步骤是：

1. 定义一个Python字典，包含 version, formatters, handlers, loggers, root 等键。
2. 调用 logging.config.dictConfig() 函数，传入这个字典。

下面是一个使用 dictConfig 的例子，它配置了一个名为 my_app 的 Logger，将 DEBUG 级别及以上的日志输出到控制台，同时将 INFO 级别及以上的日志写入一个滚动文件（每天生成一个新文件，保留7天）：

import logging.config
import logging
import os

# 定义日志配置字典
LOGGING_CONFIG = {
    'version': 1, # 配置版本，必须是1
    'disable_existing_loggers': False, #