python学习之修饰器

装饰器的使用场景

装饰器通常用于在不改变原有函数代码和功能的情况下，为其添加额外的功能。比如在原函数执行前先执行点什么，在执行后执行点什么。
让我们通过一个例子来看看，装饰器的使用场景和体现的设计模式。（抱歉的是我设计不出更好的场景，只能引用武大神的案例加以演绎）
有一个大公司，下属的基础平台部负责内部应用程序及API的开发，有上百个业务部门负责不同的业务，他们各自调用基础平台部提供的不同函数处理自己的业务，情况如下：

# 基础平台部门开发了上百个函数
def f1():
	print("业务部门1数据接口......")
def f2():
 	print("业务部门2数据接口......")
def f3():
 	print("业务部门3数据接口......")
def f100():
 	print("业务部门100数据接口......") 
#各部门分别调用
f1()
f2()
f3()
f100()

由于公司在创业初期，基础平台部开发这些函数时，由于各种原因，比如时间，比如考虑不周等等，没有为函数调用进行安全认证。现在，平台部主管决定弥补这个缺陷，于是：

第一回，主管叫来了一个运维工程师，工程师跑上跑下逐个部门进行通知，让他们在代码里加上认证功能，然而，当天他被开除了。

第二回：主管又叫来了一个运维工程师，工程师用shell写了个复杂的脚本，勉强实现了功能。但他很快就回去接着做运维了，不会开发的运维不是好运维…

第三回：主管叫来了一个python自动化开发工程师，哥们是这么干的：只对基础平台的代码进行重构，让N个业务部门无需做任何修改。这哥们很快也被开了，连运维也没得做。

def f1():
 #加入认证程序代码
 	print("业务部门1数据接口......")
def f2():
 # 加入认证程序代码
 	print("业务部门2数据接口......")
def f3():
# 加入认证程序代码
	print("业务部门3数据接口......")
def f100():
 #加入认证程序代码
	print("业务部门100数据接口......")
#各部门分别调用
f1()
f2()
f3()
f100()

第四回：主管又换了个 工程师，他是这么干的：定义个认证函数，原来其他的函数调用它，代码如下框。但是，主管依然不满意，不过这一次他解释了为什么。主管说：写代码要遵循开放封闭原则，虽然在这个原则主要是针对面向对象开发，但是也适用于函数式编程，简单来说，它规定已经实现的功能代码内部不允许被修改，但外部可以被扩展，即：封闭：已实现的功能代码块；开放：对扩展开放。如果将开放封闭原则应用在上述需求中，那么就不允许在函数 f1 、f2、f3…f100的内部进行代码修改。遗憾的是，工程师没有漂亮的女朋友，所以很快也被开除了。

def login():
 	print("认证成功！")
def f1():
 	login()
 	print("业务部门1数据接口......")
def f2():
 	login()
 	print("业务部门2数据接口......")
def f3():
 	login()
 	print("业务部门3数据接口......")
def f100():
 	login()
 	print("业务部门100数据接口......")
#各部门分别调用
f1()
f2()
f3()
f100()

第五回：已经没有时间让主管找别人来干这活了，他决定亲自上阵，并且打算在函数执行后再增加个日志功能。主管是这么想的：不会装饰器的主管不是好码农！要不为啥我能当主管，你只能被管呢？嘿嘿。他的代码如下：

def outer(func):
	def inner():
		print("认证成功！")
		result = func()
		print("日志添加成功")
 		return result
 	return inner
 	
@outer
def f1():
 	print("业务部门1数据接口......")
@outer
def f2():
 	print("业务部门2数据接口......")
@outer
def f3():
 	print("业务部门3数据接口......")
@outer
def f100():
 	print("业务部门100数据接口......")
#各部门分别调用
f1()
f2()
f3()
f100()

对于上述代码，也是仅需对基础平台的代码进行拓展，就可以实现在其他部门调用函数 f1 f2 f3 f100 之前都进行认证操作，在操作结束后保存日志，并且其他业务部门无需他们自己的代码做任何修改，调用方式也不用变。“主管”写完代码后，觉得独乐了不如众乐乐，打算显摆一下，于是写了篇博客将过程进行了详细的说明。

装饰器的内部原理

下面我们以f1函数为例进行说明：

def outer(func):
	def inner():
		print("认证成功！")
		result = func()
		print("日志添加成功")
		return result
	return inner
	
@outer
def f1():
	print("业务部门1数据接口......")

运用我们在第一部分介绍的知识来分析一下上面这段代码：

• 程序开始运行，从上往下编译，读到def outer(func):的时候，发现这是个“一等公民”->函数，于是把函数体加载到内存里，然后过。
• 读到@outer的时候，程序被@这个语法糖吸引住了，知道这是个装饰器，按规矩要立即执行的，于是程序开始运行@后面那个名字outer所定义的函数。（相信没有人会愚蠢的将@outer写到别的位置，它只能放在被装饰的函数的上方最近处，不要空行。）
• 程序返回到outer函数，开始执行装饰器的语法规则，这部分规则是定死的，是python的“法律”，不要问为什么。规则是：被装饰的函数的名字会被当作参数传递给装饰函数。装饰函数执行它自己内部的代码后，会将它的返回值赋值给被装饰的函数。

上面的过程可以用下面的公式等式表示

f1 = outer(f1)

这里面需要注意的是：

• @outer和@outer()有区别，没有括号时，outer函数依然会被执行，这和传统的用括号才能调用函数不同，需要特别注意！那么有括号呢？那是装饰器的高级用法了，以后会介绍。
• 是f1这个函数名（而不是f1()这样被调用后）当做参数传递给装饰函数outer，也就是：func = f1，@outer等于outer(f1),实际上传递了f1的函数体，而不是执行f1后的返回值。
• outer函数return的是inner这个函数名，而不是inner()这样被调用后的返回值。
  如果你对第一部分函数的基础知识有清晰的了解，那么上面的内容你应该很容易理解。

1. 程序开始执行outer函数内部的内容，一开始它又碰到了一个函数，很绕是吧？当然，你可以在 inner函数前后安排点别的代码，但它们不是重点，而且有点小麻烦，下面会解释。inner函数定义块被程序观察到后不会立刻执行，而是读入内存中（这是潜规则）。

2. 再往下，碰到return inner，返回值是个函数名，并且这个函数名会被赋值给f1这个被装饰的函数，也就是f1 = inner。根据前面的知识，我们知道，此时f1函数被新的函数inner覆盖了（实际上是f1这个函数名更改成指向inner这个函数名指向的函数体内存地址，f1不再指向它原来的函数体的内存地址），再往后调用f1的时候将执行inner函数内的代码，而不是先前的函数体。那么先前的函数体去哪了？还记得我们将f1当做参数传递给func这个形参么？func这个变量保存了老的函数在内存中的地址，通过它就可以执行 老的函数体，你能在inner函数里看到result = func（）这句代码，它就是这么干的！

3.接下来，还没有结束。当业务部门，依然通过f1()的方式调用f1函数时，执行的就不再是老的f1函数的代码，而是inner函数的代码。在本例中，它首先会打印个“认证成功”的提示，很显然你可以换成任意的代码，这只是个示例；然后，它会执行func函数并将返回值赋值个变量result，这个func函数就是老的f1函数；接着，它又打印了“日志保存”的提示，这也只是个示例，可以换成任何你想要的；最后返回result这个变量。我们在业务部门的代码上可以用 r = f1()的方式接受result的值。

4.以上流程走完后，你应该看出来了，在没有对业务部门的代码和接口调用方式做任何修改的同时，也没有对基础平台部原有的代码做内部修改，仅仅是添加了一个装饰函数，就实现了我们的需求，在函数调用前先认证，调用后写入日志。这就是装饰器的最大作用。

问题：那么为什么我们要搞一个outer函数一个inner函数这么复杂呢？一层函数不行吗？

答：请注意，@outer这句代码在程序执行到这里的时候就会自动执行outer函数内部的代码，如果不封装一下，在业务部门还未进行调用的时候，就执行了些什么，这和初衷有点不符。当然，如果你对这个有需求也不是不行。请看下面的例子，它只有一层函数。

装饰器的参数传递

细心的朋友可能已经发现了，上面的例子中，f1函数没有参数，在实际情况中肯定会需要参数的，那参数怎么传递的呢？

def outer(func):
	def inner(username):
 		print("认证成功！")
 		result = func(username)
 		print("日志添加成功")
 		return result
 	return inner
@outer
def f1(name):
	print("%s 正在连接业务部门1数据接口......"%name)
# 调用方法
f1("jack")

在inner函数的定义部分也加上一个参数，调用func函数的时候传递这个参数，很好理解吧？可问题又来了，那么另外一个部门调用的f2有2个参数呢？f3有3个参数呢？你怎么传递？

很简单，我们有*args和**kwargs嘛！号称“万能参数”！简单修改一下上面的代码：

def outer(func):
	def inner(*args,**kwargs):
 		print("认证成功！")
 		result = func(*args,**kwargs)
 		print("日志添加成功")
 		return result
 	return inner
@outer
def f1(name,age):
 	print("%s 正在连接业务部门1数据接口......"%name)
# 调用方法
f1("jack",18)

更进一步的思考

一个函数可以被多个函数装饰吗？可以的！看下面的例子！

def outer1(func):
 	def inner(*args,**kwargs):
 		print("认证成功！")
 		result = func(*args,**kwargs)
		print("日志添加成功")
 		return result
 	return inner
def outer2(func):
 	def inner(*args,**kwargs):
 		print("一条欢迎信息。。。")
 		result = func(*args,**kwargs)
 		print("一条欢送信息。。。")
 		return result
 	return inner
@outer1
@outer2
def f1(name,age):
 print("%s 正在连接业务部门1数据接口......"%name)
# 调用方法
f1("jack",18) 

更进一步的，装饰器自己可以有参数吗？可以的！看下面的例子

# 认证函数
def auth(request, kargs):
    print("认证成功！")


# 日志函数
def log(request, kargs):
    print("日志添加成功")


# 装饰器函数。接收两个参数，这两个参数应该是某个函数的名字。
def Filter(auth_func, log_func):
    # 第一层封装，f1函数实际上被传递给了main_fuc这个参数
    def outer(main_func):

    # 第二层封装，auth和log函数的参数值被传递到了这里
    def wrapper(request, kargs):

    # 下面代码的判断逻辑不重要，重要的是参数的引用和返回值
        before_result = auth(request, kargs)
        if (before_result != None):
            return before_result;
        main_result = main_func(request, kargs)
        if (main_result != None):
            return main_result;
        after_result = log(request, kargs)
        if (after_result != None):
            return after_result;
        return wrapper
    return outer


# 注意了，这里的装饰器函数有参数哦，它的意思是先执行filter函数
# 然后将filter函数的返回值作为装饰器函数的名字返回到这里，所以，
# 其实这里，Filter(auth,log) = outer , @Filter(auth,log) = @outer
@Filter(auth, log)
def f1(name, age):
    print("%s 正在连接业务部门1数据接口......" % name)


# 调用方法
f1("jack", 18)