欢迎您访问 最编程 本站为您分享编程语言代码,编程技术文章!
您现在的位置是: 首页

Python 装饰器用法详解

最编程 2024-06-10 14:46:16
...

一、释义

Python的装饰器本质上是一个函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返回值也是一个函数对象。一切皆对象,Python允许将函数以参数的形式赋值给变量。简单的说装饰器就是一个用来返回函数的函数,能够实现面向切面编程。

    我在  看到一个有趣的举例生动形象的说明装饰器的作用:
内裤主要功能是用来遮羞,但是到了冬天它没法为我们防风御寒,咋办?我们想到的一个办法就是把内裤改造一下,让它变得更厚更长,这样一来,它不仅有遮羞功能,还能提供保暖,不过有个问题,我不想改变原来内裤的结构怎么办?。于是聪明的人们发明长裤,在不影响内裤的前提下,直接把长裤套在了内裤外面,这样内裤还是内裤,有了长裤后宝宝再也不冷了。装饰器就像我们这里说的长裤,在不影响内裤作用的前提下,给我们的身子提供了保暖的功效

    它经常用于有切面需求的场景,比如:插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。概括的讲,装饰器的作用就是为已经存在的对象添加额外的功能。

二、闭包

在学习装饰器之前首先要了解一下闭包的概念,以下是百度百科解释:

闭包就是能够读取其他函数内部变量的函数。例如在javascript中,只有函数内部的子函数才能读取局部变量,所以闭包可以理解成“定义在一个函数内部的函数“。在本质上,闭包是将函数内部和函数外部连接起来的桥梁。

光看这些定义解释初学者很难看懂具体的含义,But--talk is cheap,Show me the code.

    从上面的示例来看,这个函数保存了执行的上下文,可以脱离原本的作用域独立存在。闭包概念的理解参考了 理解Python装饰器(Decorator) - 简书 有兴趣的可以去看看。在了解了闭包的概念之后,下面在去学习装饰器就好理解了;


三、装饰器

上面的废话虽然有点多,但是必不可少。现在进入正题,下面看一个简单常见的装饰器,看下装饰器结构和调用过程是怎样的?

从上面可以看出,装饰器的结构是由两个函数组成的,外部函数里面嵌套了一个函数,外部函数 new_decorator 在调用时会传入了一个参数 a_func(函数对象),
而内部函数则引用了该函数变量,这样就是形成了一个闭包。从输出的结果来看,hello 函数使用 @new_decorator 之后,在调用该函数的时候,其实是把hello 函数当做变量传递给了 new_decorator 函数,然后 wrapperTheFunction 函数在调用 a_func() 之前执行了一次操作,在之后又执行了一次操作。

从这样看来,装饰器的调用方式有些奇怪,那么下面在看个示例:

后面的这两种调用方式跟之前的写法结果是等同的,这样看是不是就理解了?装饰器使用了 @语法糖,只是将函数传入装饰器函数,并无神奇之处。函数的调用方式其实都是一样的,并没有什么特殊的地方。下面在看一个示例:

    本来我是想打印 hello 函数的名称,但是结果输出的确实装饰器嵌套函数的名称,显然这不是我想要的。具体原因是:函数被 warpTheFunction 替代了。它重写了hello 函数的名字和注释文档(docstring)。使用装饰器极大的复用了代码,但是他有一个缺点就是原函数的元信息不见了,比如:函数的 docstring、__name__、参数列表等;

    Python 使用了一个简单的函数(functools.wrap())来解决了该问题 ,下面修改一下上面的例子,看是否能够达到我的预期

输出结果很显然达到了我想要的预期,但是如果,我需要 hello 传入一些任意参数,该怎么解决?

那么在这里就可以使用 *args **kwargs 来定义参数,就可以完美解决,如果有不了解不定长参数的,可以参考我的上一篇 Python 函数参数之不定长参数(*args/**kwargs)、匿名函数 Lambda详解 - 简书 有专门讲解,下面看一下具体示例:


四、带参数的装饰器

有一些装饰器都是可以传入指定的参数的,上面简单讲解了一下普通的装饰器的使用,那么接下来如何实现一个带参数的装饰?修改一下上面的装饰器:

    上面的 logger_decorator 带参数的装饰器。它实际上是对原有 logger 装饰器的一个函数封装,并返回一个装饰器。我们可以将它理解为一个含有参数的闭包。当我 们使用@logger_decorator (log_file="out.log")调用的时候,Python 能够发现这一层的封装,并把参数传递到装饰器的环境中。

但是看到这个代码又有新的疑问?,内层的 logger 函数的参数 func 是怎么传进去的?和上面一般的装饰器不一样。但是道理是一样的,将其@语法去除,恢复函数调用的形式我们再来看看

虽然看起来有点奇怪,最终结果输出还是一致的,最后来发现装饰器并没有想象中的辣么难了?带参数的装饰器无非就是在外面在套了一层函数而已

装饰器这一语法体现了Python中函数是第一公民,函数是对象、是变量,可以作为参数、可以是返回值,非常的灵活与强大。


五、类装饰器

    装饰器不仅可以是函数,还可以是类,相比函数装饰器,类装饰器具有灵活度大、高内聚、封装性等优点。使用类装饰器主要依靠类的__call__方法,当使用 @ 形式将装饰器附加到函数上时,就会调用此方法。一个类装饰器里面可以包含多个装饰器方法。

    这里实现有一个附加优势,在于比嵌套函数的方式更加整洁,而且包裹一个函数还是使用跟以前一样的语法。

    下面在创建一个子类类继承 Logger 类,重写父类的 notify 方法,实现一个发送邮件的功能。

    这样 SendEmail类和Logger类一样都实现了记录日志写入文件的功能,并且还会在发送一次邮件,这样对装饰器的功能进行了扩展,是不是觉得很强大?

最后在聊一下装饰器的执行顺序:

    当一个函数使用多个装饰器的时候:

    调用的顺序是从里到外,从下往上开调用,可以理解为:Logger(SendEmail (addition_func)) ,但是有个主意点是,执行函数的时候是从最外层的时候开始的,所以执行顺序和函数的调用顺序别搞混了,可以看下之前的函数的装饰器就知道了。

以上就是装饰器常用的一些用法了,有兴趣的同学可以尝试一下,其实只有尝试了才知道并没有多难,有疑问的可以给我留言。