Python装饰器学习笔记

之前在看<<Python核心编程>>时遇到decorator时看得云里雾里，然后也没去多管，想到等以后遇到这个问题时再去解决。今天在看Django代码时看到login_required等装饰器时又遇到这个东西了，于是在网上找了一些文档重新学了一下，在此做一个总结。

1. 装饰器含义

装饰器是一个很著名的设计模式，经常被用于有切面需求的场景，较为经典的有插入日志、性能测试、事务处理等。装饰器是解决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量函数中与函数功能本身无关的雷同代码并继续重用。概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能。

2. 装饰器语法

(1)无参数装饰器

[python] view plain copy

 print?

1. def deco(func):  
2.     print("deco")  
3.     return func  
4.  
5. @deco  
6. def foo():  
7.     print("foo")  
8.   
9. foo()  

第一个函数deco是装饰函数，它的参数就是被装饰的函数对象。我们可以在deco函数内对传入的函数对象做一番“装饰”，然后返回这个对象（记住一定要返回 ，不然外面调用foo的地方将会无函数可用。实际上此时foo=deco(foo)

(2)有参数装饰器

被装饰函数无参数

[python] view plain copy

 print?

1. def deco(argv):  
2.     def decorator(func):  
3.         print("decorator")  
4.         return func  
5.     print("deco")  
6.     print(argv)  
7.     return decorator  
8.  
9. @deco("123")  
10. def foo():  
11.     print("foo")  
12.   
13. foo()  

第一个函数deco是装饰函数，它的参数是用来“加强装饰”的。由于此函数并非被装饰的函数对象，所以在内部必须至少创建一个接受被装饰函数的函数，然后返回这个对象。实际上此时foo = deco(argv)(foo)

被装饰函数也有参数

[python] view plain copy

 print?

1. from functools import wraps  
2.   
3. def deco(argv):  
4.     def decorator(func):  
5.         @wraps(func)  
6.         def wrapper(*args, **kwargs):  
7.             print("wrapper")  
8.             return func(*args, **kwargs)  
9.         print("decorator")  
10.         return wrapper  
11.     print("deco")  
12.     print(argv)  
13.     return decorator  
14.  
15. @deco("123")  
16. def foo(data):  
17.     "this is foo"  
18.     print("foo")  
19.     print(data)  
20.   
21. foo("afdasdf")  
22.   
23. print(foo.__name__, foo.__doc__)  

在decorator函数内部还需要定义一个函数来接受被装饰函数的参数。此时foo = deco(argv)(foo)(data)

首先注意第5行，如果注释这一行，foo.__name__将是'wrapper'，使用这个装饰器后装饰之后的foo.__name__将还是原来的foo，wraps装饰器是将func的常用属性赋给了wrapper函数。另外相信你也注意到了，这个装饰器竟然带有一个参数。实际上，他还有另外两个可选的参数，assigned中的属性名将使用赋值的方式替换，而updated中的属性名将使用update的方式合并，你可以通过查看functools的源代码获得它们的默认值。对于这个装饰器，相当于wrapper = functools.wraps(func)(wrapper)

(3)多装饰器组合使用

[python] view plain copy

 print?

1. def deco_1(func):  
2.     def __deco_1(*args, **kwargs):  
3.         print("__deco_1")  
4.         return func(*args, **kwargs)  
5.     print("deco_1")  
6.     return __deco_1  
7.   
8. def deco_2(func):  
9.     def __deco_2(*args, **kwargs):  
10.         print("__deco_2")  
11.         return func(*args, **kwargs)  
12.     print("deco_2")  
13.     return __deco_2  
14.  
15. @deco_2  
16. @deco_1  
17. def test():  
18.     print("test")  
19.   
20. # test = deco_1(test)  
21. # print(test)  
22. # test = deco_2(test)  
23. # print(test)  
24.   
25. test()  

输出内容如下：

deco_1
deco_2
__deco_2
__deco_1
test

在申明函数test时就会输出前两行，真正执行的时候才会输出后三行。两个装饰器与注释部分的作用一样，可以替换。

(4)例子

[python] view plain copy

 print?

1. def makebold(func):  
2.     def wrapped():  
3.         return "<b>" + func() + "</b>"  
4.     return wrapped  
5.   
6. def makeitalic(func):  
7.     def wrapped():  
8.         return "<i>" + func() + "</i>"  
9.     return wrapped  
10.  
11. @makebold  
12. @makeitalic  
13. def say():  
14.     return "Hello"  
15.   
16. print(say())  

[python] view plain copy

 print?

1. #output  
2. ''''' 
3. <b><i>Hello</i></b> 
4. '''  

3. 体会

当多个函数有重复代码时可以将此部分代码单独拿出来整理成一个装饰器，然后对每个函数调用该装饰器，这样可以实现代码的复用，而且可以让原来的函数更轻便。

还有就是当我们需要为多个已经写好的函数添加一个共同功能，比如检查参数的合法性。我们就可以单独写一个检查合法性的装饰器，然后在每个需要检查参数合法性的函数出调用即可，而不用去每个函数内部修改。

参考：

1. Python装饰器学习

2. Python装饰器与面向切面编程