Python的装饰器模式与面向切面编程详解


Posted in Python onJune 21, 2015

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

1. 装饰器入门

1.1. 需求是怎么来的?

装饰器的定义很是抽象,我们来看一个小例子。

def foo():

    print 'in foo()'

 

foo()

这是一个很无聊的函数没错。但是突然有一个更无聊的人,我们称呼他为B君,说我想看看执行这个函数用了多长时间,好吧,那么我们可以这样做:

import time

def foo():

    start = time.clock()

    print 'in foo()'

    end = time.clock()

    print 'used:', end - start

 

foo()

很好,功能看起来无懈可击。可是蛋疼的B君此刻突然不想看这个函数了,他对另一个叫foo2的函数产生了更浓厚的兴趣。

怎么办呢?如果把以上新增加的代码复制到foo2里,这就犯了大忌了~复制什么的难道不是最讨厌了么!而且,如果B君继续看了其他的函数呢?

1.2. 以不变应万变,是变也

还记得吗,函数在Python中是一等公民,那么我们可以考虑重新定义一个函数timeit,将foo的引用传递给他,然后在timeit中调用foo并进行计时,这样,我们就达到了不改动foo定义的目的,而且,不论B君看了多少个函数,我们都不用去修改函数定义了!

import time

 

def foo():

    print 'in foo()'

 

def timeit(func):

    start = time.clock()

    func()

    end =time.clock()

    print 'used:', end - start

 

timeit(foo)

看起来逻辑上并没有问题,一切都很美好并且运作正常!……等等,我们似乎修改了调用部分的代码。原本我们是这样调用的:foo(),修改以后变成了:timeit(foo)。这样的话,如果foo在N处都被调用了,你就不得不去修改这N处的代码。或者更极端的,考虑其中某处调用的代码无法修改这个情况,比如:这个函数是你交给别人使用的。

1.3. 最大限度地少改动!

既然如此,我们就来想想办法不修改调用的代码;如果不修改调用代码,也就意味着调用foo()需要产生调用timeit(foo)的效果。我们可以想到将timeit赋值给foo,但是timeit似乎带有一个参数……想办法把参数统一吧!如果timeit(foo)不是直接产生调用效果,而是返回一个与foo参数列表一致的函数的话……就很好办了,将timeit(foo)的返回值赋值给foo,然后,调用foo()的代码完全不用修改!

#-*- coding: UTF-8 -*-

import time

 

def foo():

    print 'in foo()'

 

# 定义一个计时器,传入一个,并返回另一个附加了计时功能的方法

def timeit(func):

     

    # 定义一个内嵌的包装函数,给传入的函数加上计时功能的包装

    def wrapper():

        start = time.clock()

        func()

        end =time.clock()

        print 'used:', end - start

     

    # 将包装后的函数返回

    return wrapper

 

foo = timeit(foo)

foo()

这样,一个简易的计时器就做好了!我们只需要在定义foo以后调用foo之前,加上foo = timeit(foo),就可以达到计时的目的,这也就是装饰器的概念,看起来像是foo被timeit装饰了。在在这个例子中,函数进入和退出时需要计时,这被称为一个横切面(Aspect),这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。与传统编程习惯的从上往下执行方式相比较而言,像是在函数执行的流程中横向地插入了一段逻辑。在特定的业务领域里,能减少大量重复代码。面向切面编程还有相当多的术语,这里就不多做介绍,感兴趣的话可以去找找相关的资料。

这个例子仅用于演示,并没有考虑foo带有参数和有返回值的情况,完善它的重任就交给你了 :)

2. Python的额外支持

2.1. 语法糖

上面这段代码看起来似乎已经不能再精简了,Python于是提供了一个语法糖来降低字符输入量。

import time

 

def timeit(func):

    def wrapper():

        start = time.clock()

        func()

        end =time.clock()

        print 'used:', end - start

    return wrapper

 

@timeit

def foo():

    print 'in foo()'

 

foo()

重点关注第11行的@timeit,在定义上加上这一行与另外写foo = timeit(foo)完全等价,千万不要以为@有另外的魔力。除了字符输入少了一些,还有一个额外的好处:这样看上去更有装饰器的感觉。

2.2. 内置的装饰器

内置的装饰器有三个,分别是staticmethod、classmethod和property,作用分别是把类中定义的实例方法变成静态方法、类方法和类属性。由于模块里可以定义函数,所以静态方法和类方法的用处并不是太多,除非你想要完全的面向对象编程。而属性也不是不可或缺的,Java没有属性也一样活得很滋润。从我个人的Python经验来看,我没有使用过property,使用staticmethod和classmethod的频率也非常低。

class Rabbit(object):

     

    def __init__(self, name):

        self._name = name

     

    @staticmethod

    def newRabbit(name):

        return Rabbit(name)

     

    @classmethod

    def newRabbit2(cls):

        return Rabbit('')

     

    @property

    def name(self):

        return self._name

这里定义的属性是一个只读属性,如果需要可写,则需要再定义一个setter:

@name.setter

def name(self, name):

    self._name = name

2.3. functools模块

functools模块提供了两个装饰器。这个模块是Python 2.5后新增的,一般来说大家用的应该都高于这个版本。但我平时的工作环境是2.4 T-T

2.3.1. wraps(wrapped[, assigned][, updated]):

这是一个很有用的装饰器。看过前一篇反射的朋友应该知道,函数是有几个特殊属性比如函数名,在被装饰后,上例中的函数名foo会变成包装函数的名字wrapper,如果你希望使用反射,可能会导致意外的结果。这个装饰器可以解决这个问题,它能将装饰过的函数的特殊属性保留。

import time

import functools

 

def timeit(func):

    @functools.wraps(func)

    def wrapper():

        start = time.clock()

        func()

        end =time.clock()

        print 'used:', end - start

    return wrapper

 

@timeit

def foo():

    print 'in foo()'

 

foo()

print foo.__name__

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

2.3.2. total_ordering(cls):

这个装饰器在特定的场合有一定用处,但是它是在Python 2.7后新增的。它的作用是为实现了至少__lt__、__le__、__gt__、__ge__其中一个的类加上其他的比较方法,这是一个类装饰器。如果觉得不好理解,不妨仔细看看这个装饰器的源代码:

def total_ordering(cls):

      """Class decorator that fills in missing ordering methods"""

      convert = {

          '__lt__': [('__gt__', lambda self, other: other < self),

                     ('__le__', lambda self, other: not other < self),

                     ('__ge__', lambda self, other: not self < other)],

          '__le__': [('__ge__', lambda self, other: other <= self),

                     ('__lt__', lambda self, other: not other <= self),

                     ('__gt__', lambda self, other: not self <= other)],

          '__gt__': [('__lt__', lambda self, other: other > self),

                     ('__ge__', lambda self, other: not other > self),

                     ('__le__', lambda self, other: not self > other)],

          '__ge__': [('__le__', lambda self, other: other >= self),

                     ('__gt__', lambda self, other: not other >= self),

                     ('__lt__', lambda self, other: not self >= other)]

      }

      roots = set(dir(cls)) & set(convert)

      if not roots:

          raise ValueError('must define at least one ordering operation: < > <= >=')

      root = max(roots)       # prefer __lt__ to __le__ to __gt__ to __ge__

      for opname, opfunc in convert[root]:

          if opname not in roots:

              opfunc.__name__ = opname

              opfunc.__doc__ = getattr(int, opname).__doc__

              setattr(cls, opname, opfunc)

      return cls

本文到这里就全部结束了,有空的话我会整理一个用于检查参数类型的装饰器的源代码放上来,算是一个应用吧 :)

Python 相关文章推荐
使用cx_freeze把python打包exe示例
Jan 24 Python
python中stdout输出不缓存的设置方法
May 29 Python
python 计算两个日期相差多少个月实例代码
May 24 Python
使用Python实现博客上进行自动翻页
Aug 23 Python
利用selenium 3.7和python3添加cookie模拟登陆的实现
Nov 20 Python
详解Django中间件的5种自定义方法
Jul 26 Python
Python wxpython模块响应鼠标拖动事件操作示例
Aug 23 Python
详解Python使用Plotly绘图工具,绘制甘特图
Apr 02 Python
Django框架基础模板标签与filter使用方法详解
Jul 23 Python
Pytorch转tflite方式
May 25 Python
浅谈Python爬虫原理与数据抓取
Jul 21 Python
appium+python自动化配置(adk、jdk、node.js)
Nov 17 Python
Python安装第三方库的3种方法
Jun 21 #Python
Python实现线程池代码分享
Jun 21 #Python
Python os模块学习笔记
Jun 21 #Python
Pthon批量处理将pdb文件生成dssp文件
Jun 21 #Python
Python实现删除文件但保留指定文件
Jun 21 #Python
Python ValueError: invalid literal for int() with base 10 实用解决方法
Jun 21 #Python
让Python代码更快运行的5种方法
Jun 21 #Python
You might like
php中一个有意思的日期逻辑处理
2012/03/25 PHP
php文件读取方法实例分析
2015/06/20 PHP
Codeigniter中集成smarty和adodb的方法
2016/03/04 PHP
php中替换字符串函数strtr()和str_repalce()的用法与区别
2016/11/25 PHP
jQuery 渐变下拉菜单
2009/12/15 Javascript
基于JQuery的一个简单的鼠标跟随提示效果
2010/09/23 Javascript
你必须知道的Javascript知识点之&quot;深入理解作用域链&quot;的介绍
2013/04/23 Javascript
jQuery实现页面内锚点平滑跳转特效的方法总结
2015/05/11 Javascript
JS实现模拟风力的雪花飘落效果
2015/05/13 Javascript
详解Js模板引擎(TrimPath)
2016/11/22 Javascript
火狐和ie下获取javascript 获取event的方法(推荐)
2016/11/26 Javascript
关于Function中的bind()示例详解
2016/12/02 Javascript
JS实现给对象动态添加属性的方法
2017/01/05 Javascript
JS实现根据密码长度显示安全条功能
2017/03/08 Javascript
详解一些适用于Node.js的命名约定
2019/12/08 Javascript
浅谈VUE中演示v-for为什么要加key
2020/01/16 Javascript
webpack.DefinePlugin与cross-env区别详解
2020/02/23 Javascript
Vue + Element-ui的下拉框el-select获取额外参数详解
2020/08/14 Javascript
详解vue修改elementUI的分页组件视图没更新问题
2020/11/13 Javascript
python判断给定的字符串是否是有效日期的方法
2015/05/13 Python
举例讲解Python中的死锁、可重入锁和互斥锁
2015/11/05 Python
python实现爬虫统计学校BBS男女比例之数据处理(三)
2015/12/31 Python
解决Python下json.loads()中文字符出错的问题
2018/12/19 Python
Python 调用PIL库失败的解决方法
2019/01/08 Python
python+selenium实现QQ邮箱自动发送功能
2019/01/23 Python
Python使用ctypes调用C/C++的方法
2019/01/29 Python
Python实现定制自动化业务流量报表周报功能【XlsxWriter模块】
2019/03/11 Python
飞利浦比利时官方网站:Philips比利时
2016/08/24 全球购物
Clarks英国官方网站:全球领军鞋履品牌
2016/11/26 全球购物
联想澳大利亚官网:Lenovo Australia
2018/01/18 全球购物
英国经济型酒店品牌:Travelodge
2019/12/17 全球购物
WSDL的操作类型主要有几种
2013/07/19 面试题
新学期家长寄语
2014/01/19 职场文书
公司租房协议书
2014/10/14 职场文书
初中优秀学生评语
2014/12/29 职场文书
撤回我也能看到!教你用Python制作微信防撤回脚本
2021/06/11 Python