彻底掌握Python装饰器：从入门到精通教程
Python装饰器是Python语言中一种非常强大且优雅的特性，它允许你在不修改函数源代码的情况下，为函数添加额外的功能。理解并掌握装饰器对于编写可维护、可扩展且高效的Python代码至关重要。本教程将带你从装饰器的基础概念开始，逐步深入到高级应用，让你彻底掌握Python装饰器。
1. 什么是装饰器？
简单来说，装饰器就是一个函数，它接受一个函数作为输入，并返回一个新的函数作为输出。这个新的函数通常会在原始函数的基础上添加一些额外的功能，例如日志记录、性能分析、权限验证等等。
更专业的定义： 装饰器是一种语法糖，它本质上是一个高阶函数，用于封装和修改其他函数或类。它提供了一种清晰、简洁的方式来为函数添加额外的职责，而无需修改函数的原始代码。
为什么使用装饰器？
使用装饰器可以带来以下好处：
- 代码重用： 可以将通用的功能（如日志记录、权限验证）封装成装饰器，然后在多个函数中重复使用，避免代码冗余。
- 代码可读性： 装饰器可以将额外的功能与函数的核心逻辑分离，使代码更加清晰易懂。
- 代码可维护性： 修改装饰器只会影响应用该装饰器的函数，而不会影响函数本身，提高了代码的可维护性。
- 符合开闭原则： 在不修改原有函数代码的基础上，可以扩展函数的功能，符合面向对象设计的开闭原则。
2. 装饰器的基本语法：
Python中使用 @ 符号来应用装饰器。
python
@decorator_function
def my_function():
# 函数主体
pass
等价于：
“`python
def my_function():
# 函数主体
pass
my_function = decorator_function(my_function)
“`
从本质上讲，@decorator_function 只是一个语法糖，它简化了 my_function = decorator_function(my_function) 的写法。
3. 编写一个简单的装饰器：
让我们从一个最简单的装饰器开始，该装饰器只是在函数执行前后打印一些信息。
“`python
def my_decorator(func):
def wrapper():
print(“Before calling the function.”)
func()
print(“After calling the function.”)
return wrapper
@my_decorator
def say_hello():
print(“Hello!”)
say_hello()
“`
输出:
Before calling the function.
Hello!
After calling the function.
代码解释:
my_decorator(func): 这是一个装饰器函数，它接受一个函数func作为参数。wrapper(): 这是内部函数，也被称为“包装器”函数。它负责在调用func之前和之后执行一些额外的操作。func(): 调用原始函数。return wrapper: 返回包装器函数。
当我们使用 @my_decorator 应用到 say_hello() 函数时，实际上是将 say_hello 函数传递给 my_decorator 函数，然后 my_decorator 函数返回 wrapper 函数，并将 wrapper 函数赋值给 say_hello。 因此，当我们调用 say_hello() 时，实际上是在调用 wrapper() 函数。
4. 装饰带有参数的函数：
上面的例子只能装饰不带参数的函数。如果我们要装饰带有参数的函数，我们需要修改 wrapper 函数来接收和传递这些参数。
“`python
def my_decorator(func):
def wrapper(args, kwargs):
print(“Before calling the function with arguments:”, args, kwargs)
result = func(args, **kwargs)
print(“After calling the function with result:”, result)
return result
return wrapper
@my_decorator
def add(x, y):
return x + y
result = add(2, 3)
print(“Final result:”, result)
“`
输出:
Before calling the function with arguments: (2, 3) {}
After calling the function with result: 5
Final result: 5
代码解释:
*args, **kwargs:*args用于接收所有位置参数，并将它们打包成一个元组。**kwargs用于接收所有关键字参数，并将它们打包成一个字典。wrapper函数现在可以接受任何数量和类型的参数。func(*args, **kwargs): 将接收到的参数传递给原始函数func。return result: 返回原始函数的结果。
5. 装饰带有返回值的函数：
如上面的例子所示，在装饰带有返回值的函数时，我们需要确保 wrapper 函数返回原始函数的结果。
6. 装饰器自身带参数：
有时候，我们需要让装饰器本身也接受参数，以便更灵活地配置装饰器的行为。 为了实现这一点，我们需要创建一个“装饰器工厂”函数。
“`python
def repeat(num_times):
def my_decorator(func):
def wrapper(args, kwargs):
for i in range(num_times):
print(“Executing function:”, i + 1)
result = func(args, **kwargs)
return result
return wrapper
return my_decorator
@repeat(num_times=3)
def greet(name):
print(f”Hello, {name}!”)
greet(“Alice”)
“`
输出:
Executing function: 1
Hello, Alice!
Executing function: 2
Hello, Alice!
Executing function: 3
Hello, Alice!
代码解释:
repeat(num_times): 这是一个装饰器工厂函数，它接受num_times作为参数，并返回一个装饰器函数my_decorator。my_decorator(func): 这是一个装饰器函数，与之前的例子类似。wrapper(*args, **kwargs): 包装器函数，它会重复执行funcnum_times次。
当我们使用 @repeat(num_times=3) 应用到 greet() 函数时，实际上发生了以下步骤：
repeat(num_times=3)被调用，返回my_decorator函数。my_decorator(greet)被调用，返回wrapper函数。wrapper函数被赋值给greet。
7. 使用 functools.wraps 保持函数元信息：
在使用装饰器时，原始函数的 __name__ (函数名)、__doc__ (文档字符串) 和 __annotations__ (类型注解) 等元信息会被覆盖。 为了解决这个问题，我们可以使用 functools.wraps 装饰器来保留原始函数的元信息。
“`python
import functools
def my_decorator(func):
@functools.wraps(func)
def wrapper(args, kwargs):
“””This is the wrapper function.”””
print(“Before calling the function.”)
result = func(args, **kwargs)
print(“After calling the function.”)
return result
return wrapper
@my_decorator
def say_hello():
“””This is the say_hello function.”””
print(“Hello!”)
print(say_hello.name)
print(say_hello.doc)
“`
输出:
say_hello
This is the say_hello function.
代码解释:
@functools.wraps(func): 这个装饰器会将原始函数func的元信息复制到wrapper函数。 这样，当我们访问say_hello.__name__和say_hello.__doc__时，我们得到的是原始函数的信息，而不是wrapper函数的信息。
8. 类装饰器：
除了装饰函数，我们还可以使用装饰器来装饰类。 类装饰器可以用于修改类的行为，例如添加属性、方法或者拦截类的实例化过程。
“`python
def add_attribute(attribute_name, attribute_value):
def decorator(cls):
setattr(cls, attribute_name, attribute_value)
return cls
return decorator
@add_attribute(“description”, “This is a decorated class.”)
class MyClass:
pass
instance = MyClass()
print(instance.description)
“`
输出:
This is a decorated class.
代码解释:
add_attribute(attribute_name, attribute_value): 这是一个装饰器工厂函数，它接受属性名和属性值作为参数，并返回一个装饰器函数。decorator(cls): 这是一个装饰器函数，它接受一个类cls作为参数，并使用setattr()函数将属性添加到类中。@add_attribute("description", "This is a decorated class."): 将description属性和对应的值添加到MyClass中。
9. 实际应用场景：
- 日志记录: 可以使用装饰器来记录函数的执行时间、参数和返回值。
- 性能分析: 可以使用装饰器来测量函数的执行时间，帮助你找到性能瓶颈。
- 权限验证: 可以使用装饰器来验证用户是否有权限访问某个函数。
- 缓存: 可以使用装饰器来缓存函数的返回值，避免重复计算。
- 重试机制: 可以使用装饰器来实现函数的自动重试机制。
- 单例模式: 可以使用装饰器来实现单例模式。
10. 总结：
Python装饰器是一种强大的工具，可以让你以一种优雅的方式来扩展函数和类的功能。 通过本教程的学习，你应该对装饰器的概念、语法和应用场景有了更深入的了解。 在实际开发中，灵活运用装饰器可以提高代码的重用性、可读性和可维护性。 记住，理解装饰器的本质是理解其背后的函数式编程思想。 不断实践和探索，你将能够充分发挥装饰器的威力，编写出更加高效、简洁和优雅的Python代码。 祝你学习愉快！