Python：函数式编程（四）：装饰器

梦里梦外; 2023-05-28 05:18 53阅读 0赞

上文讲到函数式编程的闭包，这一节讲一下闭包的一个应用，装饰器。

# 何为装饰器 #

> 装饰器本质上是一个 Python 函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外功能，装饰器的返回值也是一个函数对象。它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。

# 1. 问题引入： #

我们最简单的求和函数：

def add(x, y):
        print(x + y)
    
    
    add(1, 2)

这是需求有变化，需要告知求和函数执行状态。这简单嘛

def add(x, y):
        print('At the beginning of add')
        print(x + y)
        print('At the end of add')
    
    
    add(1, 2)

![在这里插入图片描述][20200327183626686.png]  
这个时候加功能模块了，我们要加上求差求积函数，并一样告知运行状态。简单嘛：复制粘贴微调不就完事儿了！

def add(x, y):
        print('At the beginning of add')
        print(x + y)
        print('At the end of add')
    
    
    def subtract(x, y):
        print('At the beginning of subtract')
        print(x - y)
        print('At the end of subtract')
    
    
    def multiply(x, y):
        print('At the beginning of multiply')
        print(x * y)
        print('At the end of multiply')
    
    
    add(1, 2)
    subtract(1, 2)
    multiply(1, 2)

结果如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNzU4OTU3NQ_size_16_color_FFFFFF_t_70]  
这个时候你的同事会尽情的嘲笑你，就这？然后他洋洋洒洒的写下了如下代码：

def log(func):
        def wrapper(*args, **kw):
            print('At the beginning of %s:' % func.__name__)
            func(*args, **kw)
            print('At the end of %s:' % func.__name__)
        return wrapper
    
    
    @log
    def add(x, y):
        print(x + y)
    
    
    @log
    def subtract(x, y):
        print(x - y)
    
    
    @log
    def multiply(x, y):
        print(x * y)
    
    
    add(1, 2)
    subtract(1, 2)
    multiply(1, 2)

结果如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNzU4OTU3NQ_size_16_color_FFFFFF_t_70 1]  
优雅的一，而且这种情况如果添加无数的运算，都只需要在前面 @log 就可以了，再来就是你如果不是打印 At the beginning 和 end，而是计算运行时间之类的，那就更加优雅了，你只需要改 log 函数的内容就可以了。这里的 log 函数就是我们的装饰器。

# 装饰器 #

装饰器的语法：

def log(func):
        def wrapper(*args, **kw):
            # Behavior begin run func
            func(*args, **kw)
            # Behavior begin run func
        return wrapper

我们的装饰器就是 log 函数，它接收一个函数 func 作为参数，然后里面嵌入一个函数 wrapper。在wrapper 里面我们可以在执行 func 之前定义某种行为，也可以在 func 之后定义某种行为，最后返回我们内嵌的函数。这里为了适应被装饰函数参数个数不一定一致且确定的时候，我们用的是可变长参数和关键词参数。

### 闭包 ###

闭包的体现就是内部函数 wrapper 使用了自由变量 func， 而且和一般的自由变量不同的就是这个变量是一个函数。最后外部装饰器函数 log 返回内部函数 wrapper。

### @ 语法糖 ###

我们要装饰一个函数第一种方法，就是使用上面的语法糖

def 装饰器函数
    @装饰器函数
    def 被装饰的函数

另一种等价的方法：

def 装饰器函数
    def 被装饰函数
    被装饰函数 = 装饰器函数（被装饰器函数）

两种方法效果上是等价的。只是注意第二种中的

被装饰函数 = 装饰器函数（被装饰函数）

其实这个时候我们的被装饰函数就是我们装饰器函数的内部函数，也就是前面例子的 wrapper 函数。

# 参数的装饰器 #

def log(para):
        def decorator(func):
            def wrapper(*args, **kw):
                print('At the beginning of %s:' % func.__name__)
                func(*args, **kw)
                print(para)
                print('At the end of %s:' % func.__name__)
            return wrapper
        return decorator
    
    
    @log('add_function')
    def add(x, y):
        print(x + y)
    
    
    @log('subtract_function')
    def subtract(x, y):
        print(x - y)
    
    
    @log('multiply_function')
    def multiply(x, y):
        print(x * y)
    
    
    add(1, 2)
    subtract(1, 2)
    multiply(1, 2)

结果如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNzU4OTU3NQ_size_16_color_FFFFFF_t_70 2]  
这个就相当于在我们原来不带参数的装饰器外面再加一层嵌套，并传入我们想要的参数，这个参数是装饰器函数的参数，而上面提到的可变长参数和关键词参数是被装饰函数的参数。

# 多个装饰器： #

def log1(func):
        def wrapper(*args, **kw):
            print('Beginning of Log 1')
            func(*args, **kw)
            print('End of Log 1')
        return wrapper
    
    
    def log2(func):
        def wrapper(*args, **kw):
            print('Beginning of Log 2')
            func(*args, **kw)
            print('End of Log 2')
        return wrapper
    
    
    @log1
    @log2
    def add(x, y):
        print(x + y)
    
    
    add(10, 5)

多个装饰器的运行结果如下：  
![在这里插入图片描述][20200327202154497.png]  
可以看到是按距离被装饰函数距离来定义的：先装饰距离近的，再装饰距离远的。

[20200327183626686.png]: /images/20230528/b9345abe6fca47ba9087f4c561c503d5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNzU4OTU3NQ_size_16_color_FFFFFF_t_70]: /images/20230528/30f5b2c41abf45c084d0e9317d207b6c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNzU4OTU3NQ_size_16_color_FFFFFF_t_70 1]: /images/20230528/1b8198cf5dad422f9e607a1f71429984.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNzU4OTU3NQ_size_16_color_FFFFFF_t_70 2]: /images/20230528/fa4e66d3568244f8adfb89c3e6ee6902.png
[20200327202154497.png]: /images/20230528/daf55335131f4b51b3359ebbc6a09f87.png