Python 中如何使用日志装饰器

在 Python 开发中，日志记录是一个非常重要的功能。它不仅可以帮助开发者调试代码，还可以在生产环境中监控应用程序的运行状态。为了简化日志记录的过程，我们可以使用装饰器来自动为函数添加日志功能。本文将介绍如何在 Python 中使用日志装饰器。

1. 什么是装饰器？

装饰器是 Python 中的一种高级函数，它允许我们在不修改原函数代码的情况下，为函数添加额外的功能。装饰器本质上是一个函数，它接受一个函数作为参数，并返回一个新的函数。

def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("Before function call")
        result = func(*args, **kwargs)
        print("After function call")
        return result
    return wrapper

@my_decorator
def say_hello():
    print("Hello!")

say_hello()

在上面的例子中，my_decorator 是一个装饰器，它在调用 say_hello 函数前后分别打印了一条消息。

2. 使用装饰器记录日志

为了记录函数的调用信息，我们可以创建一个日志装饰器。这个装饰器会在函数调用前后记录日志信息。

首先，我们需要导入 Python 的 logging 模块，并配置日志记录器。

import logging

# 配置日志记录器
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

接下来，我们定义一个日志装饰器 log_decorator，它会在函数调用前后记录日志。

def log_decorator(func):
    def wrapper(*args, **kwargs):
        logger.info(f"Calling function {func.__name__} with args: {args}, kwargs: {kwargs}")
        try:
            result = func(*args, **kwargs)
            logger.info(f"Function {func.__name__} returned: {result}")
            return result
        except Exception as e:
            logger.error(f"Function {func.__name__} raised an exception: {e}")
            raise
    return wrapper

在这个装饰器中，我们使用 logger.info 记录函数的调用信息和返回值，使用 logger.error 记录函数抛出的异常。

3. 使用日志装饰器

现在，我们可以使用 log_decorator 来装饰任何函数，以自动记录日志。

@log_decorator
def add(a, b):
    return a + b

@log_decorator
def divide(a, b):
    return a / b

# 调用函数
add(2, 3)
divide(10, 2)
divide(10, 0)  # 这会引发异常

运行上述代码后，日志输出将类似于以下内容：

2023-10-01 12:00:00,000 - __main__ - INFO - Calling function add with args: (2, 3), kwargs: {}
2023-10-01 12:00:00,001 - __main__ - INFO - Function add returned: 5
2023-10-01 12:00:00,002 - __main__ - INFO - Calling function divide with args: (10, 2), kwargs: {}
2023-10-01 12:00:00,003 - __main__ - INFO - Function divide returned: 5.0
2023-10-01 12:00:00,004 - __main__ - INFO - Calling function divide with args: (10, 0), kwargs: {}
2023-10-01 12:00:00,005 - __main__ - ERROR - Function divide raised an exception: division by zero

4. 进一步优化

为了使日志装饰器更加通用，我们可以将其设计为接受日志级别作为参数。这样，我们可以根据需要调整日志的详细程度。

def log_decorator(level=logging.INFO):
    def decorator(func):
        def wrapper(*args, **kwargs):
            logger.log(level, f"Calling function {func.__name__} with args: {args}, kwargs: {kwargs}")
            try:
                result = func(*args, **kwargs)
                logger.log(level, f"Function {func.__name__} returned: {result}")
                return result
            except Exception as e:
                logger.error(f"Function {func.__name__} raised an exception: {e}")
                raise
        return wrapper
    return decorator

@log_decorator(level=logging.DEBUG)
def multiply(a, b):
    return a * b

multiply(3, 4)

在这个版本中，log_decorator 接受一个 level 参数，允许我们指定日志的级别。例如，我们可以将日志级别设置为 logging.DEBUG，以便在调试时记录更详细的信息。

5. 总结

通过使用日志装饰器，我们可以轻松地为 Python 函数添加日志记录功能，而无需修改函数本身的代码。这不仅提高了代码的可维护性，还使得调试和监控变得更加方便。在实际开发中，日志装饰器是一个非常实用的工具，尤其是在处理复杂的应用程序时。

希望本文能帮助你理解如何在 Python 中使用日志装饰器，并在你的项目中有效地应用它。