Python 装饰器：从基础语法到类装饰器的完整指南
本文深入解析 Python 装饰器的核心机制与应用场景，涵盖日志记录、权限校验等切面需求。详细讲解 @ 语法糖的使用、带参/无参函数的自适应处理、functools.wraps 对元数据的保留，以及通过类实现优雅的多层装饰器模式，帮助开发者掌握高阶函数编程技巧。
一、装饰器使用场景
装饰器常用于处理具有切面需求的场景，例如插入日志记录、性能测试、事务管理、缓存机制以及权限校验等。通过装饰器，可以将大量与核心业务逻辑无关的重复代码抽离出来并实现复用，从而保持主函数的简洁性。
简而言之，装饰器的核心作用是为已存在的对象（如函数或类）添加额外的功能，而无需修改其原始代码。
二、为什么需要装饰器
1、先来看一个简单例子：
def foo():
print('i am foo')2、增加需求
假设现在需要记录函数的执行日志，我们可以在代码中直接添加日志打印语句：
def foo():
print('i am foo')
print("foo is running")3、又有需求
如果现在有 100 个函数都需要增加日志记录功能，甚至后续还需要在函数执行前打印特定日志，难道要逐个修改代码吗？
显然不可行，这会导致大量重复代码。为了减少冗余，我们可以重新定义一个函数：专门负责处理日志逻辑，在日志处理完成后，再执行真正的业务代码。
def use_logging(func):
print("%s is running" % func.__name__)
func()
def bar():
print('i am bar')
use_logging(bar)
运行结果:
#bar is running
#i am bar上述的 `use_logging` 函数即为装饰器，它将执行真正业务逻辑的 `func` 包裹在内部，使得 `bar` 看起来像是被 `use_logging` 装饰了。在这个例子中，函数进入和退出的过程被称为一个横切面 (Aspect)，这种编程范式被称为面向切面的编程 (Aspect-Oriented Programming)。
通过 `use_logging` 函数，我们增加了日志功能。无论未来有多少函数需要添加或修改日志格式，只需修改 `use_logging` 函数本身，并执行 `use_logging(被装饰的函数)` 即可达到预期效果。
def use_logging(func):
print("%s is running" % func.__name__)
return func
@use_logging
def bar():
print('i am bar')
bar()三、基础装饰器入门
1、装饰器语法糖
Python 提供了 `@` 符号作为装饰器的语法糖，使应用装饰器更加便捷。但使用语法糖要求装饰函数必须返回一个函数对象。因此，我们将上面的 `func` 函数使用内嵌函数包裹并返回。
装饰器的执行过程相当于先执行装饰函数 `use_logging`，再返回被装饰函数 `bar`。因此，调用 `bar()` 时相当于执行了两个函数，其逻辑等价于 `use_logging(bar)()`。
def use_logging(func):
def _deco():
print("%s is running" % func.__name__)
func()
return _deco
@use_logging
def bar():
print('i am bar')
bar()2、对带参数的函数进行装饰
如果我们的业务函数需要传入两个参数并计算结果，我们需要对内层函数进行修改以接收这两个参数 `a` 和 `b`，这等价于执行 `use_logging(bar)(1,2)`。
def use_logging(func):
def _deco(a,b):
print("%s is running" % func.__name__)
func(a,b)
return _deco
@use_logging
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,2)然而，被装饰的函数参数个数和类型可能各不相同，每次都需要修改装饰器显然不科学。因此，我们可以利用 Python 的变长参数 `*args` 和 `**kwargs` 来解决参数适配问题。
3、函数参数数量不确定
不带参数的装饰器版本，该格式适用于不带参数的装饰器场景。
经过上述修改，我们已适应各种长度和类型的参数。这个版本的装饰器可以装饰任意类型的无参数函数。
def use_logging(func):
def _deco(*args,**kwargs):
print("%s is running" % func.__name__)
func(*args,**kwargs)
return _deco
@use_logging
def bar(a,b):
print('i am bar:%s'%(a+b))
@use_logging
def foo(a,b,c):
print('i am bar:%s'%(a+b+c))
bar(1,2)
foo(1,2,3)4、装饰器带参数
带参数的装饰器，该格式适用于需要传递参数给装饰器本身的场景。
在某些情况下，我们需要让装饰器本身携带参数，这就需要编写一个返回装饰器的高阶函数，代码结构会变得更加复杂。例如：
#! /usr/bin/env python
# -*- coding:utf-8 -*-
# __author__ = "TKQ"
def use_logging(level):
def _deco(func):
def __deco(*args, **kwargs):
if level == "warn":
print "%s is running" % func.__name__
return func(*args, **kwargs)
return __deco
return _deco
@use_logging(level="warn")
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,3)
# 等价于use_logging(level="warn")(bar)(1,3)5、functools.wraps
使用装饰器极大地复用了代码，但它有一个缺点：原函数的元信息会丢失，例如函数的 `docstring`、`__name__` 和参数列表。先看以下例子：
def use_logging(func):
def _deco(*args,**kwargs):
print("%s is running" % func.__name__)
func(*args,**kwargs)
return _deco
@use_logging
def bar():
print('i am bar')
print(bar.__name__)
bar()
#bar is running
#i am bar
#_deco
#函数名变为_deco而不是bar，这个情况在使用反射的特性的时候就会造成问题。因此引入了functools.wraps解决这个问题。使用 `functools.wraps` 可以解决上述问题：
import functools
def use_logging(func):
@functools.wraps(func)
def _deco(*args,**kwargs):
print("%s is running" % func.__name__)
func(*args,**kwargs)
return _deco
@use_logging
def bar():
print('i am bar')
print(bar.__name__)
bar()
#result:
#bar is running
#i am bar
#bar ,这个结果是我们想要的。OK啦！6、实现带参数和不带参数的装饰器自适应
import functools
def use_logging(arg):
if callable(arg):#判断参入的参数是否是函数，不带参数的装饰器调用这个分支
@functools.wraps(arg)
def _deco(*args,**kwargs):
print("%s is running" % arg.__name__)
arg(*args,**kwargs)
return _deco
else:#带参数的装饰器调用这个分支
def _deco(func):
@functools.wraps(func)
def __deco(*args, **kwargs):
if arg == "warn":
print "warn%s is running" % func.__name__
return func(*args, **kwargs)
return __deco
return _deco
@use_logging("warn")
# @use_logging
def bar():
print('i am bar')
print(bar.__name__)
bar()三、类装饰器
使用类装饰器可以实现带参数装饰器的效果，但实现方式更加优雅简洁，而且可以通过继承来灵活扩展功能。
1、类装饰器
class loging(object):
def __init__(self,level="warn"):
self.level = level
def __call__(self,func):
@functools.wraps(func)
def _deco(*args, **kwargs):
if self.level == "warn":
self.notify(func)
return func(*args, **kwargs)
return _deco
def notify(self,func):
# logit只打日志，不做别的
print "%s is running" % func.__name__
@loging(level="warn")#执行__call__方法
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,3)2、继承扩展类装饰器
class email_loging(Loging):
'''
一个loging的实现版本，可以在函数调用时发送email给管理员
'''
def __init__(self, email='admin@myproject.com', *args, **kwargs):
self.email = email
super(email_loging, self).__init__(*args, **kwargs)
def notify(self,func):
# 发送一封email到self.email
print "%s is running" % func.__name__
print "sending email to %s" %self.email
@email_loging(level="warn")
def bar(a,b):
print('i am bar:%s'%(a+b))
bar(1,3)以上就是 Python 装饰器的使用与要点，更多关于 Python 装饰器的资料可参考其他相关文章。
本站声明
本文内容仅供参考，不代表本站观点。转载或引用请注明出处。如发现内容问题，请通过联系我们页面反馈。
