Python进阶之强大的装饰器 Decorators （一）

这篇文章主要介绍 decorator（装饰器），在开始介绍 decorator 前，要先有一个观念，就是在 python 中，函数是对象，可以将它们分配给变量和传递给其他函数并从其他函数返回，可以在其他函数中定义函数，并且子功能可以捕获父功能的本地状态。

demo1.py

def f1():
    print("f1")


def register(func):
    func()


register(f1)

装饰器就是站在这个基础上去延伸出来的。接著来说说什麽时候要用装饰器，装饰器最主要的目的是在不破坏 function（函数） 或 class（类） 的情况下，去扩充目标 function 或 class 的功能。例如，logging、计算 function or class 执行的时间、权限等等。

如果大家有兴趣，可以再去查查 AOP ( Aspect Oriented Programming )，中文翻成 面向切面。

有了这个装饰器，我们就可以将大量的程式码抽出来( 与函数本身无关的部分 )，将这些 code 写到装饰器中 ( 可以重复使用 )，程式码也不会变得很乱。

说穿了，就是在现在的功能上，可以加上额外的功能 ( 重点是不破坏原有的 code )。

举个例子，今天我想要记录 f1() 的 logging，我们可能这样写，

( 正常来说，应该要使用 logging 这个 module，但这边简单用 print 代替就好 ?)

def f1():
    print("f1")
    print("logging - f1 is running")

f1()

这样写看似没有问题，但如果你今天 f2() f3() f4() 都需要纪录呢 ❓

这样要每一个都写一样的 code ❓

我们能不能把它抽出来 ❓ 而这个东西，就是专门处理 logging 的，

答案当然是可以的?

def my_logging(func):
    print('logging - {} is running'.format(func.__name__))
    func()


def f1():
    print("f1")


my_logging(f1)

功能实现了，看似很美好，如果有其他的需要加上 logging，使用 my_logging(f2) 即可。但这方法其实有一些问题，问题点在每次都要呼叫 my_logging，而且也要将 f1 当成参数传递，比较好的方法应该是维持 f1 为主要业务逻辑，而不是像现在变成 my_logging 为主要业务逻辑，也就是说，现在的状况破坏了原有代码的结构。所以更好的方法，就是使用装饰器 ( 我们终于谈到主角了?)，来看一个简单的装饰器。

def my_logging(func):
    def wrapper():
        print('logging - {} is running'.format(func.__name__))
        func()  # run func()  Equivalent run f1()

    return wrapper


def f1():
    print("f1")


f1 = my_logging(f1)  # Equivalent -> f1 = wrapper
f1()  # Equivalent -> f1() = wrapper()

my_logging 就是一个装饰器，把真正的业务逻辑 func 包在里面，看起来就像是 func 被 my_logging 装饰了一样，所以顾名思义，称为装饰器。在这个范例中，函数的进入和退出时，都可以加上东西，这种方式也称为 AOP ( Aspect Oriented Programming )。接下来要来谈谈 @ 这个符号，你可以把他想成是一种语法的符号。

def my_logging(func):
    def wrapper():
        print('logging - {} is running'.format(func.__name__))
        func()  # run func()  Equivalent run f1()

    return wrapper


@my_logging
def f1():
    print("f1")


f1()

当有了 @ 这个语法的帮忙，就可以将 f1 = my_logging(f1) 省略，直接使用 f1() 即可。