装饰器 decorator

Python 的 装饰器 ( decorator ) 是一个可以让程序码达到精简又漂亮的写法，用起来不但轻松简单，又可以提升程序码的可读性，这篇教学将会介绍 Python 的装饰器

快速导览：什么是装饰器、制作第一个装饰器、多个装饰器、单一参数处理、多个参数处理

本篇使用的 Python 版本为 3.7.12，所有范例可使用 Google Colab 实作，不用安装任何软件 ( 参考：使用 Google Colab )

什么是装饰器 decorator？

装饰器 decorator 是 Python 的一种程序设计模式，装饰器本质上是一个 Python 函数或类 ( class )，它可以让其他函数或类，在不需要做任何代码修改的前提下增加额外功能，装饰器的返回值也是一个函数或类对象， 有了装饰器，就可以抽离与函数功能本身无关的程序码，放到装饰器中并继续重复使用。

在 Python 中，使用“@”当做装饰器使用的语法糖符号 ( 语法糖指的是将复杂的程序码包装起来的糖衣，也就是简化写法 )。

制作第一个装饰器

下方的程序码，定义了一个装饰器函数 a 和一个被装饰的函数 b，当 b 函数执行后，会看见 a 运算后的结果，套用在 b 函数上。

简单来说，当某个函数加上装饰器后，执行该函数之前会先执行“装饰”的内容，就如同要从家里出门，必须先装饰身体 ( 化妆、衣服、裤子、鞋子...等 )，完成后就执行出门的动作。

def a(func):
    print('makeup...')
    return func

def b():
    print('go!!!!')

b = a(b)
b()

# makeup...
# go!!!!

在 Python 里，函数 function 可以当成参数传递并执行，所以上面的程序码将 b 传入 a 作为参数，所以执行 b 时效果等同于执行 a 里的 func，执行流程如下图所示。

接着使用语法糖“@”包装，就能达到简化的效果。

def a(func):
    print('makeup...')
    return func

# 裝飾器寫在 b 的前面，表示裝飾 b
@a
def b():
    print('go!!!!')

b()
# makeup...
# go!!!!

多个装饰器

如果有多个装饰器，执行的顺序将会“由下而上”触发 ( 函数一层层往上 )，下方的程序码，会先装饰 a3，接着装饰 a2，最后装饰 a1。

def a1(func):
    print('1')
    return func

def a2(func):
    print('2')
    return func

def a3(func):
    print('3')
    return func

@a1
@a2
@a3
def b():
    print('go!!!!')

b()
# 3
# 2
# 1
# go!!!!

单一参数处理

如果装饰器遇到带有参数的函数，同样能将参数一并带入处理，实作的方式如下方程序码，在装饰器函数 a 里，新增一个函数内的函数 c，并透过函数 c 来获取被装饰函数 b 的参数 msg。

def a(func):
    def c(m):             # 新增一個內部函式，待有一個參數
        print('makeup...')
        return func(m)      # 回傳 func(m)
    return c

@a
def b(msg):
    print(msg)

b('go!!!!')
# makeup...
# go!!!!

多个参数处理

如果遇到被装饰的函数有多个参数，可以使用 *args 和 **kwargs 运算子来取得所有的参数，下方的例子，b 函数传入的参数有串列以及带有关键字引数的参数，就能将这些参数传递给装饰器函数 a。

def a(func):
    def c(*args, **kwargs):
        print(args)
        print(kwargs)
        print('ok...')
        return func(*args, **kwargs)
    return c

@a
def b(*args, **kwargs):
    print('go!!!!')

b([123, 456], x=1, y=2, z=3)

# ([123, 456],)
# {'x': 1, 'y': 2, 'z': 3}
# ok...
# go!!!!

意见反馈