Python3中的装饰器

一.装饰器

1.定义：从字面上理解，就是装饰对象的器件。可以在不修改原有代码的情况下，为被装饰的对象增加新的功能或者附加限制条件或者帮助输出。装饰器有很多种，有函数的装饰器，也有类的装饰器。装饰器在很多语言中的名字也不尽相同，它体现的是设计模式中的装饰模式，强调的是开放封闭原则。装饰器的语法是将@装饰器名，放在被装饰对象上面。

 @decdef func():  # 被装饰对象pass

2.几个重要原则和概念
- a.python程序是从上到下开始执行的，当碰到函数定义代码块时不会立即执行，只是将其放入内存中。当此函数被调用时，才会开始执行函数内部的代码块。
- b.由于程序是顺序执行的，所以当我们对一个函数定义了两次。那么，后面的定义会覆盖前面的定义。所以，在python中代码的放置位置是有区别的，不能随意放置，通常函数体要放在调用语句的前面。
```
   def foo():print("第一次定义的foo()函数")def foo():print("第二次定义的foo()函数")foo()# 结果第二次定义的foo()函数
```
- c.搞清楚下面几个概念：函数名、函数体、返回值、函数的内存地址、函数名加括号、函数名当作参数、函数名加括号当作参数、返回函数名、返回函数名加括号
```
 def outer(func):def inner():print("内层函数inner()")return innerdef foo():print("原始函数foo()")outer(foo)outer(foo())
```
- 函数名：foo、outer、inner
- 函数体：函数的整个代码结构
- 返回值：return后面的表达式
- 函数的内存地址：id(foo)、id(outer)等
- 函数名加括号：对函数进行调用，如foo()、outer(foo)
- 函数名作为参数：outer(foo)中foo本身是一个函数，但作为参数传递给了outer函数
- 函数名加括号作为参数：先调用函数，再将它的返回值当做别的函数的参数，例如outer(foo())
- 返回函数名：return inner
- 返回函数名加括号：return inner()，其实就是先执行inner()函数，再将其返回值作为别的函数的返回值。

3.函数的装饰器

虚拟场景：有一个大公司，下属的基础平台部负责内部应用程序及API的开发。另外，还有上百个业务部门负责不同的业务，这些业务部门各自调用基础平台部提供的不同API，情况如下：

   # 基础平台部负责内部应用程序和API的开发def f1():print("业务部门1的数据接口")def f2():print("业务部门2的数据接口")def f3():print("业务部门3的数据接口")def f100():print("业务部门100的数据接口")# 业务部门调用各自的API
f1()
f2()
f3()
f100()

现在基础平台部分决定为函数的调用进行安全认证，第一种方法是对基础平台部门的代码进行重构，N个业务部门无需做任何修改。此方法不好，工作量太大！

# 基础平台部负责内部应用程序和API的开发def f1():# 加入认证程序代码print("业务部门1的数据接口")def f2():# 加入认证程序代码print("业务部门2的数据接口")def f3():# 加入认证程序代码print("业务部门3的数据接口")def f100():# 加入认证程序代码print("业务部门100的数据接口")# 业务部门调用各自的API
f1()
f2()
f3()
f100()

第二种方法：定义一个认证函数，在原来其他的函数中调用它，代码如下：

def login():print("认证成功")# 基础平台部负责内部应用程序和API的开发def f1():login()print("业务部门1的数据接口")def f2():login()print("业务部门2的数据接口")def f3():login()print("业务部门3的数据接口")def f100():login()print("业务部门100的数据接口")# 业务部门调用各自的API
f1()
f2()
f3()
f100()

第三种方法：第二种方法中，写出的代码没有遵循开放封闭的原则。即已经实现的功能代码内部不允许被修改，但外部可以被扩展。如果将开放封闭的原则应用在上面的需求中，那么就是不允许在函数f1、f2、…、f100的内部进行代码修改，但可以在外部对它们进行扩展。代码如下：

    def outer(func):def inner():print("认证成功")result = func()print("日志添加成功")return resultreturn inner
# 基础平台部负责内部应用程序和API的开发@outerdef f1():print("业务部门1的数据接口")@outerdef f2():print("业务部门2的数据接口")@outerdef f3():print("业务部门3的数据接口")@outerdef f100():print("业务部门100的数据接口")# 业务部门调用各自的API
f1()
f2()
f3()
f100()

使用装饰器@outer，也是仅需对基础平台的代码进行拓展，就可以实现在其他部门调用函数API之前都进行认证操作，在操作结束后保存日志，并且其他业务部门无需对他们自己的代码做任何修改，调用方式也不用变。

4.装饰器机制分析
下面以f1函数为例，对装饰器的运行机制进行分析：

 def outer(func):  # 装饰函数def inner():print("认证成功！")result = func()print("日志添加成功")return resultreturn inner@outerdef f1():  # 被装饰函数print("业务部门1数据接口......")

a.程序开始运行，从上到下开始解释。读到def outer(func)时，发现这是一个函数的定义，将其函数体放入内存中，然后跳过。
b.跳到@outer时，程序被@这个python语法糖吸引住，知道这是个装饰器，按规矩要立即执行，于是程序开始运行@后面那个名字outer所定义的函数。
c.程序返回到outer函数，开始执行装饰器的语法规则。规则是：被装饰函数的名字会被当作函数形参传递给装饰函数。装饰函数执行它自己内部的代码后，会将它的返回值赋值给被装饰函数。原来f1函数被当作参数传递给了func，而f1这个函数名之后会指向inner函数。注意：@outer和outer()是有区别的。没有括号时，outer函数会被立即执行。这个传统的用括号才能调用函数不同。
d.程序开始执行outer函数内部的内容，一开始它又碰到了一个函数inner，inner函数定义块被程序观察到后不会立刻执行，而是读入内存中（这是默认规则）。
e.再往下，碰到return inner，返回值是个函数名，并且这个函数名会被赋值给f1这个被装饰函数，也就是f1 = inner。此时，f1函数被新的函数inner覆盖了（实际上是f1这个函数名更改成指向inner这个函数名指向的函数体内存地址，f1不再指向它原来的函数体的内存地址），再往后调用f1的时候将执行inner函数内的代码，而不是先前的函数体。那么先前的函数体去哪了？还记得我们将f1当做参数传递给func这个形参么？func这个变量保存了老的函数在内存中的地址，通过它就可以执行老的函数体，你能在inner函数里看到result = func()这句代码，它就是这么干的！
f.接下来，还没有结束。当业务部门，依然通过f1()的方式调用f1函数时，执行的就不再是旧的f1函数的代码，而是inner函数的代码。在本例中，它首先会打印个“认证成功”的提示，很显然你可以换成任意的代码，这只是个示例；然后，它会执行func函数并将返回值赋值给变量result，这个func函数就是旧的f1函数；接着，它又打印了“日志添加成功”的提示，这也只是个示例，可以换成任何你想要的；最后返回result这个变量。我们在业务部门的代码上可以用r = f1()的方式接收result的值。
g.以上流程走完后，你应该看出来了，在没有对业务部门的代码和接口调用方式做任何修改的同时，也没有对基础平台部原有的代码做内部修改，仅仅是添加了一个装饰函数，就实现了我们的需求，在函数调用前进行认证，调用后写入日志。这就是装饰器的最大作用。
4.上面的例子中，f1函数没有参数，在实际情况中肯定会需要参数的，函数的参数怎么传递的呢？

def outer(func):def inner(username):print("认证成功")result = func(username)print("日志添加成功")return resultreturn inner
@outer
def f1(name):print("{}正在调用业务部门1的数据接口".format(name))
# 调用方法
f1("Jack")

在inner函数的定义部分也加上一个参数，调用func函数的时候传递这个参数，很好理解吧？可问题又来了，那么另外一个部门调用的f2有2个参数呢？f3有3个参数呢？你怎么传递？很简单，我们有*args和**kwargs嘛！号称“万能参数”！简单修改一下上面的代码：

def outer(func):def inner(*args, *kwargs):print("认证成功")result = func(*args, **kwargs)print("日志添加成功")return resultreturn inner
@outer
def f1(name, age):print("{}正在调用业务部门1的数据接口".format(name))
# 调用方法
f1("jack", 19)

一个函数可以被多个函数装饰吗？可以的！看下面的例子:

 def outer1(func):def inner(*args,**kwargs):print("认证成功！")result = func(*args,**kwargs)print("日志添加成功")return resultreturn innerdef outer2(func):def inner(*args,**kwargs):print("一条欢迎信息。。。")result = func(*args,**kwargs)print("一条欢送信息。。。")return resultreturn inner@outer1
@outer2
def f1(name,age):print("%s 正在连接业务部门1数据接口......"%name)# 调用方法
f1("jack",18)

更进一步，装饰器自己可以有参数吗？可以的！看下面的例子：

 # 认证函数def  auth(request,kargs):print("认证成功！")# 日志函数def log(request,kargs):print("日志添加成功")# 装饰器函数。接收两个参数，这两个参数应该是某个函数的名字。def Filter(auth_func,log_func):# 第一层封装，f1函数实际上被传递给了main_fuc这个参数def outer(main_func):# 第二层封装，auth和log函数的参数值被传递到了这里def wrapper(request,kargs):# 下面代码的判断逻辑不重要，重要的是参数的引用和返回值before_result = auth(request,kargs)if(before_result != None):return before_result;main_result = main_func(request,kargs)if(main_result != None):return main_result;after_result = log(request,kargs)if(after_result != None):return after_result;return wrapperreturn outer# 注意了，这里的装饰器函数有参数哦，它的意思是先执行filter函数。然后将filter函数的返回值作为装饰器函数的名字返回到这里。所以，Filter(auth,log) = outer , @Filter(auth,log) =  @outer@Filter(auth,log)def f1(name,age):print("%s 正在连接业务部门1数据接口......"%name)# 调用方法f1("jack",18)

二.参考博客

刘江的博客

Python3中的装饰器相关推荐

python3语法糖------装饰器
#!/usr/bin/env python3 # -*- coding: utf-8 -*- """装饰器""" ###### 第一波 ## ...
pythonproperty装饰器_实例讲解Python编程中@property装饰器的用法
取值和赋值 class Actress(): def __init__(self): self.name = 'TianXin' self.age = 5 类Actress中有两个成员变量name和a ...
python中的装饰器有哪些-python 装饰器以及开发中常用的例子
有时候我们想为多个函数,同意添加某一种功能,比如及时统计,记录日志,缓存运算结果等等,而又不想改变函数代码那就定义装饰器函数,用它来生成一个在原函数基础添加了新功能的函数,代替原函数参考金角大王的 ...
python装饰器原理-python 中的装饰器及其原理
装饰器模式此前的文章中我们介绍过装饰器模式: 装饰器模式中具体的 Decorator 实现类通过将对组建的请求转发给被装饰的对象,并在转发前后执行一些额外的动作来修改原有的部分行为,实现增强 Com ...
python类装饰器详解-Python类中的装饰器在当前类中的声明与调用详解
我的Python环境:3.7 在Python类里声明一个装饰器,并在这个类里调用这个装饰器. 代码如下: class Test(): xx = False def __init__(self): pa ...
python类装饰器详解-python 中的装饰器详解
装饰器闭包闭包简单的来说就是一个函数,在该函数内部再定义一个函数,并且这个内部函数用到了外部变量(即是外部函数的参数),最终这个函数返回内部函数的引用,这就是闭包. def decorator(p ...
python装饰器 property_Python中@property装饰器的使用技巧性解析（代码示例）
Python中@property装饰器的技巧性用法(代码示例) 本篇文章给大家带来的内容是关于Python中@property装饰器的技巧性用法(代码示例),有一定的参考价值,有需要的朋友可以参考一下 ...
python中的装饰器decorator
python中的装饰器装饰器是为了解决以下描述的问题而产生的方法我们在已有的函数代码的基础上,想要动态的为这个函数增加功能而又不改变原函数的代码例如有三个函数: def f1(x):return ...
装饰器的注意事项python_python中的装饰器decorator
python中的装饰器装饰器是为了解决以下描述的问题而产生的方法我们在已有的函数代码的基础上,想要动态的为这个函数增加功能而又不改变原函数的代码例如有三个函数: deff1(x):returnx ...

Python3中的装饰器

一.装饰器

二.参考博客

Python3中的装饰器相关推荐

最新文章

热门文章