疾如风，且行且改进：decorator 装饰器在项目中的实际应用（一）

见解分享

2023-12-20 20:23:50

前言

在最近的一个后台项目中，我深入探索了 decorator 的世界，并在代码编写实践中采用了这种强大的技术。decorator 的引入带来了显著的代码优化和可扩展性提升，促使我分享其在实际项目中的应用心得。

什么是 decorator？

decorator 本质上是一种元编程技术，允许我们在运行时修改函数或类的行为，而无需直接修改它们的源代码。decorator 通过在函数或类定义之前执行附加代码来实现这一目标，从而为其添加新的功能或修改其行为。

decorator 的类型

Python 中有两种主要的 decorator 类型：

函数 decorator： 应用于函数，可以在函数执行前或后执行自定义代码。
类 decorator： 应用于类，可以在类创建前或后执行自定义代码。

decorator 的优势

decorator 为代码开发提供了诸多优势，包括：

代码优化： 通过将重复或通用代码块移入 decorator，可以简化代码，减少冗余。
代码可扩展性： decorator 允许在不修改原始代码的情况下添加新功能或修改现有行为，提高代码的可扩展性。
代码重用性： decorator 可以将通用代码片段封装成可重用组件，在不同的地方使用。

decorator 的实际应用

以下是一些 decorator 在实际项目中的具体应用示例：

日志记录

使用 decorator 可以轻松地为函数添加日志记录功能，而无需手动在每个函数中编写日志代码：

def logging_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        # 执行日志记录代码
        return func(*args, **kwargs)
    return wrapper

@logging_decorator
def my_function():
    # 函数逻辑

缓存

decorator 可用于实现函数调用的缓存，从而提高性能：

def cache_decorator(func):
    cache = {}

    @wraps(func)
    def wrapper(*args, **kwargs):
        key = str(args) + str(kwargs)
        if key not in cache:
            cache[key] = func(*args, **kwargs)
        return cache[key]
    return wrapper

@cache_decorator
def my_function():
    # 函数逻辑

计时

decorator 可用于测量函数调用的执行时间：

def timing_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print(f"函数 {func.__name__} 执行时间：{(end - start):.6f} 秒")
        return result
    return wrapper

@timing_decorator
def my_function():
    # 函数逻辑