恶补了 Python 装饰器的六种写法，你随便问~

 

今天给大家分享一下关于装饰器的知识点，内容非常干，全程高能，认真吸收看完，一定会对装饰器有更深的理解。

Hello，装饰器

装饰器本质上是一个Python函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外功能，装饰器的返回值也是一个函数对象。

它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景。

装饰器是解决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。

装饰器的使用方法很固定

• 先定义一个装饰器(帽子)
• 再定义你的业务函数或者类(人)
• 最后把这装饰器(帽子)扣在这个函数(人)头上

就像下面这样子

1. # 定义装饰器 
2. def decorator(func): 
3.     def wrapper(*args, **kw): 
4.         return func() 
5.     return wrapper 
6.  
7. # 定义业务函数并进行装饰 
8. @decorator 
9. def function(): 
10.     print("hello, decorator") 

实际上，装饰器并不是编码必须性，意思就是说，你不使用装饰器完全可以，它的出现，应该是使我们的代码

更加优雅，代码结构更加清晰

将实现特定的功能代码封装成装饰器，提高代码复用率，增强代码可读性

接下来，我将以实例讲解，如何编写出各种简单及复杂的装饰器。

第一种：普通装饰器

首先咱来写一个最普通的装饰器，它实现的功能是：

• 在函数执行前，先记录一行日志
• 在函数执行完，再记录一行日志

1. # 这是装饰器函数，参数 func 是被装饰的函数 
2. def logger(func): 
3.     def wrapper(*args, **kw): 
4.         print('我准备开始执行：{} 函数了:'.format(func.__name__)) 
5.  
6.         # 真正执行的是这行。 
7.         func(*args, **kw) 
8.  
9.         print('主人，我执行完啦。') 
10.     return wrapper 

假如，我的业务函数是，计算两个数之和。写好后，直接给它带上帽子。

1. @logger 
2. def add(x, y): 
3.     print('{} + {} = {}'.format(x, y, x+y)) 

然后执行一下 add 函数。

1. add(200, 50) 

来看看输出了什么?

1. 我准备开始执行：add 函数了: 
2. 200 + 50 = 250 
3. 我执行完啦。 

第二种：带参数的函数装饰器

通过上面两个简单的入门示例，你应该能体会到装饰器的工作原理了。

不过，装饰器的用法还远不止如此，深究下去，还大有文章。今天就一起来把这个知识点学透。

回过头去看看上面的例子，装饰器是不能接收参数的。其用法，只能适用于一些简单的场景。不传参的装饰器，只能对被装饰函数，执行固定逻辑。

装饰器本身是一个函数，做为一个函数，如果不能传参，那这个函数的功能就会很受限，只能执行固定的逻辑。这意味着，如果装饰器的逻辑代码的执行需要根据不同场景进行调整，若不能传参的话，我们就要写两个装饰器，这显然是不合理的。

比如我们要实现一个可以定时发送邮件的任务(一分钟发送一封)，定时进行时间同步的任务(一天同步一次)，就可以自己实现一个 periodic_task (定时任务)的装饰器，这个装饰器可以接收一个时间间隔的参数，间隔多长时间执行一次任务。

可以这样像下面这样写，由于这个功能代码比较复杂，不利于学习，这里就不贴了。

1. @periodic_task(spacing=60) 
2. def send_mail(): 
3.      pass 
4.  
5. @periodic_task(spacing=86400) 
6. def ntp() 
7.     pass  

那我们来自己创造一个伪场景，可以在装饰器里传入一个参数，指明国籍，并在函数执行前，用自己国家的母语打一个招呼。

1. # 小明，中国人 
2. @say_hello("china") 
3. def xiaoming(): 
4.     pass 
5.  
6. # jack，美国人 
7. @say_hello("america") 
8. def jack(): 
9.     pass 

那我们如果实现这个装饰器，让其可以实现 传参 呢?

会比较复杂，需要两层嵌套。

1. def say_hello(contry): 
2.     def wrapper(func): 
3.         def deco(*args, **kwargs): 
4.             if contry == "china": 
5.                 print("你好!") 
6.             elif contry == "america": 
7.                 print('hello.') 
8.             else: 
9.                 return 
10.  
11.             # 真正执行函数的地方 
12.             func(*args, **kwargs) 
13.         return deco 
14.     return wrapper 

来执行一下

1. xiaoming() 
2. print("------------") 
3. jack() 

看看输出结果。

1. 你好! 
2. ------------ 
3. hello. 

第三种：不带参数的类装饰器

以上都是基于函数实现的装饰器，在阅读别人代码时，还可以时常发现还有基于类实现的装饰器。

基于类装饰器的实现，必须实现 __call__ 和 __init__两个内置函数。

__init__ ：接收被装饰函数

__call__ ：实现装饰逻辑。

还是以日志打印这个简单的例子为例

1. class logger(object): 
2.     def __init__(self, func): 
3.         self.func = func 
4.  
5.     def __call__(self, *args, **kwargs): 
6.         print("[INFO]: the function {func}() is running..."\ 
7.             .format(func=self.func.__name__)) 
8.         return self.func(*args, **kwargs) 
9.  
10. @logger 
11. def say(something): 
12.     print("say {}!".format(something)) 
13.  
14. say("hello") 

执行一下，看看输出

1. [INFO]: the function say() is running... 
2. say hello! 

第四种：带参数的类装饰器

上面不带参数的例子，你发现没有，只能打印INFO级别的日志，正常情况下，我们还需要打印DEBUG WARNING等级别的日志。这就需要给类装饰器传入参数，给这个函数指定级别了。

带参数和不带参数的类装饰器有很大的不同。

__init__ ：不再接收被装饰函数，而是接收传入参数。

__call__ ：接收被装饰函数，实现装饰逻辑。

1. class logger(object): 
2.     def __init__(self, level='INFO'): 
3.         self.level = level 
4.  
5.     def __call__(self, func): # 接受函数 
6.         def wrapper(*args, **kwargs): 
7.             print("[{level}]: the function {func}() is running..."\ 
8.                 .format(level=self.level, func=func.__name__)) 
9.             func(*args, **kwargs) 
10.         return wrapper  #返回函数 
11.  
12. @logger(level='WARNING') 
13. def say(something): 
14.     print("say {}!".format(something)) 
15.  
16. say("hello") 

我们指定WARNING级别，运行一下，来看看输出。

1. [WARNING]: the function say() is running... 
2. say hello! 

第五种：使用偏函数与类实现装饰器

绝大多数装饰器都是基于函数和闭包实现的，但这并非制造装饰器的唯一方式。

事实上，Python 对某个对象是否能通过装饰器( @decorator)形式使用只有一个要求：decorator 必须是一个“可被调用(callable)的对象。

对于这个 callable 对象，我们最熟悉的就是函数了。

除函数之外，类也可以是 callable 对象，只要实现了__call__ 函数(上面几个例子已经接触过了)。

还有容易被人忽略的偏函数其实也是 callable 对象。

接下来就来说说，如何使用 类和偏函数结合实现一个与众不同的装饰器。

如下所示，DelayFunc 是一个实现了 __call__ 的类，delay 返回一个偏函数，在这里 delay 就可以做为一个装饰器。(以下代码摘自 Python工匠：使用装饰器的小技巧)

1. import time 
2. import functools 
3.  
4. class DelayFunc: 
5.     def __init__(self,  duration, func): 
6.         self.duration = duration 
7.         self.func = func 
8.  
9.     def __call__(self, *args, **kwargs): 
10.         print(f'Wait for {self.duration} seconds...') 
11.         time.sleep(self.duration) 
12.         return self.func(*args, **kwargs) 
13.  
14.     def eager_call(self, *args, **kwargs): 
15.         print('Call without delay') 
16.         return self.func(*args, **kwargs) 
17.  
18. def delay(duration): 
19.     """ 
20.     装饰器：推迟某个函数的执行。 
21.     同时提供 .eager_call 方法立即执行 
22.     """ 
23.     # 此处为了避免定义额外函数， 
24.     # 直接使用 functools.partial 帮助构造 DelayFunc 实例 
25.     return functools.partial(DelayFunc, duration) 

我们的业务函数很简单，就是相加

1. @delay(duration=2) 
2. def add(a, b): 
3.     return a+b 

来看一下执行过程

1. >>> add    # 可见 add 变成了 Delay 的实例 
2. <__main__.DelayFunc object at 0x107bd0be0> 
3. >>>  
4. >>> add(3,5)  # 直接调用实例，进入 __call__ 
5. Wait for 2 seconds... 
6. 8 
7. >>>  
8. >>> add.func # 实现实例方法 
9. <function add at 0x107bef1e0> 

第六种：能装饰类的装饰器

用 Python 写单例模式的时候，常用的有三种写法。其中一种，是用装饰器来实现的。

以下便是我自己写的装饰器版的单例写法。

1. instances = {} 
2.  
3. def singleton(cls): 
4.     def get_instance(*args, **kw): 
5.         cls_name = cls.__name__ 
6.         print('===== 1 ====') 
7.         if not cls_name in instances: 
8.             print('===== 2 ====') 
9.             instance = cls(*args, **kw) 
10.             instances[cls_name] = instance 
11.         return instances[cls_name] 
12.     return get_instance 
13.  
14. @singleton 
15. class User: 
16.     _instance = None 
17.  
18.     def __init__(self, name): 
19.         print('===== 3 ====') 
20.         self.name = name 

可以看到我们用singleton 这个装饰函数来装饰 User 这个类。装饰器用在类上，并不是很常见，但只要熟悉装饰器的实现过程，就不难以实现对类的装饰。在上面这个例子中，装饰器就只是实现对类实例的生成的控制而已。

其实例化的过程，你可以参考我这里的调试过程，加以理解。