Python装饰器日志记录技巧分享

**Python装饰器记录函数日志技巧：轻松掌握高效日志记录** 想知道Python函数何时被调用、传递了哪些参数以及返回值吗？本文介绍如何利用Python装饰器优雅地记录函数日志，无需修改原函数代码。通过`@log_function_call`装饰器，自动记录函数调用时间、参数、返回值及异常。文章详细讲解了装饰器的实现原理，包括使用`*args`、`**kwargs`捕获参数，`try...except`捕获执行结果与异常，以及利用`functools.wraps`保留函数元信息。掌握此技巧，可实现高效、可复用的日志记录，提升代码可维护性和可读性，是Python开发中不可或缺的实用技能。

使用装饰器可自动记录函数调用时间、参数、返回值及异常，通过@log_function_call装饰目标函数，在不修改原函数代码的前提下，利用*args、**kwargs捕获参数，try...except捕获执行结果与异常，并结合functools.wraps保留函数元信息，实现高效、可复用的日志记录。

想在Python函数被调用时自动留下痕迹，比如记录下来它什么时候被调了，带了哪些参数，甚至跑完后返回了什么，装饰器无疑是个优雅又高效的选择。它就像给函数套了个“外壳”，在不改动函数本身代码的前提下，轻松实现这些额外的日志记录功能。

解决方案： 说白了，用装饰器记录日志，就是写一个高阶函数，它接收一个函数作为参数，然后返回一个新的函数。这个新函数在执行原始函数的前后，加入我们想要的日志逻辑。

一个基础的日志装饰器大概是这样：

import functools
import logging
import time

# 配置一个基本的日志器，方便演示
# 实际项目中，日志配置会更复杂，通常会写入文件，并设置滚动策略等
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

def log_function_call(func):
    @functools.wraps(func) # 这一行很重要，它保留了原始函数的元信息，比如函数名和文档字符串
    def wrapper(*args, **kwargs):
        func_name = func.__name__
        # 记录函数调用前的日志，包含参数
        arg_str = ', '.join([repr(arg) for arg in args])
        kwarg_str = ', '.join([f"{k}={repr(v)}" for k, v in kwargs.items()])
        full_args_str = f"({arg_str}{', ' if arg_str and kwarg_str else ''}{kwarg_str})"
        logger.info(f"进入函数: {func_name}{full_args_str}")

        start_time = time.time()
        try:
            result = func(*args, **kwargs) # 执行原始函数
            # 记录函数成功执行后的日志，包括返回值和执行时间
            logger.info(f"函数 {func_name} 成功返回, 返回值: {repr(result)}, 耗时: {(time.time() - start_time)*1000:.2f}ms")
            return result
        except Exception as e:
            # 捕获异常，记录错误日志，并重新抛出
            logger.error(f"函数 {func_name} 发生异常: {type(e).__name__}: {e}, 耗时: {(time.time() - start_time)*1000:.2f}ms")
            raise # 重新抛出异常，不改变原始函数的行为
    return wrapper

# 怎么用呢？很简单，在函数定义前加上@log_function_call
@log_function_call
def calculate_sum(a, b):
    """计算两个数的和"""
    time.sleep(0.1) # 模拟一些耗时操作
    return a + b

@log_function_call
def greet_user(name, greeting="Hello"):
    """向用户问好"""
    return f"{greeting}, {name}!"

@log_function_call
def divide(a, b):
    """尝试除法操作"""
    time.sleep(0.05)
    return a / b

# 调用试试看
calculate_sum(10, 20)
greet_user("Alice", greeting="Hi")
try:
    divide(10, 0) # 尝试触发异常
except ZeroDivisionError:
    logger.info("捕获到ZeroDivisionError，这是预期行为。")

这个例子里，log_function_call 就是我们的装饰器。它内部定义了一个 wrapper 函数，这个 wrapper 就是最终会被调用的那个。在 wrapper 里，我们先记录了调用前的状态，然后调用原始函数 func，接着记录调用后的结果。*args 和 **kwargs 确保了装饰器能处理任何数量和类型的参数。而 functools.wraps 则是为了让被装饰的函数看起来还像它自己，比如它的名字、文档字符串都不会变，这在调试和反射时特别有用。我还加了个 try...except 块，这样即使函数执行出错，日志也能捕获到异常信息，这在实际应用中非常重要。

为什么推荐使用装饰器来记录函数调用日志？

我个人觉得，在Python里，日志记录这种“横切关注点”（cross-cutting concerns）的问题，装饰器简直是量身定制的解决方案。你设想一下，如果每个函数都需要手动写上日志记录的代码，那会是多么灾难性的重复劳动！

它实现了代码的解耦和复用。日志记录逻辑和业务逻辑彻底分离开来，业务函数只专注于它自己的核心功能，而日志记录则由装饰器统一处理。这样一来，如果未来日志记录的方式需要调整（比如从打印到控制台改成写入文件，或者增加更多上下文信息），我们只需要修改装饰器这一个地方，所有被装饰的函数都会自动应用这些改变，而不需要触碰成百上千行的业务代码。这大大降低了维护成本和引入bug的风险。

此外，它让代码更干净、更可读。函数体内部不再充斥着与核心业务无关的日志语句，一眼望去，就是纯粹的业务逻辑。这对于团队协作和新成员理解项目代码都非常有益。当你看到一个函数上面挂着 @log_function_call，你立刻就知道这个函数的调用会被记录，而不需要深入其内部去寻找那些散落的 print 或 logger.info。这是一种非常优雅的“声明式”编程风格。

最后，也是我特别欣赏的一点，它提供了一种非侵入式的增强。你不需要修改原始函数的任何一行代码，就能赋予它新的能力。这对于一些你可能没有权限修改的第三方库函数，或者不想修改但又想监控的函数来说，简直是神来之笔。这种灵活性是直接在函数内部写日志无法比拟的。

如何为日志装饰器添加更多上下文信息，例如函数参数和返回值？

给日志添加更多上下文信息是日志记录的核心价值所在，毕竟，光知道函数被调用了，但不知道它带着什么数据跑的，那信息量可就大打折扣了

终于介绍完啦！小伙伴们，这篇关于《Python装饰器日志记录技巧分享》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！