装饰器(1)

一 装饰器介绍

1.1 为何要用装饰器

软件的设计应该遵循开放封闭原则，即对扩展是开放的，而对修改是封闭的。对扩展开放，意味着有新的需求或变化时，可以对现有代码进行扩展，以适应新的情况。对修改封闭，意味着对象一旦设计完成，就可以独立完成其工作，而不要对其进行修改。

软件包含的所有功能的源代码以及调用方式，都应该避免修改，否则一旦改错，则极有可能产生连锁反应，最终导致程序崩溃，而对于上线后的软件，新需求或者变化又层出不穷，我们必须为程序提供扩展的可能性，这就用到了装饰器。

1.2 什么是装饰器 

‘装饰’：代指为被装饰对象添加新的功能

‘器’：代指器具/工具

装饰器与被装饰的对象均可以是任意可调用对象。概括地讲，装饰器的作用就是在不修改被装饰对象源代码和调用方式的前提下为被装饰对象添加额外的功能。装饰器经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等应用场景，装饰器是解决这类问题的绝佳设计，有了装饰器，就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。

提示：可调用对象有函数，方法或者类，此处我们单以本章主题函数为例，来介绍函数装饰器，并且被装饰的对象也是函数。

 

二 装饰器的实现

函数装饰器分为无参装饰器和有参装饰两种，二者的实现原理一样，都是’函数嵌套+闭包+函数对象’的组合使用的产物。

2.1 无参装饰器的实现

装饰器的简易版本

import time


def index():
    time.sleep(3)
    print('from index')


def home():
    time.sleep(1)
    print('from home')


def outer(func):
    # func:index
    # func = home
    def get_time():
        # func:index
        start_time = time.time()
        # index() # 只能够统计index函数的时间
        # func()---->index()
        func()  # 只能够统计index函数的时间
        end_time = time.time()
        print('执行时间：%s' % (end_time - start_time))

    return get_time


get_time(index()) # get_time(None)
get_time(index) #

index = outer(index)  # res:get_time的函数名(其实也是get_time的内存地址)
index()  # get_time()

res = outer(home)
res()

 

装饰器进阶版本（解决参数问题、解决返回值问题）

import time


def index():
    time.sleep(3)
    print('from index')


def home(name):
    time.sleep(1)
    print('from home:', name)


def outer(func):
    # func:index
    # func = home
    def get_time(*args, **kwargs):
        # func:index
        start_time = time.time()
        # index() # 只能够统计index函数的时间
        # func()---->index()
        # func:home
        func(*args, **kwargs)  # 只能够统计index函数的时间
        end_time = time.time()
        print('执行时间：%s' % (end_time - start_time))

    return get_time


# get_time(index()) # get_time(None)
# get_time(index) #

index = outer(index)  # res:get_time的函数名(其实也是get_time的内存地址)
index('aaa')  # get_time()

home = outer(home)
home('jerry')  # get_time('jerry')

'''
我们现在统计的函数有时候需要参数，有时候不需要参数，所以，参数到底应该传还是不传？
    我们确定不了什么时候传，或者是传几个?
        如何将解决?
            *args和**kwargs
            
'''

解决返回值问题

def outer(func):
    # func:index
    # func = home
    def get_time(*args, **kwargs):
        # func:index
        start_time = time.time()
        # index() # 只能够统计index函数的时间
        # func()---->index()
        # func:home
        res=func(*args, **kwargs)  # 只能够统计index函数的时间
        end_time = time.time()
        print('执行时间：%s' % (end_time - start_time))
        # return res # 其实返回的是上面index的返回值
        return res
    return get_time

home = outer(home)
res=home('jerry')  # get_time('jerry')
print(res)

 

认证登录功能的装饰器

# 必须登录之后才能够访问函数
def index():
    print('from index')


def home():
    print('from home')

def home1():
    print('from home1')

# index()
# 用户必须是登录之后才能访问，否则不让访问

is_login={'is_login':False}

# 1. 写一个登录程序
def outer(func):
    # func = index
    def auth():
        if is_login.get('is_login'):
            ## 如果条件成立，直接执行函数
            res=func()
            return res # 解决返回值问题的

        username = input('username:>>>').strip()
        password = input('password:>>>').strip()

        # 2. 比较用户名和密码
        if username == 'jerry' and password == '123':
            # 执行函数
            print('登录成功')
            func()
            is_login['is_login'] = True #
        else:
            print('用户名或者密码错误')
    return auth

# auth(index)
# auth(home)

index=outer(index)
index()

home=outer(home)
home()

home1=outer(home1)
home1()

"""
我们现在需要做：只要登录成功一次，后续的函数就不用在登录了，直接可以访问
"""

语法糖

1. 语法糖的书写规范：
    @装饰器名字
    必须把上面的写在被装饰对象的头上(紧贴着被装饰对象写)
    
2. 语法糖的原理：
    它会把下面的被装饰对象的名字当成参数传递给装饰器

def outer(func):
    def inner(*args, **kwargs):
        print('函数被调用之前需要添加的功能')
        res=func(*args, **kwargs) # 真正的函数执行
        print('函数被调用之后需要添加的功能')
        return res

    return inner

def outer(func):
    def inner(*args, **kwargs):
        print('函数被调用之前需要添加的功能')
        res = func(*args, **kwargs)  # 真正的函数执行
        print('函数被调用之后需要添加的功能')
        return res

    return inner

# @outer # index = outer(index)
# def index():
#     print('from index')
#     return 'index'
# 
# 
# @outer # home=outer(home)
# def home():
#     print('from home')
# 
# # index = outer(index)
# 
# index()
# 
# home() # inner()

@outer # func=outer(func)
def func():
    print('from func')
    
func()