Python @ 装饰器

原创

byamao1 2023-02-02 21:47:26 ©著作权

©著作权归作者所有：来自51CTO博客作者byamao1的原创作品，请联系作者获取转载授权，否则将追究法律责任

一、简单例子

先看下面一个简单的例子程序
t1清单

def funA(fn):
    print('A')
    fn()  # fn实际就是funB（函数对象）

@funA
def funB():
    print('B')

# if __name__ == "__main__":
#     funB()

运行结果：

A
B

（要注意 9、10行的代码被注释了，但是funA仍然被执行了）相当于funA(funB)
好了，如果要是把 9、10行的注释去掉，执行结果是：

Traceback (most recent call last):
File “F:/Projects/Python/jie/pyflow/src/t3.py”, line 10, in <module> funB()
TypeError: ‘NoneType’ object is not callable
A
B

报错了！通过断点发现这是执行顺序：

Python @ 装饰器_带参数

也就是说，执行到第10行时，funB是None。原因在于funA没有返回fn。我们返回fn试下：
t2清单

def funA(fn):
    print('A')
    fn()  # fn实际就是funB（函数对象）
    return fn

@funA
def funB():
    print('B')

if __name__ == "__main__":
     funB()

运行结果：

A
B
B

符合预期

二、@装饰器与AOP

我们知道装饰器是可以实现切面编程（AOP）。那么怎么才符合切面呢？
我们要注意不带参数的装饰器与带参数的装饰器的写法有一些差别。

2.1 不带参数的装饰器

t1清单改为下面（为更全面理解，这个funB有入参）：
t3清单

def funA(fn):
    print("This is funA")  # 这个区域是做与装饰器funA相关的逻辑
    def wrapped(*args):
        print("This is aspect")   # 切面逻辑
        return fn(*args)  # fn就是funB，args就是funB的入参。另外，别忘了return
    return wrapped

@funA
def funB(p):  # funB有入参
    print('B', p)
    return "ok"

if __name__ == "__main__":
    print("This is main")
    print(funB("Param"))

运行结果：

This is funA
This is main
This is aspect
B Param
ok

“This is aspect” 和 “B Param” 这两个结果就是第15行执行产生的（符合AOP预期）。与t1清单比起来，就是在funA中多定义了函数wrapped并返回。

2.2 带参数的装饰器

t4清单：

def funA(a):  # 装饰器funA的入参
    print("This is funA")  # 这个区域是做与装饰器funA相关的逻辑
    def deco_func(fn):
        print("This is deco_func")   # 这个区域是做与deco_func相关的逻辑
        def wrapped(*args):
            print("This is aspect")  # 切面逻辑
            return fn(*args)  # fn就是funB，args就是funB的入参。另外，别忘了return
        return wrapped
    return deco_func

@funA(3)
def funB(p):  # funB有入参
    print('B', p)
    return "ok"

if __name__ == "__main__":
    print("This is main")
    print(funB("Param"))

为反映与不带参数装饰器的写法区别，我们对比看看：

Python @ 装饰器_AOP_02