热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

Python中的装饰器(@)用法详解

装饰器是一种用于在不修改原函数代码的情况下,动态地添加功能的工具。它允许你在函数执行前后插入额外的逻辑,从而增强或改变函数的行为。
### Python 装饰器简介

装饰器是 Python 编程中非常强大的特性之一。它允许你在不修改原有函数代码的前提下,动态地为函数添加新的行为。通过装饰器,你可以在函数调用之前或之后执行特定的操作。

#### 示例:基本装饰器

下面是一个简单的装饰器示例,展示了如何在函数执行前后添加额外的操作。

```python
# 定义一个装饰器函数,接收另一个函数作为参数
def my_decorator(func):
# 定义一个内部函数,用于包裹原始函数
def wrapper():
print("在执行函数前做一些准备工作")
func() # 执行原始函数
print("在执行函数后进行清理工作")
return wrapper

# 定义一个需要装饰的普通函数
def my_function():
print("我是需要装饰的函数")

# 使用装饰器对函数进行包装
my_function = my_decorator(my_function)

# 调用装饰后的函数
my_function()
```

输出结果如下:

```
在执行函数前做一些准备工作
我是需要装饰的函数
在执行函数后进行清理工作
```

#### 使用 @ 符号简化装饰器应用

Python 提供了 `@` 符号来简化装饰器的使用。你可以直接在函数定义上方使用 `@decorator_name` 来应用装饰器。

```python
# 定义装饰器函数
def my_decorator(func):
def wrapper():
print("在执行函数前做一些准备工作")
func()
print("在执行函数后进行清理工作")
return wrapper

# 使用 @ 符号应用装饰器
@my_decorator
def my_function():
print("我是需要装饰的函数")

# 直接调用函数
my_function()
```

这种方式不仅简洁,而且更具可读性。

#### 处理函数元数据

当你使用装饰器时,默认情况下,被装饰函数的名称、文档字符串等元数据会被替换为装饰器内部函数的元数据。为了保留原始函数的元数据,可以使用 `functools.wraps` 装饰器。

```python
from functools import wraps

def my_decorator(func):
@wraps(func)
def wrapper():
print("在执行函数前做一些准备工作")
func()
print("在执行函数后进行清理工作")
return wrapper

@my_decorator
def my_function():
"""这是我的函数的文档字符串"""
print("我是需要装饰的函数")

print(my_function.__name__) # 输出: my_function
print(my_function.__doc__) # 输出: 这是我的函数的文档字符串
```

#### 实际应用场景

装饰器广泛应用于各种场景,如权限验证、日志记录、性能监控等。以下是一个基于装饰器的权限验证示例:

```python
from functools import wraps

def requires_auth(f):
@wraps(f)
def decorated(*args, **kwargs):
auth = kwargs.get('auth')
if not auth:
return "未授权访问"
return f(*args, **kwargs)
return decorated

@requires_auth
def sensitive_data(auth=None):
return "敏感数据"

print(sensitive_data()) # 输出: 未授权访问
print(sensitive_data(auth=True)) # 输出: 敏感数据
```

通过上述例子可以看出,装饰器能够极大地简化代码结构,并提高代码的可维护性和复用性。
推荐阅读
author-avatar
夏冰语风
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有