[Python知识库]装饰器详解

装饰器

1. 需求

需求：在func函数执行前输出before，执行后输出after。

def func():
    print("我是func函数")
    value = [11,22,33,44]
    return value

result = func()
print(result)

1.1 闭包实现

# ********闭包实现********
def func():
    print("我是func函数")
    value = [11, 22, 33, 44]
    return value

def outer(origin):
    def inner():
        print("before")
        res = origin()  # 调用原来的func函数
        print("after")
        return res
    return inner

func = outer(func)  # 接收到inner

result = func()   # 调用inner()
print(result)

输出：

before
我是func函数
after
[11, 22, 33, 44]

1.2 python特殊语法(装饰器)

"""
python 中支持特殊语法，在某个函数上方使用：

@函数名
def xxx():
	pass
	
python 内部会自动执行 函数名(xxx), 执行完之后，再将结果赋值给 xxx.
xxx = 函数名(xxx)
"""

闭包进阶实现：

# ********闭包进阶********
def outer(origin):
    def inner():
        print("before")
        res = origin()  # 调用原来的func函数
        print("after")
        return res
    return inner

@outer   # 内部执行func = outer(func)
def func():
    print("我是func函数")
    value = [11, 22, 33, 44]
    return value

result = func()
print(result)

2. 新需求

# 需求：在下面三个函数执行前后分别输出before和after

def func1():
    print("我是func1函数")
    value = [11, 22, 33, 44]
    return value

def func2():
    print("我是func2函数")
    value = [11, 22, 33, 44]
    return value

def func3():
    print("我是func3函数")
    value = [11, 22, 33, 44]
    return value

func1()
func2()
func3()

2.1 特殊语法实现

# ***********装饰器实现****************
def outer(origin):
    def inner():
        print("before")
        res = origin()  # 调用原来的func函数
        print("after")
        return res
    return inner

@outer
def func1():
    print("我是func1函数")
    value = [11, 22, 33, 44]
    return value

@outer
def func2():
    print("我是func2函数")
    value = [11, 22, 33, 44]
    return value

@outer
def func3():
    print("我是func3函数")
    value = [11, 22, 33, 44]
    return value

func1()
func2()
func3()

输出：

before
我是func1函数
after
before
我是func2函数
after
before
我是func3函数
after

2.2 函数有参数

# ***********函数有参数****************
def outer(origin):
    def inner(*args, **kwargs):
        print("before")
        res = origin(*args, **kwargs)  # 调用原来的func函数
        print("after")
        return res

    return inner

@outer
def func1(a1):
    print("我是func1函数")
    value = [11, 22, 33, 44]
    return value

@outer
def func2(a1, a2):
    print("我是func2函数")
    value = [11, 22, 33, 44]
    return value

@outer
def func3(a1):
    print("我是func3函数")
    value = [11, 22, 33, 44]
    return value

func1(1)
func2(11, 22)
func3(666)

3. 装饰器

3.1 装饰器

以上的特殊语法被称为**装饰器**:

• 实现原理：基于@语法和函数闭包实现，将原函数封装在闭包中，然后将函数赋值为一个新的函数(内层函数)，执行函数时再在内层函数中执行闭包中的原函数；

• 实现效果：可以在不改变原函数内部代码 和 调用方式的前提下，给函数添加新功能；

• 使用场景：多个函数系统统一在 执行前后自定义一些功能。

• 装饰器示例：

  def outer(origin):
      def inner(*args, **kwargs):
          # 执行前
          res = origin(*args, **kwargs)  # 调用原来的func函数
          # 执行后
          return res
      return inner
  
  @outer
  def func(a1):
      pass
  
  func()
  

3.2 扩展1：flask应用场景

from flask import Flask

app = Flask(__name__)

def auth(func):
    def inner(*args, **kwargs):
        # 判断用户是否已经登录，已登录继续往下走，未登录则返回登录页面
        res = func(*args, **kwargs)  # 执行原函数
        return res
    return inner

@auth
def index():
    return '首页'

@auth
def info():
    return '用户中心!'

@auth
def order():
    return '订单中心!'

def login():
    return '登录页面!'

app.add_url_rule('/index', view_func=index)
app.add_url_rule('/info', view_func=index)
app.add_url_rule('/order', view_func=index)
app.add_url_rule('/login', view_func=index)

app.run()

3.3 扩展2：functools

import  functools
def auth(func):
    @functools.wraps(func)
    def inner(*args, **kwargs):
        """I am inner"""
        res = func(*args, **kwargs)  # 执行原函数
        return res
    return inner

@auth
def admin():
    """这是admin函数"""
    pass

@auth
def index():
    """这是index函数"""
    pass

# # 未使用装饰器
# print(admin.__name__)   # admin
# print(admin.__doc__)    # 这是admin函数
# print(index.__name__)   # index
# print(index.__doc__)    # 这是index函数

# # 使用装饰器
# print(admin.__name__)   # inner
# print(admin.__doc__)    # I am inner
# print(index.__name__)   # inner
# print(index.__doc__)    # I am inner

# 内部函数inner使用functools后
print(admin.__name__)   # admin
print(admin.__doc__)    # 这是admin函数
print(index.__name__)   # index
print(index.__doc__)    # 这是index函数