5个案例详解装饰器 | 手把手教你入门Python之四十六-阿里云开发者社区

上一篇：详解高阶函数和闭包 | 手把手教你入门Python之四十五
下一篇：常见系统模块汇总 | 手把手教你入门Python之四十七

本文来自于千锋教育在阿里云开发者社区学习中心上线课程《Python入门2020最新大课》，主讲人姜伟。

装饰器

装饰器是程序开发中经常会⽤到的⼀个功能，⽤好了装饰器，开发效率如⻁添翼，所以这也是Python⾯试中必问的问题。但对于好多初次接触这个知识的⼈来讲，这个功能有点绕，⾃学时直接绕过去了，然后⾯试问到了就挂了，因为装饰器是程序开发的基础知识，这个都不会，别跟⼈家说你会Python, 看了下⾯的⽂章，保证你学会装饰器。

1、先明⽩这段代码

#### 第⼀波 ####
def foo():
 print('foo')
foo # 表示是函数
foo() # 表示执⾏foo函数
#### 第⼆波 ####
def foo():
 print('foo')
foo = lambda x: x + 1
foo() # 执⾏lambda表达式，⽽不再是原来的foo函数，因为foo这个名字被重新指向了另外⼀个匿名函数

函数名仅仅是个变量，只不过指向了定义的函数⽽已，所以才能通过函数名()调⽤，如果函数名=xxx被修改了，那么当在执⾏函数名()时，调⽤的就不知之前的那个函数了

2、需求来了

初创公司有N个业务部⻔，基础平台部⻔负责提供底层的功能，如：数据库操作、redis调⽤、监控API等功能。业务部⻔使⽤基础功能时，只需调⽤基础平台提供的功能即可。如下：

############### 基础平台提供的功能如下 ###############
def f1():
 print('f1')
def f2():
 print('f2')
def f3():
 print('f3')
def f4():
 print('f4')
############### 业务部⻔A 调⽤基础平台提供的功能 ###############
f1()
f2()
f3()
f4()
############### 业务部⻔B 调⽤基础平台提供的功能 ###############
f1()
f2()
f3()
f4()

⽬前公司有条不紊的进⾏着，但是，以前基础平台的开发⼈员在写代码时候没有关注验证相关的问题，即：
基础平台的提供的功能可以被任何⼈使⽤。现在需要对基础平台的所有功能进⾏重构，为平台提供的所有功能添加验证机制，即：执⾏功能前，先进⾏验证。

⽼⼤把⼯作交给 Low B，他是这么做的：

跟每个业务部⻔交涉，每个业务部⻔⾃⼰写代码，调⽤基础平台的功能之前先验证。诶，这样⼀来基础
平台就不需要做任何修改了。太棒了，有充⾜的时间泡妹⼦...

当天Low B 被开除了…

⽼⼤把⼯作交给 Low BB，他是这么做的：

############### 基础平台提供的功能如下 ###############
def f1():
 # 验证1
 # 验证2
 # 验证3
 print('f1')
def f2():
 # 验证1
 # 验证2
 # 验证3
 print('f2')
def f3():
 # 验证1
 # 验证2
 # 验证3
 print('f3')
def f4():
 # 验证1
 # 验证2
 # 验证3
 print('f4')
############### 业务部⻔不变 ###############
### 业务部⻔A 调⽤基础平台提供的功能###
f1()
f2()
f3()
f4()
### 业务部⻔B 调⽤基础平台提供的功能 ###
f1()
f2()
f3()
f4()

过了⼀周 Low BB 被开除了…

⽼⼤把⼯作交给 Low BBB，他是这么做的：

只对基础平台的代码进⾏重构，其他业务部⻔⽆需做任何修改

############### 基础平台提供的功能如下 ###############
def check_login():
 # 验证1
 # 验证2
 # 验证3
 pass
def f1():
 check_login()
 print('f1')
def f2():
 check_login()
 print('f2')
def f3():
 check_login()
 print('f3')
def f4():
 check_login()
 print('f4')

⽼⼤看了下Low BBB 的实现，嘴⻆漏出了⼀丝的欣慰的笑，语重⼼⻓的跟Low BBB聊了个天：

老大说：

写代码要遵循开放封闭原则，虽然在这个原则是⽤的⾯向对象开发，但是也适⽤于函数式编程，简单来
说，它规定已经实现的功能代码不允许被修改，但可以被扩展，即：

封闭：已实现的功能代码块
开放：对扩展开发

如果将开放封闭原则应⽤在上述需求中，那么就不允许在函数 f1 、f2、f3、f4的内部进⾏修改代码，⽼板就给了Low BBB⼀个实现⽅案：

def w1(func):
 def inner():
 # 验证1
 # 验证2
 # 验证3
 func()
 return inner
@w1
def f1():
 print('f1')
@w1
def f2():
 print('f2')
@w1
def f3():
 print('f3')
@w1
def f4():
 print('f4')

对于上述代码，也是仅仅对基础平台的代码进⾏修改，就可以实现在其他⼈调⽤函数 f1 f2 f3 f4 之前都进⾏
【验证】操作，并且其他业务部⻔⽆需做任何操作。
Low BBB⼼惊胆战的问了下，这段代码的内部执⾏原理是什么呢？
⽼⼤正要⽣⽓，突然Low BBB的⼿机掉到地上，恰巧屏保就是Low BBB的⼥友照⽚，⽼⼤⼀看⼀紧⼀抖，喜笑颜开，决定和Low BBB交个好朋友。
详细的开始讲解了：
单独以f1为例：

def w1(func):
 def inner():
 # 验证1
 # 验证2
 # 验证3
 func()
 return inner
@w1
def f1():
 print('f1')

python解释器就会从上到下解释代码，步骤如下：

def w1(func): ==>将w1函数加载到内存
@w1

没错，从表⾯上看解释器仅仅会解释这两句代码，因为函数在没有被调⽤之前其内部代码不会被执⾏。
从表⾯上看解释器着实会执⾏这两句，但是 @w1 这⼀句代码⾥却有⼤⽂章， @函数名是python的⼀种语法糖。

上例@w1内部会执⾏⼀下操作：

执⾏w1函数

执⾏w1函数，并将 @w1 下⾯的函数作为w1函数的参数，即：@w1 等价于 w1(f1) 所以，内部就会去
执⾏：

def inner():
 #验证 1
 #验证 2
 #验证 3
 f1() # func是参数，此时 func 等于 f1
 return inner# 返回的 inner，inner代表的是函数，⾮执⾏函数 ,其实就是将原来的 f1 函数塞进另外
⼀个函数中

w1的返回值

将执⾏完的w1函数返回值赋值给@w1下⾯的函数的函数名f1 即将w1的返回值再重新赋值给 f1，即：

新f1 = def inner():
 #验证 1
 #验证 2
 #验证 3
 原来f1()
 return inner

所以，以后业务部⻔想要执⾏ f1 函数时，就会执⾏新f1 函数，在新f1 函数内部先执⾏验证，再执⾏原
来的f1函数，然后将原来f1 函数的返回值返回给了业务调⽤者。

如此⼀来，即执⾏了验证的功能，⼜执⾏了原来f1函数的内容，并将原f1函数返回值返回给业务调⽤者。
Low BBB 你明⽩了吗？要是没明⽩的话，我晚上去你家帮你解决吧！！！

3. 再议装饰器

# 定义函数：完成包裹数据
def makeBold(fn):
 def wrapped():
 return "<b>" + fn() + "</b>"
 return wrapped
# 定义函数：完成包裹数据
def makeItalic(fn):
 def wrapped():
 return "<i>" + fn() + "</i>"
 return wrapped
@makeBold
def test1():
 return "hello world-1"
@makeItalic
def test2():
 return "hello world-2"
@makeBold
@makeItalic
def test3():
 return "hello world-3"
print(test1())
print(test2())
print(test3())

运行结果;

<b>hello world-1</b>
<i>hello world-2</i>
<b><i>hello world-3</i><b>

4. 装饰器(decorator)功能

引⼊⽇志
函数执⾏时间统计
执⾏函数前预备处理
执⾏函数后清理功能
权限校验等场景
缓存

5. 装饰器示例

例1:⽆参数的函数

def check_time(action):
 def do_action():
 action()
 return do_action
@check_time
def go_to_bed():
 print('去睡觉')
go_to_bed()

上⾯代码理解装饰器执⾏为可理解成

result = check_time(go_to_bed) # 把go_to_bed 当做参数传⼊给 check_time函数，再定义⼀个
变量⽤来保存check_time的运⾏结果
result() # check_time 函数的返回值result是⼀个函数, result()再调⽤这个函数，让它再调⽤go_
to_bed函数

例2:被装饰的函数有参数

def check_time(action):
 def do_action(a,b):
 action(a,b)
 return do_action
@check_time
def go_to_bed(a,b):
 print('{}去{}睡觉'.format(a,b))
go_to_bed("zhangsan","床上“)

例3:被装饰的函数有不定⻓参数

def test(cal):
 def do_cal(*args,**kwargs):
 cal(*args,**kwargs)
 return do_cal
@test
def demo(*args):
 sum = 0
 for x in args:
 sum +=x
 print(sum)
demo(1, 2, 3, 4)

例4:装饰器中的return

def test(cal):
 def do_cal(*args,**kwargs):
 return cal(*args,**kwargs) # 需要再这⾥写return语句，表示调⽤函数，获取函数的返回
值并返回
 return do_cal
@test
def demo(a,b):
 return a + b
print(demo(1, 2)) #3

总结：
⼀般情况下为了让装饰器更通⽤，可以有return

例5:装饰器带参数

def can_play(clock):
    print('最外层函数被调用了，clock = {}'.format(clock))
    def handle_action(fn):
        def do_action(name, game):
            if clock < 21:
                fn(name, game)
            else:
                print('太晚了，不能玩儿游戏了')

        return do_action

    return handle_action

@can_play(20)  # 装饰器函数带参数
def play_game(name, game):
    print(name + '正在玩儿' + game)

play_game('张三', '王者荣耀')

1、调用can_play函数，并将12传递给clock
2、再调用handle_action方法，把play_game传递给fn
3、此时再调用play_game其实调用的就是do_action

提⾼：使⽤装饰器实现权限验证

以下代码不要求掌握，如果能看懂最好，如果能⾃⼰⼿动写出来，那就太棒了！

def outer_check(base_permission):
    def check_permission(action):
        def do_action(my_permission):
            if my_permission & base_permission:
                return action(my_permission)
            else:
                return '对不起，您不具有该权限'
            return do_action
        return check_permission
        
        
READ_PERMISSION = 1
WRITE_PERMISSION = 2
EXECUTE_PERMISSION = 4


@outer_check(base_permission=READ_PERMISSION)
def read(my_permission):
    return '读取数据'

@outer_check(base_permission=WRITE_PERMISSION)
def write(my_permission):
    return '写⼊数据'

@outer_check(base_permission=EXECUTE_PERMISSION)
def execute(my_permission):
    return '执⾏程序'

print(read(5))

5个案例详解装饰器 | 手把手教你入门Python之四十六

装饰器