最近有个以前培训班的学员问我 Python 有没有类似与 Java 动态代理的机制?他想通过类似 Java 动态代理的机制对类的所有方法调用日志功能。查了一下,虽然 Python 官方没有提供这个功能,但是作为一门提供了反射机制的动态语言,我们妥妥的可以自己撸一个啊。
如果再阅读本文有什么不清楚的地方,建议先阅读廖雪峰老师教程的以下章节:
- 函数:函数的参数(主要看可变参数)
- 函数式编程:装饰器
- 面向对象编程
首先我们复习一下装饰器的实现,装饰器本质是一个高阶函数,通过封装对原油函数的调用,增强了原有函数的功能。
def log(func): def wrapper(*args, **kws): print('Call %s' % func.__name__) ret = func(*args, **kws) print('Finish call %s' % func.__name__) return ret return wrapper@logdef add(x, y): return x + yz = add(1, 2)print(z)'''输出如下:Call addFinish call add3'''
以上例子我们是通过装饰器增强了一个函数,那么如何通过装饰器增强一个类的所有方法呢?在展开具体实现之前,我们先介绍一下以下两个知识点:
- ()方法,如果你曾经接触过 C++的仿函数概念,那么对重载()操作符不陌生。Python 提供了call方法实现这个功能。
class Sample: def __init__(self, x, y): self.x = x self.y = y def __call__(self): return self.x + self.ys = Sample(100, 200)print(s())'''输出如下:300'''
- 当我对原来的类进行了封装之后,如何拦截对原有类的属性访问和方法调用?
- 不管是 s.xxx 访问属性,还是 s.yyy()调用方法,都必须先通过getattr检查 xxx 属性或 yyy 方法是否存在。
- 重新实现getattr方法即可拦截访问。
class Wrapper: def __init__(self, obj): self.obj = obj def __getattr__(self, attr): ret = None # 可以找不到返回 None,也可以抛出异常。 if hasattr(self.obj, attr): ret = getattr(self.obj, attr) return retclass Sample: def __init__(self, x, y): self.x = x self.y = y def add(self): return self.x + self.y def minus(self): return self.x - self.yw = Wrapper(Sample(100, 200))print(w.x)print(w.y)print(w.add())print(w.minus())'''输出如下:100200300-100'''
上面准备知识介绍完毕,下面我们就要展开具体实现了。
- 实现一个类用于对方法进行增强,这个类有两个参数,分别是方法属于的对象(这个实际根据需要可选)和要增强的方法。
class LogProxy: def __init__(self, obj, method): self.obj = obj self.method = method def __call__(self, *args, **kws): print('Log: ' + str(self.obj) + ' call ' + self.method.__name__) ret = self.method(*args, **kws) print('Log: ' + str(self.obj) + ' call ' + self.method.__name__ + ' finished')
- 我们必须有一个类,封装原有的对象,同时在调用原有对象方法的时候,动态生成上面的代理类用于实现功能增强。同时为了效率,还必须缓存已经创建的代理类。
import typesclass Proxy: def __init__(self, clz, pclz): self.clz = clz self.pclz = pclz self.proxies = {} # 查表提高效率 def __call__(self, *args, **kws): self.obj = self.clz(*args, **kws) # 调用被代理类的构造函数创建实例 return self def __getattr__(self, attr): # 调用方法之前需要通过 getattr 查找方法 ret = None if hasattr(self.obj, attr): # 查看被代理实例成员是否存在 ret = getattr(self.obj, attr) if isinstance(ret, types.MethodType): # 如果该成员是方法 if ret not in self.proxies: # 如果该方法的代理没有被生成 self.proxies[ret] = self.pclz(self.obj, ret) # 创建该方法的代理 return self.proxies[ret] return ret
- 实现一个工厂类,用于创造一个 Proxy 对象进行代理。同时这个类用作装饰器,套在要代理的类外面。
class ProxyFactory: def __init__(self, pclz): self.pclz = pclz def __call__(self, clz): return Proxy(clz, self.pclz)
- 最后,整合以上代码实现一个小例子:
@ProxyFactory(LogProxy)class Sample: def __init__(self, name): self.name = name def print_name(self): print(self.name)if __name__ == '__main__': s = Sample('xxx') s.print_name() print('s.name: %s' % s.name)'''输出如下:Log: call print_namexxxLog: call print_name finisheds.name: xxx'''
现在我们来解释一下代码的执行顺序,之后可以自己加日志跟踪一下代码是如何执行的。
- 构造 Sample 对象的顺序:
- ProxyFactory 调用构造函数构造对象 pf,参数为 LogProxy 类(参数是类,不是实例!)。
- pf 调用call方法,参数为 Sample 类,返回一个 Proxy 对象 proxy。
- proxy 调用call方法,拦截了原有的构造函数调用,在内部构造了 Sample 对象 sample。
- 访问属性(对应代码:s.name)
- 调用 proxy 对象的getattr方法
- 访问内部的 sample 对象(self.obj),检查 attr 是否存在。
- 不存在,返回 None,也可以抛出异常。根据实际情况可以选择不同的实现方式。
- 如果存在,且类型不是方法 types.MethodType,则直接返回属性值。
- 调用方法(对应代码:s.print_name())
- 与访问属性的步骤一样,直到最后一步,判断类型必须是方法。
- 检查缓存,是否已构造该方法的代理对象。如果有,直接返回,如果没有,构造,然后放入缓存再返回。
- 返回后调用代理对象的call方法,调用增强后的方法。
阅读全文: http://gitbook.cn/gitchat/activity/5eccda08b6eec620574ac251
您还可以下载 CSDN 旗下精品原创内容社区 GitChat App ,阅读更多 GitChat 专享技术内容哦。